open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify HTTP client duration (#70)

This commit is contained in:
Trask Stalnaker 2023-06-09 10:37:38 -07:00 committed by GitHub
parent 412a3eff4e
commit 8fc3d034c7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -76,3 +76,5 @@ release.
attributes for GCP Compute Engine VMs. ([#15](https://github.com/open-telemetry/semantic-conventions/pull/15)) attributes for GCP Compute Engine VMs. ([#15](https://github.com/open-telemetry/semantic-conventions/pull/15))
- Add note that HTTP duration metrics should match HTTP span duration. - Add note that HTTP duration metrics should match HTTP span duration.
([#69](https://github.com/open-telemetry/semantic-conventions/pull/69)) ([#69](https://github.com/open-telemetry/semantic-conventions/pull/69))
- Clarify when HTTP client spans should end.
([#70](https://github.com/open-telemetry/semantic-conventions/pull/70))

17
specification/trace/semantic_conventions/http.md
View File

@ -15,6 +15,7 @@ and various HTTP versions like 1.1, 2 and SPDY.
- [Common Attributes](#common-attributes) - [Common Attributes](#common-attributes)
* [HTTP request and response headers](#http-request-and-response-headers) * [HTTP request and response headers](#http-request-and-response-headers)
- [HTTP client](#http-client) - [HTTP client](#http-client)
* [HTTP client span duration](#http-client-span-duration)
* [HTTP request retries and redirects](#http-request-retries-and-redirects) * [HTTP request retries and redirects](#http-request-retries-and-redirects)
- [HTTP server](#http-server) - [HTTP server](#http-server)
* [HTTP server definitions](#http-server-definitions) * [HTTP server definitions](#http-server-definitions)
@ -194,6 +195,22 @@ Following attributes MUST be provided **at span creation time** (when provided a
Note that in some cases host and port identifiers in the `Host` header might be different from the `server.address` and `server.port`, in this case instrumentation MAY populate `Host` header on `http.request.header.host` attribute even if it's not enabled by user. Note that in some cases host and port identifiers in the `Host` header might be different from the `server.address` and `server.port`, in this case instrumentation MAY populate `Host` header on `http.request.header.host` attribute even if it's not enabled by user.
### HTTP client span duration
There are some minimal constraints that SHOULD be honored:
* HTTP client spans SHOULD start sometime before the first request byte is sent. This may or may not include connection time.
* HTTP client spans SHOULD end sometime after the HTTP response headers are fully read (or when they fail to be read). This may or may not include reading the response body.
If there is any possibility for application code to not fully read the HTTP response
(and for the HTTP client library to then have to clean up the HTTP response asynchronously),
the HTTP client span SHOULD NOT be ended in this cleanup phase,
and instead SHOULD end at some point after the HTTP response headers are fully read (or fail to be read).
This avoids the span being ended asynchronously later on at a time
which is no longer directly associated with the application code which made the HTTP request.
Because of the potential for confusion around this, HTTP client library instrumentations SHOULD document their behavior around ending HTTP client spans.
### HTTP request retries and redirects ### HTTP request retries and redirects
Retries and redirects cause more than one physical HTTP request to be sent. Retries and redirects cause more than one physical HTTP request to be sent.