Module: OpenTelemetry::SemConv::HTTP

Defined in:

lib/opentelemetry/semconv/http/metrics.rb,
lib/opentelemetry/semconv/http/attributes.rb

Metrics Names

HTTP_CLIENT_REQUEST_DURATION =

Note:

Stability Level: stable

Duration of HTTP client requests.

'http.client.request.duration'

HTTP_SERVER_REQUEST_DURATION =

Note:

Stability Level: stable

Duration of HTTP server requests.

'http.server.request.duration'

Attribute Names

HTTP_REQUEST_HEADER_LAMBDA =

Note:

Stability Level: stable

Must be called with a key for the full attribute name. See notes below about the expectations for the state of the key.

HTTP request headers, <key> being the normalized HTTP Header name (lowercase), the value being the header values.

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 the user_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.

Examples:

• A header Content-Type: application/json SHOULD be recorded as the http.request.header.content-type attribute with value ["application/json"].
• A header X-Forwarded-For: 1.2.3.4, 1.2.3.5 SHOULD be recorded as the http.request.header.x-forwarded-for attribute with value ["1.2.3.4", "1.2.3.5"] or ["1.2.3.4, 1.2.3.5"] depending on the HTTP library.

Examples:

Usage

HTTP_REQUEST_HEADER_LAMBDA.call('some-cool-key') #=> 'http.request.header.some-cool-key'

Sample Values

["application/json"]
["1.2.3.4", "1.2.3.5"]

->(key) { "http.request.header.#{key}" }

HTTP_REQUEST_METHOD =

Note:

Stability Level: stable

HTTP request method.

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 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 set http.request.method_original to the original value.

Examples:

Sample Values

GET
POST
HEAD

'http.request.method'

HTTP_REQUEST_METHOD_ORIGINAL =

Note:

Stability Level: stable

Original HTTP method sent by the client in the request line.

Examples:

Sample Values

GeT
ACL
foo

'http.request.method_original'

HTTP_REQUEST_RESEND_COUNT =

Note:

Stability Level: stable

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).

Examples:

Sample Values

3

'http.request.resend_count'

HTTP_RESPONSE_HEADER_LAMBDA =

Note:

Stability Level: stable

Must be called with a key for the full attribute name. See notes below about the expectations for the state of the key.

HTTP response headers, <key> being the normalized HTTP Header name (lowercase), the value being the header values.

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:

• A header Content-Type: application/json header SHOULD be recorded as the http.request.response.content-type attribute with value ["application/json"].
• A header My-custom-header: abc, def header SHOULD be recorded as the http.response.header.my-custom-header attribute with value ["abc", "def"] or ["abc, def"] depending on the HTTP library.

Examples:

Usage

HTTP_RESPONSE_HEADER_LAMBDA.call('some-cool-key') #=> 'http.response.header.some-cool-key'

Sample Values

["application/json"]
["abc", "def"]

->(key) { "http.response.header.#{key}" }

HTTP_RESPONSE_STATUS_CODE =

Note:

Stability Level: stable

HTTP response status code.

Examples:

Sample Values

200

'http.response.status_code'

HTTP_ROUTE =

Note:

Stability Level: stable

The matched route, that is, the path template in the format used by the respective server framework.

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.

Examples:

Sample Values

/users/:userID?
{controller}/{action}/{id?}

'http.route'