Package io.opentelemetry.semconv.incubating

Class HttpIncubatingAttributes

java.lang.Object
io.opentelemetry.semconv.incubating.HttpIncubatingAttributes
public final class HttpIncubatingAttributes extends Object

  • Field Details

    • HTTP_CLIENT_IP

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_CLIENT_IP
      Deprecated.
      Replaced by client.address.
      Deprecated, use client.address instead.

    • HTTP_CONNECTION_STATE

      public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_CONNECTION_STATE
      State of the HTTP connection in the HTTP connection pool.

    • HTTP_FLAVOR

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_FLAVOR
      Deprecated.
      Replaced by network.protocol.name.
      Deprecated, use network.protocol.name instead.

    • HTTP_HOST

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_HOST
      Deprecated.
      Replaced by one of server.address, client.address or http.request.header.host, depending on the usage.
      Deprecated, use one of server.address, client.address or http.request.header.host instead, depending on the usage.

    • HTTP_METHOD

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_METHOD
      Deprecated.
      Replaced by http.request.method.
      Deprecated, use http.request.method instead.

    • HTTP_REQUEST_BODY_SIZE

      public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_REQUEST_BODY_SIZE
      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.

    • HTTP_REQUEST_HEADER

      @Deprecated public static final io.opentelemetry.semconv.AttributeKeyTemplate<List<String>> HTTP_REQUEST_HEADER
      Deprecated.
      deprecated in favor of stable HttpAttributes.HTTP_REQUEST_HEADER attribute.
      HTTP request headers, <key> being the normalized HTTP Header name (lowercase), the value being the header values.

      Notes:

      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.

    • HTTP_REQUEST_METHOD

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_REQUEST_METHOD
      Deprecated.
      deprecated in favor of stable HttpAttributes.HTTP_REQUEST_METHOD attribute.
      HTTP request method.

      Notes:

      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_ORIGINAL

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_REQUEST_METHOD_ORIGINAL
      Deprecated.
      deprecated in favor of stable HttpAttributes.HTTP_REQUEST_METHOD_ORIGINAL attribute.
      Original HTTP method sent by the client in the request line.

    • HTTP_REQUEST_RESEND_COUNT

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_REQUEST_RESEND_COUNT
      Deprecated.
      deprecated in favor of stable HttpAttributes.HTTP_REQUEST_RESEND_COUNT attribute.
      The ordinal number of request resending attempt (for any reason, including redirects).

      Notes:

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

    • HTTP_REQUEST_SIZE

      public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_REQUEST_SIZE
      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.

    • HTTP_REQUEST_CONTENT_LENGTH

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_REQUEST_CONTENT_LENGTH
      Deprecated.
      Replaced by http.request.header.<key>.
      Deprecated, use http.request.header.<key> instead.

    • HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED
      Deprecated.
      Replaced by http.request.body.size.
      Deprecated, use http.request.body.size instead.

    • HTTP_RESPONSE_BODY_SIZE

      public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_RESPONSE_BODY_SIZE
      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.

    • HTTP_RESPONSE_HEADER

      @Deprecated public static final io.opentelemetry.semconv.AttributeKeyTemplate<List<String>> HTTP_RESPONSE_HEADER
      Deprecated.
      deprecated in favor of stable HttpAttributes.HTTP_RESPONSE_HEADER attribute.
      HTTP response headers, <key> being the normalized HTTP Header name (lowercase), the value being the header values.

      Notes:

      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.

    • HTTP_RESPONSE_SIZE

      public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_RESPONSE_SIZE
      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.

    • HTTP_RESPONSE_STATUS_CODE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_RESPONSE_STATUS_CODE
      Deprecated.
      deprecated in favor of stable HttpAttributes.HTTP_RESPONSE_STATUS_CODE attribute.
      HTTP response status code.

    • HTTP_RESPONSE_CONTENT_LENGTH

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_RESPONSE_CONTENT_LENGTH
      Deprecated.
      Replaced by http.response.header.<key>.
      Deprecated, use http.response.header.<key> instead.

    • HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED
      Deprecated.
      Replace by http.response.body.size.
      Deprecated, use http.response.body.size instead.

    • HTTP_ROUTE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_ROUTE
      Deprecated.
      deprecated in favor of stable HttpAttributes.HTTP_ROUTE attribute.
      The matched route, that is, the path template in the format used by the respective server framework.

      Notes:

      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.

    • HTTP_SCHEME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_SCHEME
      Deprecated.
      Replaced by url.scheme instead.
      Deprecated, use url.scheme instead.

    • HTTP_SERVER_NAME

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_SERVER_NAME
      Deprecated.
      Replaced by server.address.
      Deprecated, use server.address instead.

    • HTTP_STATUS_CODE

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<Long> HTTP_STATUS_CODE
      Deprecated.
      Replaced by http.response.status_code.
      Deprecated, use http.response.status_code instead.

    • HTTP_TARGET

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_TARGET
      Deprecated.
      Split to url.path and `url.query.
      Deprecated, use url.path and url.query instead.

    • HTTP_URL

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_URL
      Deprecated.
      Replaced by url.full.
      Deprecated, use url.full instead.

    • HTTP_USER_AGENT

      @Deprecated public static final io.opentelemetry.api.common.AttributeKey<String> HTTP_USER_AGENT
      Deprecated.
      Replaced by user_agent.original.
      Deprecated, use user_agent.original instead.