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 @code User-Agent @endcode header is already captured in the @code user_agent.original @endcode 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.
Examples:
HTTP request method value SHOULD be "known" to the instrumentation. By default, this convention defines "known" methods as the ones listed in RFC9110 and the PATCH method defined in RFC5789.
If the HTTP request method is not known to instrumentation, it MUST set the @code http.request.method @endcode attribute to @code _OTHER @endcode.
If the HTTP instrumentation could end up converting valid HTTP request methods to @code _OTHER @endcode, 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 @code http.request.method @endcode 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 set @code http.request.method_original @endcode to the original value. */ static constexpr const char *kHttpRequestMethod = "http.request.method"; /** Original HTTP method sent by the client in the request line. */ static constexpr const char *kHttpRequestMethodOriginal = "http.request.method_original"; /** The ordinal number of request resending attempt (for any reason, including redirects).
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).
*/
static constexpr const char *kHttpRequestResendCount = "http.request.resend_count";
/**
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.
*/
static constexpr const char *kHttpRequestSize = "http.request.size";
/**
Deprecated, use @code http.request.header.content-length @endcode instead.
@deprecated
{"note": "Replaced by @code http.request.header.content-length @endcode.", "reason":
"uncategorized"}
*/
OPENTELEMETRY_DEPRECATED static constexpr const char *kHttpRequestContentLength =
"http.request_content_length";
/**
Deprecated, use @code http.request.body.size @endcode instead.
@deprecated
{"note": "Replaced by @code http.request.body.size @endcode.", "reason": "renamed", "renamed_to":
"http.request.body.size"}
*/
OPENTELEMETRY_DEPRECATED static constexpr const char *kHttpRequestContentLengthUncompressed =
"http.request_content_length_uncompressed";
/**
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 Content-Length header.
For requests using transport encoding, this should be the compressed size.
*/
static constexpr const char *kHttpResponseBodySize = "http.response.body.size";
/**
HTTP response headers, @code 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. Examples: 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 application root if
there is one.
*/
static constexpr const char *kHttpRoute = "http.route";
/**
Deprecated, use @code url.scheme @endcode instead.
@deprecated
{"note": "Replaced by @code url.scheme @endcode.", "reason": "renamed", "renamed_to":
"url.scheme"}
*/
OPENTELEMETRY_DEPRECATED static constexpr const char *kHttpScheme = "http.scheme";
/**
Deprecated, use @code server.address @endcode instead.
@deprecated
{"note": "Replaced by @code server.address @endcode.", "reason": "renamed", "renamed_to":
"server.address"}
*/
OPENTELEMETRY_DEPRECATED static constexpr const char *kHttpServerName = "http.server_name";
/**
Deprecated, use @code http.response.status_code @endcode instead.
@deprecated
{"note": "Replaced by @code http.response.status_code @endcode.", "reason": "renamed",
"renamed_to": "http.response.status_code"}
*/
OPENTELEMETRY_DEPRECATED static constexpr const char *kHttpStatusCode = "http.status_code";
/**
Deprecated, use @code url.path @endcode and @code url.query @endcode instead.
@deprecated
{"note": "Split to @code url.path @endcode and @code url.query @endcode.", "reason": "obsoleted"}
*/
OPENTELEMETRY_DEPRECATED static constexpr const char *kHttpTarget = "http.target";
/**
Deprecated, use @code url.full @endcode instead.
@deprecated
{"note": "Replaced by @code url.full @endcode.", "reason": "renamed", "renamed_to": "url.full"}
*/
OPENTELEMETRY_DEPRECATED static constexpr const char *kHttpUrl = "http.url";
/**
Deprecated, use @code user_agent.original @endcode instead.
@deprecated
{"note": "Replaced by @code user_agent.original @endcode.", "reason": "renamed", "renamed_to":
"user_agent.original"}
*/
OPENTELEMETRY_DEPRECATED static constexpr const char *kHttpUserAgent = "http.user_agent";
namespace HttpConnectionStateValues
{
/**
active state.
*/
static constexpr const char *kActive = "active";
/**
idle state.
*/
static constexpr const char *kIdle = "idle";
} // namespace HttpConnectionStateValues
namespace HttpFlavorValues
{
/**
HTTP/1.0
*/
static constexpr const char *kHttp10 = "1.0";
/**
HTTP/1.1
*/
static constexpr const char *kHttp11 = "1.1";
/**
HTTP/2
*/
static constexpr const char *kHttp20 = "2.0";
/**
HTTP/3
*/
static constexpr const char *kHttp30 = "3.0";
/**
SPDY protocol.
*/
static constexpr const char *kSpdy = "SPDY";
/**
QUIC protocol.
*/
static constexpr const char *kQuic = "QUIC";
} // namespace HttpFlavorValues
namespace HttpRequestMethodValues
{
/**
CONNECT method.
*/
static constexpr const char *kConnect = "CONNECT";
/**
DELETE method.
*/
static constexpr const char *kDelete = "DELETE";
/**
GET method.
*/
static constexpr const char *kGet = "GET";
/**
HEAD method.
*/
static constexpr const char *kHead = "HEAD";
/**
OPTIONS method.
*/
static constexpr const char *kOptions = "OPTIONS";
/**
PATCH method.
*/
static constexpr const char *kPatch = "PATCH";
/**
POST method.
*/
static constexpr const char *kPost = "POST";
/**
PUT method.
*/
static constexpr const char *kPut = "PUT";
/**
TRACE method.
*/
static constexpr const char *kTrace = "TRACE";
/**
Any HTTP method that the instrumentation has no prior knowledge of.
*/
static constexpr const char *kOther = "_OTHER";
} // namespace HttpRequestMethodValues
} // namespace http
} // namespace semconv
OPENTELEMETRY_END_NAMESPACE
*/
static constexpr const char *kHttpResponseHeader = "http.response.header";
/**
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.
*/
static constexpr const char *kHttpResponseSize = "http.response.size";
/**
HTTP response status code.
*/
static constexpr const char *kHttpResponseStatusCode = "http.response.status_code";
/**
Deprecated, use @code http.response.header.content-length @endcode instead.
@deprecated
{"note": "hp.response.header.content-length", "reason": "uncategorized"}
*/
OPENTELEMETRY_DEPRECATED static constexpr const char *kHttpResponseContentLength =
"http.response_content_length";
/**
Deprecated, use @code http.response.body.size @endcode instead.
@deprecated
{"note": "Replaced by @code http.response.body.size @endcode.", "reason": "renamed", "renamed_to":
"http.response.body.size"}
*/
OPENTELEMETRY_DEPRECATED static constexpr const char *kHttpResponseContentLengthUncompressed =
"http.response_content_length_uncompressed";
/**
The matched route, that is, the path template in the format used by the respective server
framework.