Skip to content

Commit 8099078

Browse files
committed
Addressing feedback
Rewording recommendation to use a more generic RPC Adding a small blurb clarifying sub operations can be instrumented.
1 parent 4dfa80d commit 8099078

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

specification/trace/api.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -227,17 +227,20 @@ hypothetical account information:
227227
The `Span`'s start and end timestamps reflect the elapsed real time of the
228228
operation.
229229

230-
For example, an http server span should start right when the request has begun being handled by the server, and end when the response has been completely sent.
231-
This would include the following, if they are present in that particular
232-
request-response cycle:
233-
234-
- receiving the HTTP request
235-
- parsing of the HTTP request
236-
- parsing of the body of the HTTP request
237-
- any web server middleware that is applied
230+
For example, If a span represents a request-response cycle (e.g. HTTP or an RPC),
231+
the span should have a start time that corresponds to the start time of the
232+
first sub operations, and an end time of when the final sub operation is complete.
233+
This includes:
234+
235+
- receiving the data from the request
236+
- parsing of the data (e.g. from a binary or json format)
237+
- any middleware or additional processing logic
238238
- business logic
239-
- construction of the HTTP response
240-
- sending of the HTTP response
239+
- construction of the response
240+
- sending of the response
241+
242+
Child spans may be created to represent any sub-operations, to provide more
243+
granular observability.
241244

242245
A `Span`'s start time SHOULD be set to the current time on [span
243246
creation](#span-creation). After the `Span` is created, it SHOULD be possible to

0 commit comments

Comments
 (0)