http-metrics.md

Semantic Conventions for HTTP Metrics

Status: Mixed

The conventions described in this section are HTTP specific. When HTTP operations occur, metric events about those operations will be generated and reported to provide insight into the operations. By adding HTTP attributes to metric events it allows for finely tuned filtering.

Disclaimer: These are initial HTTP metric instruments and attributes but more may be added in the future.

• HTTP Server
  • Metric: http.server.request.duration
  • Metric: http.server.active_requests
  • Metric: http.server.request.body.size
  • Metric: http.server.response.body.size
• HTTP Client
  • Metric: http.client.request.duration
    • Experimental attributes
  • Metric: http.client.request.body.size
  • Metric: http.client.response.body.size
  • Metric: http.client.open_connections
  • Metric: http.client.connection.duration
  • Metric: http.client.active_requests

Warning Existing HTTP instrumentations that are using v1.20.0 of this document (or prior):

• SHOULD NOT change the version of the HTTP or networking conventions that they emit until the HTTP semantic conventions are marked stable (HTTP stabilization will include stabilization of a core set of networking conventions which are also used in HTTP instrumentations). Conventions include, but are not limited to, attributes, metric and span names, and unit of measure.
• SHOULD introduce an environment variable OTEL_SEMCONV_STABILITY_OPT_IN in the existing major version which is a comma-separated list of values. The only values defined so far are:
  • http - emit the new, stable HTTP and networking conventions, and stop emitting the old experimental HTTP and networking conventions that the instrumentation emitted previously.
  • http/dup - emit both the old and the stable HTTP and networking conventions, allowing for a seamless transition.
  • The default behavior (in the absence of one of these values) is to continue emitting whatever version of the old experimental HTTP and networking conventions the instrumentation was emitting previously.
  • Note: http/dup has higher precedence than http in case both values are present
• SHOULD maintain (security patching at a minimum) the existing major version for at least six months after it starts emitting both sets of conventions.
• SHOULD drop the environment variable in the next major version.

HTTP Server

Metric: http.server.request.duration

This metric is required.

When this metric is reported alongside an HTTP server span, the metric value SHOULD be the same as the HTTP server span duration.

This metric SHOULD be specified with ExplicitBucketBoundaries of [ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 ].

Name	Instrument Type	Unit (UCUM)	Description	Stability
http.server.request.duration	Histogram	s	Duration of HTTP server requests.

Attribute	Type	Description	Examples	Requirement Level	Stability
http.request.method	string	HTTP request method. [1]	GET; POST; HEAD	Required
url.scheme	string	The URI scheme component identifying the used protocol. [2]	http; https	Required
error.type	string	Describes a class of error the operation ended with. [3]	timeout; java.net.UnknownHostException; server_certificate_invalid; 500	Conditionally Required If request has ended with an error.
http.response.status_code	int	HTTP response status code.	200	Conditionally Required If and only if one was received/sent.
http.route	string	The matched route, that is, the path template in the format used by the respective server framework. [4]	/users/:userID?; {controller}/{action}/{id?}	Conditionally Required If and only if it's available
network.protocol.name	string	OSI application layer or non-OSI equivalent. [5]	http; spdy	Conditionally Required [6]
network.protocol.version	string	The actual version of the protocol used for network communication. [7]	1.0; 1.1; 2; 3	Recommended
server.address	string	Name of the local HTTP server that received the request. [8]	example.com; 10.1.2.80; /tmp/my.sock	Opt-In
server.port	int	Port of the local HTTP server that received the request. [9]	80; 8080; 443	Opt-In

[1]: 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.

