HttpExperimentalAttributes
Attributes
- Source
- HttpExperimentalAttributes.scala
- Graph
-
- Supertypes
- Self type
Members list
Type members
Classlikes
Values for HttpConnectionState.
Values for HttpConnectionState.
Attributes
- Companion
- object
- Source
- HttpExperimentalAttributes.scala
- Supertypes
- Known subtypes
Attributes
- Companion
- class
- Source
- HttpExperimentalAttributes.scala
- Supertypes
- Self type
Attributes
- Companion
- class
- Source
- HttpExperimentalAttributes.scala
- Supertypes
- Self type
-
HttpFlavorValue.type
Attributes
- Companion
- class
- Source
- HttpExperimentalAttributes.scala
- Supertypes
- Self type
Deprecated classlikes
Values for HttpFlavor.
Values for HttpFlavor.
Attributes
- Companion
- object
- Deprecated
- true
- Source
- HttpExperimentalAttributes.scala
- Supertypes
- Known subtypes
Values for HttpRequestMethod.
Values for HttpRequestMethod.
Attributes
- Companion
- object
- Deprecated
- true
- Source
- HttpExperimentalAttributes.scala
- Supertypes
- Known subtypes
Value members
Concrete fields
State of the HTTP connection in the HTTP connection pool.
State of the HTTP connection in the HTTP connection pool.
Attributes
The size of the request payload body in bytes.
The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the <a href="https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length">Content-Length header. For requests using transport encoding, this should be the compressed size.
Attributes
The total size of the request in bytes.
The total size of the request in bytes. This should be the total number of bytes sent over the wire, including the request line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and request body if any.
Attributes
The size of the response payload body in bytes.
The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the <a href="https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length">Content-Length header. For requests using transport encoding, this should be the compressed size.
Attributes
The total size of the response in bytes.
The total size of the response in bytes. This should be the total number of bytes sent over the wire, including the status line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and response body and trailers if any.
Attributes
Deprecated fields
Deprecated, use network.protocol.name
instead.
Deprecated, use network.protocol.name
instead.
Attributes
- Deprecated
- true
- Source
- HttpExperimentalAttributes.scala
Deprecated, use http.request.method
instead.
Deprecated, use http.request.method
instead.
Attributes
- Deprecated
- true
- Source
- HttpExperimentalAttributes.scala
Deprecated, use http.request.header.content-length
instead.
Deprecated, use http.request.header.content-length
instead.
Attributes
- Deprecated
- true
- Source
- HttpExperimentalAttributes.scala
HTTP request headers, <key>
being the normalized HTTP Header name (lowercase), the value being the header values.
HTTP request headers, <key>
being the normalized HTTP Header name (lowercase), the value being the header values.
Attributes
- Note
-
-
Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all request headers can be a security risk - explicit configuration helps avoid leaking sensitive information. The
User-Agent
header is already captured in theuser_agent.original
attribute. Users MAY explicitly configure instrumentations to capture them even though it is not recommended. The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers.
-
- Deprecated
- true
- Source
- HttpExperimentalAttributes.scala
HTTP request method.
HTTP request method.
Attributes
- Note
-
-
HTTP request method value SHOULD be "known" to the instrumentation. By default, this convention defines "known" methods as the ones listed in <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-methods">RFC9110 and the PATCH method defined in RFC5789.
-
If the HTTP request method is not known to instrumentation, it MUST set the
http.request.method
attribute to_OTHER
. -
If the HTTP instrumentation could end up converting valid HTTP request methods to
_OTHER
, then it MUST provide a way to override the list of known HTTP methods. If this override is done via environment variable, then the environment variable MUST be named OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods (this list MUST be a full override of the default known method, it is not a list of known methods in addition to the defaults). -
HTTP method names are case-sensitive and
http.request.method
attribute value MUST match a known HTTP method name exactly. Instrumentations for specific web frameworks that consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent. Tracing instrumentations that do so, MUST also sethttp.request.method_original
to the original value.
-
- Deprecated
- true
- Source
- HttpExperimentalAttributes.scala
Original HTTP method sent by the client in the request line.
Original HTTP method sent by the client in the request line.
Attributes
- Deprecated
- true
- Source
- HttpExperimentalAttributes.scala
The ordinal number of request resending attempt (for any reason, including redirects).
The ordinal number of request resending attempt (for any reason, including redirects).
Attributes
- Note
-
-
The resend count SHOULD be updated each time an HTTP request gets resent by the client, regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 Server Unavailable, network issues, or any other).
-
- Deprecated
- true
- Source
- HttpExperimentalAttributes.scala
Deprecated, use http.response.header.content-length
instead.
Deprecated, use http.response.header.content-length
instead.
Attributes
- Deprecated
- true
- Source
- HttpExperimentalAttributes.scala
HTTP response headers, <key>
being the normalized HTTP Header name (lowercase), the value being the header values.
HTTP response headers, <key>
being the normalized HTTP Header name (lowercase), the value being the header values.
Attributes
- Note
-
-
Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all response headers can be a security risk - explicit configuration helps avoid leaking sensitive information. Users MAY explicitly configure instrumentations to capture them even though it is not recommended. The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers.
-
- Deprecated
- true
- Source
- HttpExperimentalAttributes.scala
The matched route, that is, the path template in the format used by the respective server framework.
The matched route, that is, the path template in the format used by the respective server framework.
Attributes
- Note
-
-
MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it. SHOULD include the <a href="/docs/http/http-spans.md#http-server-definitions">application root if there is one.
-
- Deprecated
- true
- Source
- HttpExperimentalAttributes.scala
Deprecated, use url.scheme
instead.
Deprecated, use url.scheme
instead.
Attributes
- Deprecated
- true
- Source
- HttpExperimentalAttributes.scala
Deprecated, use http.response.status_code
instead.
Deprecated, use http.response.status_code
instead.
Attributes
- Deprecated
- true
- Source
- HttpExperimentalAttributes.scala
Deprecated, use url.path
and url.query
instead.
Deprecated, use url.path
and url.query
instead.
Attributes
- Deprecated
- true
- Source
- HttpExperimentalAttributes.scala
Deprecated, use url.full
instead.
Deprecated, use url.full
instead.
Attributes
- Deprecated
- true
- Source
- HttpExperimentalAttributes.scala
Deprecated, use user_agent.original
instead.
Deprecated, use user_agent.original
instead.
Attributes
- Deprecated
- true
- Source
- HttpExperimentalAttributes.scala