[2]: The scheme of the original client request, if known (e.g. from Forwarded#proto, X-Forwarded-Proto, or a similar header). Otherwise, the scheme of the immediate peer request.

[3]: If the request fails with an error before response status code was sent or received, error.type SHOULD be set to exception type (its fully-qualified class name, if applicable) or a component-specific low cardinality error identifier.

If response status code was sent or received and status indicates an error according to HTTP span status definition, error.type SHOULD be set to the status code number (represented as a string), an exception type (if thrown) or a component-specific error identifier.

The error.type value SHOULD be predictable and SHOULD have low cardinality. Instrumentations SHOULD document the list of errors they report.

The cardinality of error.type within one instrumentation library SHOULD be low, but telemetry consumers that aggregate data from multiple instrumentation libraries and applications should be prepared for error.type to have high cardinality at query time, when no additional filters are applied.

If the request has completed successfully, instrumentations SHOULD NOT set error.type.

[4]: 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.

[5]: The value SHOULD be normalized to lowercase.

[6]: If not http and network.protocol.version is set.

[7]: If protocol version is subject to negotiation (for example using ALPN), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set.

[8]: See Setting server.address and server.port attributes.

Warning Since this attribute is based on HTTP headers, opting in to it may allow an attacker to trigger cardinality limits, degrading the usefulness of the metric.

[9]: See Setting server.address and server.port attributes.

Warning Since this attribute is based on HTTP headers, opting in to it may allow an attacker to trigger cardinality limits, degrading the usefulness of the metric.

error.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
_OTHER	A fallback error value to be used when the instrumentation doesn't define a custom value.

http.request.method has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
_OTHER	Any HTTP method that the instrumentation has no prior knowledge of.
CONNECT	CONNECT method.
DELETE	DELETE method.
GET	GET method.
HEAD	HEAD method.
OPTIONS	OPTIONS method.
PATCH	PATCH method.
POST	POST method.
PUT	PUT method.
TRACE	TRACE method.

Metric: http.server.active_requests

This metric is optional.

Name	Instrument Type	Unit (UCUM)	Description	Stability
http.server.active_requests	UpDownCounter	{request}	Number of active HTTP server requests.

Attribute	Type	Description	Examples	Requirement Level	Stability
http.request.method	string	HTTP request method. [1]	GET; POST; HEAD	Required
url.scheme	string	The URI scheme component identifying the used protocol.	http; https	Required
server.address	string	Name of the local HTTP server that received the request. [2]	example.com; 10.1.2.80; /tmp/my.sock	Opt-In
server.port	int	Port of the local HTTP server that received the request. [3]	80; 8080; 443	Opt-In

[1]: 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.

[2]: See Setting server.address and server.port attributes.

Warning Since this attribute is based on HTTP headers, opting in to it may allow an attacker to trigger cardinality limits, degrading the usefulness of the metric.

[3]: See Setting server.address and server.port attributes.

Warning Since this attribute is based on HTTP headers, opting in to it may allow an attacker to trigger cardinality limits, degrading the usefulness of the metric.

http.request.method has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
_OTHER	Any HTTP method that the instrumentation has no prior knowledge of.
CONNECT	CONNECT method.
DELETE	DELETE method.
GET	GET method.
HEAD	HEAD method.
OPTIONS	OPTIONS method.
PATCH	PATCH method.
POST	POST method.
PUT	PUT method.
TRACE	TRACE method.

Metric: http.server.request.body.size

This metric is optional.

Name	Instrument Type	Unit (UCUM)	Description	Stability
http.server.request.body.size	Histogram	By	Size of HTTP server request bodies. [1]

[1]: 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 Content-Length header. For requests using transport encoding, this should be the compressed size.

Attribute	Type	Description	Examples	Requirement Level	Stability
http.request.method	string	HTTP request method. [1]	GET; POST; HEAD	Required
url.scheme	string	The URI scheme component identifying the used protocol. [2]	http; https	Required
error.type	string	Describes a class of error the operation ended with. [3]	timeout; java.net.UnknownHostException; server_certificate_invalid; 500	Conditionally Required If request has ended with an error.
http.response.status_code	int	HTTP response status code.	200	Conditionally Required If and only if one was received/sent.
http.route	string	The matched route, that is, the path template in the format used by the respective server framework. [4]	/users/:userID?; {controller}/{action}/{id?}	Conditionally Required If and only if it's available
network.protocol.name	string	OSI application layer or non-OSI equivalent. [5]	http; spdy	Conditionally Required [6]
network.protocol.version	string	The actual version of the protocol used for network communication. [7]	1.0; 1.1; 2; 3	Recommended
server.address	string	Name of the local HTTP server that received the request. [8]	example.com; 10.1.2.80; /tmp/my.sock	Opt-In
server.port	int	Port of the local HTTP server that received the request. [9]	80; 8080; 443	Opt-In

[1]: 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.

[2]: The scheme of the original client request, if known (e.g. from Forwarded#proto, X-Forwarded-Proto, or a similar header). Otherwise, the scheme of the immediate peer request.

[3]: If the request fails with an error before response status code was sent or received, error.type SHOULD be set to exception type (its fully-qualified class name, if applicable) or a component-specific low cardinality error identifier.

If response status code was sent or received and status indicates an error according to HTTP span status definition, error.type SHOULD be set to the status code number (represented as a string), an exception type (if thrown) or a component-specific error identifier.

The error.type value SHOULD be predictable and SHOULD have low cardinality. Instrumentations SHOULD document the list of errors they report.

The cardinality of error.type within one instrumentation library SHOULD be low, but telemetry consumers that aggregate data from multiple instrumentation libraries and applications should be prepared for error.type to have high cardinality at query time, when no additional filters are applied.

If the request has completed successfully, instrumentations SHOULD NOT set error.type.

[4]: 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.

[5]: The value SHOULD be normalized to lowercase.

[6]: If not http and network.protocol.version is set.

[7]: If protocol version is subject to negotiation (for example using ALPN), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set.

[8]: See Setting server.address and server.port attributes.

Warning Since this attribute is based on HTTP headers, opting in to it may allow an attacker to trigger cardinality limits, degrading the usefulness of the metric.

[9]: See Setting server.address and server.port attributes.

Warning Since this attribute is based on HTTP headers, opting in to it may allow an attacker to trigger cardinality limits, degrading the usefulness of the metric.

error.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
_OTHER	A fallback error value to be used when the instrumentation doesn't define a custom value.

http.request.method has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
_OTHER	Any HTTP method that the instrumentation has no prior knowledge of.
CONNECT	CONNECT method.
DELETE	DELETE method.
GET	GET method.
HEAD	HEAD method.
OPTIONS	OPTIONS method.
PATCH	PATCH method.
POST	POST method.
PUT	PUT method.
TRACE	TRACE method.

Metric: http.server.response.body.size

This metric is optional.

Name	Instrument Type	Unit (UCUM)	Description	Stability
http.server.response.body.size	Histogram	By	Size of HTTP server response bodies. [1]

[1]: 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.

Attribute	Type	Description	Examples	Requirement Level	Stability
http.request.method	string	HTTP request method. [1]	GET; POST; HEAD	Required
url.scheme	string	The URI scheme component identifying the used protocol. [2]	http; https	Required
error.type	string	Describes a class of error the operation ended with. [3]	timeout; java.net.UnknownHostException; server_certificate_invalid; 500	Conditionally Required If request has ended with an error.
http.response.status_code	int	HTTP response status code.	200	Conditionally Required If and only if one was received/sent.
http.route	string	The matched route, that is, the path template in the format used by the respective server framework. [4]	/users/:userID?; {controller}/{action}/{id?}	Conditionally Required If and only if it's available
network.protocol.name	string	OSI application layer or non-OSI equivalent. [5]	http; spdy	Conditionally Required [6]
network.protocol.version	string	The actual version of the protocol used for network communication. [7]	1.0; 1.1; 2; 3	Recommended
server.address	string	Name of the local HTTP server that received the request. [8]	example.com; 10.1.2.80; /tmp/my.sock	Opt-In
server.port	int	Port of the local HTTP server that received the request. [9]	80; 8080; 443	Opt-In

[1]: 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.

[2]: The scheme of the original client request, if known (e.g. from Forwarded#proto, X-Forwarded-Proto, or a similar header). Otherwise, the scheme of the immediate peer request.

[3]: If the request fails with an error before response status code was sent or received, error.type SHOULD be set to exception type (its fully-qualified class name, if applicable) or a component-specific low cardinality error identifier.

If response status code was sent or received and status indicates an error according to HTTP span status definition, error.type SHOULD be set to the status code number (represented as a string), an exception type (if thrown) or a component-specific error identifier.

The error.type value SHOULD be predictable and SHOULD have low cardinality. Instrumentations SHOULD document the list of errors they report.

The cardinality of error.type within one instrumentation library SHOULD be low, but telemetry consumers that aggregate data from multiple instrumentation libraries and applications should be prepared for error.type to have high cardinality at query time, when no additional filters are applied.

If the request has completed successfully, instrumentations SHOULD NOT set error.type.

[4]: 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.

[5]: The value SHOULD be normalized to lowercase.

[6]: If not http and network.protocol.version is set.

[7]: If protocol version is subject to negotiation (for example using ALPN), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set.

[8]: See Setting server.address and server.port attributes.

Warning Since this attribute is based on HTTP headers, opting in to it may allow an attacker to trigger cardinality limits, degrading the usefulness of the metric.

[9]: See Setting server.address and server.port attributes.

Warning Since this attribute is based on HTTP headers, opting in to it may allow an attacker to trigger cardinality limits, degrading the usefulness of the metric.

error.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
_OTHER	A fallback error value to be used when the instrumentation doesn't define a custom value.

http.request.method has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
_OTHER	Any HTTP method that the instrumentation has no prior knowledge of.
CONNECT	CONNECT method.
DELETE	DELETE method.
GET	GET method.
HEAD	HEAD method.
OPTIONS	OPTIONS method.
PATCH	PATCH method.
POST	POST method.
PUT	PUT method.
TRACE	TRACE method.

HTTP Client

Metric: http.client.request.duration

This metric is required.

When this metric is reported alongside an HTTP client span, the metric value SHOULD be the same as the HTTP client span duration.

This metric SHOULD be specified with ExplicitBucketBoundaries of [ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 ].

Name	Instrument Type	Unit (UCUM)	Description	Stability
http.client.request.duration	Histogram	s	Duration of HTTP client requests.

Attribute	Type	Description	Examples	Requirement Level	Stability
http.request.method	string	HTTP request method. [1]	GET; POST; HEAD	Required
server.address	string	Host identifier of the "URI origin" HTTP request is sent to. [2]	example.com; 10.1.2.80; /tmp/my.sock	Required
server.port	int	Port identifier of the "URI origin" HTTP request is sent to. [3]	80; 8080; 443	Required
error.type	string	Describes a class of error the operation ended with. [4]	timeout; java.net.UnknownHostException; server_certificate_invalid; 500	Conditionally Required If request has ended with an error.
http.response.status_code	int	HTTP response status code.	200	Conditionally Required If and only if one was received/sent.
network.protocol.name	string	OSI application layer or non-OSI equivalent. [5]	http; spdy	Conditionally Required [6]
network.protocol.version	string	The actual version of the protocol used for network communication. [7]	1.0; 1.1; 2; 3	Recommended
url.scheme	string	The URI scheme component identifying the used protocol.	http; https	Opt-In

[1]: 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.

[2]: If an HTTP client request is explicitly made to an IP address, e.g. http://x.x.x.x:8080, then server.address SHOULD be the IP address x.x.x.x. A DNS lookup SHOULD NOT be used.

[3]: When observed from the client side, and when communicating through an intermediary, server.port SHOULD represent the server port behind any intermediaries, for example proxies, if it's available.

[4]: If the request fails with an error before response status code was sent or received, error.type SHOULD be set to exception type (its fully-qualified class name, if applicable) or a component-specific low cardinality error identifier.

If response status code was sent or received and status indicates an error according to HTTP span status definition, error.type SHOULD be set to the status code number (represented as a string), an exception type (if thrown) or a component-specific error identifier.

The error.type value SHOULD be predictable and SHOULD have low cardinality. Instrumentations SHOULD document the list of errors they report.

The cardinality of error.type within one instrumentation library SHOULD be low, but telemetry consumers that aggregate data from multiple instrumentation libraries and applications should be prepared for error.type to have high cardinality at query time, when no additional filters are applied.

If the request has completed successfully, instrumentations SHOULD NOT set error.type.

[5]: The value SHOULD be normalized to lowercase.

[6]: If not http and network.protocol.version is set.

[7]: If protocol version is subject to negotiation (for example using ALPN), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set.

error.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
_OTHER	A fallback error value to be used when the instrumentation doesn't define a custom value.

http.request.method has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
_OTHER	Any HTTP method that the instrumentation has no prior knowledge of.
CONNECT	CONNECT method.
DELETE	DELETE method.
GET	GET method.
HEAD	HEAD method.
OPTIONS	OPTIONS method.
PATCH	PATCH method.
POST	POST method.
PUT	PUT method.
TRACE	TRACE method.

Experimental attributes

Status: Experimental

Instrumentations MAY allow users to enable additional experimental attributes.

Attribute	Type	Description	Examples	Requirement Level	Stability
url.template	string	The low-cardinality template of an absolute path reference. [1]	/users/{id}; /users/:id; /users?id={id}	Opt-In

[1]: The url.template MUST have low cardinality. It is not usually available on HTTP clients, but may be known by the application or specialized HTTP instrumentation.

Metric: http.client.request.body.size

This metric is optional.

Name	Instrument Type	Unit (UCUM)	Description	Stability
http.client.request.body.size	Histogram	By	Size of HTTP client request bodies. [1]

[1]: 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 Content-Length header. For requests using transport encoding, this should be the compressed size.

Attribute	Type	Description	Examples	Requirement Level	Stability
http.request.method	string	HTTP request method. [1]	GET; POST; HEAD	Required
server.address	string	Host identifier of the "URI origin" HTTP request is sent to. [2]	example.com; 10.1.2.80; /tmp/my.sock	Required
server.port	int	Port identifier of the "URI origin" HTTP request is sent to. [3]	80; 8080; 443	Required
error.type	string	Describes a class of error the operation ended with. [4]	timeout; java.net.UnknownHostException; server_certificate_invalid; 500	Conditionally Required If request has ended with an error.
http.response.status_code	int	HTTP response status code.	200	Conditionally Required If and only if one was received/sent.
network.protocol.name	string	OSI application layer or non-OSI equivalent. [5]	http; spdy	Conditionally Required [6]
url.template	string	The low-cardinality template of an absolute path reference. [7]	/users/{id}; /users/:id; /users?id={id}	Conditionally Required If available.
network.protocol.version	string	The actual version of the protocol used for network communication. [8]	1.0; 1.1; 2; 3	Recommended
url.scheme	string	The URI scheme component identifying the used protocol.	http; https	Opt-In

[1]: 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.

[2]: If an HTTP client request is explicitly made to an IP address, e.g. http://x.x.x.x:8080, then server.address SHOULD be the IP address x.x.x.x. A DNS lookup SHOULD NOT be used.

[3]: When observed from the client side, and when communicating through an intermediary, server.port SHOULD represent the server port behind any intermediaries, for example proxies, if it's available.

[4]: If the request fails with an error before response status code was sent or received, error.type SHOULD be set to exception type (its fully-qualified class name, if applicable) or a component-specific low cardinality error identifier.

If response status code was sent or received and status indicates an error according to HTTP span status definition, error.type SHOULD be set to the status code number (represented as a string), an exception type (if thrown) or a component-specific error identifier.

The error.type value SHOULD be predictable and SHOULD have low cardinality. Instrumentations SHOULD document the list of errors they report.

The cardinality of error.type within one instrumentation library SHOULD be low, but telemetry consumers that aggregate data from multiple instrumentation libraries and applications should be prepared for error.type to have high cardinality at query time, when no additional filters are applied.

If the request has completed successfully, instrumentations SHOULD NOT set error.type.

[5]: The value SHOULD be normalized to lowercase.

[6]: If not http and network.protocol.version is set.

[7]: The url.template MUST have low cardinality. It is not usually available on HTTP clients, but may be known by the application or specialized HTTP instrumentation.

[8]: If protocol version is subject to negotiation (for example using ALPN), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set.

error.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
_OTHER	A fallback error value to be used when the instrumentation doesn't define a custom value.

http.request.method has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
_OTHER	Any HTTP method that the instrumentation has no prior knowledge of.
CONNECT	CONNECT method.
DELETE	DELETE method.
GET	GET method.
HEAD	HEAD method.
OPTIONS	OPTIONS method.
PATCH	PATCH method.
POST	POST method.
PUT	PUT method.
TRACE	TRACE method.

Metric: http.client.response.body.size

This metric is optional.

Name	Instrument Type	Unit (UCUM)	Description	Stability
http.client.response.body.size	Histogram	By	Size of HTTP client response bodies. [1]

[1]: 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.

Attribute	Type	Description	Examples	Requirement Level	Stability
http.request.method	string	HTTP request method. [1]	GET; POST; HEAD	Required
server.address	string	Host identifier of the "URI origin" HTTP request is sent to. [2]	example.com; 10.1.2.80; /tmp/my.sock	Required
server.port	int	Port identifier of the "URI origin" HTTP request is sent to. [3]	80; 8080; 443	Required
error.type	string	Describes a class of error the operation ended with. [4]	timeout; java.net.UnknownHostException; server_certificate_invalid; 500	Conditionally Required If request has ended with an error.
http.response.status_code	int	HTTP response status code.	200	Conditionally Required If and only if one was received/sent.
network.protocol.name	string	OSI application layer or non-OSI equivalent. [5]	http; spdy	Conditionally Required [6]
url.template	string	The low-cardinality template of an absolute path reference. [7]	/users/{id}; /users/:id; /users?id={id}	Conditionally Required If available.
network.protocol.version	string	The actual version of the protocol used for network communication. [8]	1.0; 1.1; 2; 3	Recommended
url.scheme	string	The URI scheme component identifying the used protocol.	http; https	Opt-In

[1]: 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.

[2]: If an HTTP client request is explicitly made to an IP address, e.g. http://x.x.x.x:8080, then server.address SHOULD be the IP address x.x.x.x. A DNS lookup SHOULD NOT be used.

[3]: When observed from the client side, and when communicating through an intermediary, server.port SHOULD represent the server port behind any intermediaries, for example proxies, if it's available.

[4]: If the request fails with an error before response status code was sent or received, error.type SHOULD be set to exception type (its fully-qualified class name, if applicable) or a component-specific low cardinality error identifier.

If response status code was sent or received and status indicates an error according to HTTP span status definition, error.type SHOULD be set to the status code number (represented as a string), an exception type (if thrown) or a component-specific error identifier.

The error.type value SHOULD be predictable and SHOULD have low cardinality. Instrumentations SHOULD document the list of errors they report.

The cardinality of error.type within one instrumentation library SHOULD be low, but telemetry consumers that aggregate data from multiple instrumentation libraries and applications should be prepared for error.type to have high cardinality at query time, when no additional filters are applied.

If the request has completed successfully, instrumentations SHOULD NOT set error.type.

[5]: The value SHOULD be normalized to lowercase.

[6]: If not http and network.protocol.version is set.

[7]: The url.template MUST have low cardinality. It is not usually available on HTTP clients, but may be known by the application or specialized HTTP instrumentation.

[8]: If protocol version is subject to negotiation (for example using ALPN), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set.

error.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
_OTHER	A fallback error value to be used when the instrumentation doesn't define a custom value.

http.request.method has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
_OTHER	Any HTTP method that the instrumentation has no prior knowledge of.
CONNECT	CONNECT method.
DELETE	DELETE method.
GET	GET method.
HEAD	HEAD method.
OPTIONS	OPTIONS method.
PATCH	PATCH method.
POST	POST method.
PUT	PUT method.
TRACE	TRACE method.

Metric: http.client.open_connections

This metric is optional.

Name	Instrument Type	Unit (UCUM)	Description	Stability
http.client.open_connections	UpDownCounter	{connection}	Number of outbound HTTP connections that are currently active or idle on the client.

Attribute	Type	Description	Examples	Requirement Level	Stability
http.connection.state	string	State of the HTTP connection in the HTTP connection pool.	active; idle	Required
server.address	string	Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1]	example.com; 10.1.2.80; /tmp/my.sock	Required
server.port	int	Port identifier of the "URI origin" HTTP request is sent to. [2]	80; 8080; 443	Required
network.peer.address	string	Peer address of the network connection - IP address or Unix domain socket name.	10.1.2.80; /tmp/my.sock	Recommended
network.protocol.version	string	The actual version of the protocol used for network communication. [3]	1.1; 2	Recommended
url.scheme	string	The URI scheme component identifying the used protocol.	http; https	Opt-In

[1]: When observed from the client side, and when communicating through an intermediary, server.address SHOULD represent the server address behind any intermediaries, for example proxies, if it's available.

[2]: When observed from the client side, and when communicating through an intermediary, server.port SHOULD represent the server port behind any intermediaries, for example proxies, if it's available.

[3]: If protocol version is subject to negotiation (for example using ALPN), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set.

http.connection.state has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
active	active state.
idle	idle state.

Metric: http.client.connection.duration

This metric SHOULD be specified with ExplicitBucketBoundaries of [ 0.01, 0.02, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10, 30, 60, 120, 300 ].

This metric is optional.

Name	Instrument Type	Unit (UCUM)	Description	Stability
http.client.connection.duration	Histogram	s	The duration of the successfully established outbound HTTP connections.

Attribute	Type	Description	Examples	Requirement Level	Stability
server.address	string	Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1]	example.com; 10.1.2.80; /tmp/my.sock	Required
server.port	int	Port identifier of the "URI origin" HTTP request is sent to. [2]	80; 8080; 443	Required
network.peer.address	string	Peer address of the network connection - IP address or Unix domain socket name.	10.1.2.80; /tmp/my.sock	Recommended
network.protocol.version	string	The actual version of the protocol used for network communication. [3]	1.1; 2	Recommended
url.scheme	string	The URI scheme component identifying the used protocol.	http; https	Opt-In

[1]: When observed from the client side, and when communicating through an intermediary, server.address SHOULD represent the server address behind any intermediaries, for example proxies, if it's available.

[2]: When observed from the client side, and when communicating through an intermediary, server.port SHOULD represent the server port behind any intermediaries, for example proxies, if it's available.

[3]: If protocol version is subject to negotiation (for example using ALPN), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set.

Metric: http.client.active_requests

Status: Experimental

This metric is optional.

Name	Instrument Type	Unit (UCUM)	Description	Stability
http.client.active_requests	UpDownCounter	{request}	Number of active HTTP requests.

Attribute	Type	Description	Examples	Requirement Level	Stability
server.address	string	Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [1]	example.com; 10.1.2.80; /tmp/my.sock	Required
server.port	int	Port identifier of the "URI origin" HTTP request is sent to. [2]	80; 8080; 443	Required
url.template	string	The low-cardinality template of an absolute path reference. [3]	/users/{id}; /users/:id; /users?id={id}	Conditionally Required If available.
http.request.method	string	HTTP request method. [4]	GET; POST; HEAD	Recommended
url.scheme	string	The URI scheme component identifying the used protocol.	http; https	Opt-In

[1]: When observed from the client side, and when communicating through an intermediary, server.address SHOULD represent the server address behind any intermediaries, for example proxies, if it's available.

[2]: When observed from the client side, and when communicating through an intermediary, server.port SHOULD represent the server port behind any intermediaries, for example proxies, if it's available.

[3]: The url.template MUST have low cardinality. It is not usually available on HTTP clients, but may be known by the application or specialized HTTP instrumentation.

[4]: 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.

http.request.method has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Value	Description	Stability
_OTHER	Any HTTP method that the instrumentation has no prior knowledge of.
CONNECT	CONNECT method.
DELETE	DELETE method.
GET	GET method.
HEAD	HEAD method.
OPTIONS	OPTIONS method.
PATCH	PATCH method.
POST	POST method.
PUT	PUT method.
TRACE	TRACE method.