Http enum

http.* attribute keys from the OpenTelemetry semantic-conventions attribute registry.

Inheritance
Implemented types
Available extensions

Values

httpClientIp → const Http

Deprecated, use client.address instead.

Examples: 83.164.160.102

Stability: development

const Http('http.client_ip')
httpConnectionState → const Http

State of the HTTP connection in the HTTP connection pool.

Examples: active, idle

Stability: development

const Http('http.connection.state')
httpFlavor → const Http

Deprecated, use network.protocol.name and network.protocol.version instead.

Stability: development

const Http('http.flavor')
httpHost → const Http

Deprecated, use one of server.address, client.address or http.request.header.host instead, depending on the usage.

Examples: www.example.org

Stability: development

const Http('http.host')
httpMethod → const Http

Deprecated, use http.request.method instead.

Examples: GET, POST, HEAD

Stability: development

const Http('http.method')
httpRequestBodySize → const Http

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.

Examples: 3495

Stability: development

const Http('http.request.body.size')
httpRequestHeader → const Http

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

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

const Http('http.request.header')
httpRequestMethod → const Http

HTTP request method.

Examples: GET, POST, HEAD

const Http('http.request.method')
httpRequestMethodOriginal → const Http

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

Examples: GeT, ACL, foo

const Http('http.request.method_original')
httpRequestResendCount → const Http

The ordinal number of request resending attempt (for any reason, including redirects).

Examples: 3

const Http('http.request.resend_count')
httpRequestSize → const Http

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.

Examples: 1437

Stability: development

const Http('http.request.size')
httpRequestContentLength → const Http

Deprecated, use http.request.header.content-length instead.

Examples: 3495

Stability: development

const Http('http.request_content_length')
httpRequestContentLengthUncompressed → const Http

Deprecated, use http.request.body.size instead.

Examples: 5493

Stability: development

const Http('http.request_content_length_uncompressed')
httpResponseBodySize → const Http

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.

Examples: 3495

Stability: development

const Http('http.response.body.size')
httpResponseHeader → const Http

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

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

const Http('http.response.header')
httpResponseSize → const Http

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.

Examples: 1437

Stability: development

const Http('http.response.size')
httpResponseStatusCode → const Http

HTTP response status code .

Examples: 200

const Http('http.response.status_code')
httpResponseContentLength → const Http

Deprecated, use http.response.header.content-length instead.

Examples: 3495

Stability: development

const Http('http.response_content_length')
httpResponseContentLengthUncompressed → const Http

Deprecated, use http.response.body.size instead.

Examples: 5493

Stability: development

const Http('http.response_content_length_uncompressed')
httpRoute → const Http

The matched route template for the request. This MUST be low-cardinality and include all static path segments, with dynamic path segments represented with placeholders.

Examples: /users/:userID?, my-controller/my-action/{id?}

const Http('http.route')
httpScheme → const Http

Deprecated, use url.scheme instead.

Examples: http, https

Stability: development

const Http('http.scheme')
httpServerName → const Http

Deprecated, use server.address instead.

Examples: example.com

Stability: development

const Http('http.server_name')
httpStatusCode → const Http

Deprecated, use http.response.status_code instead.

Examples: 200

Stability: development

const Http('http.status_code')
httpTarget → const Http

Deprecated, use url.path and url.query instead.

Examples: /search?q=OpenTelemetry#SemConv

Stability: development

const Http('http.target')
httpUrl → const Http

Deprecated, use url.full instead.

Examples: https://www.foo.bar/search?q=OpenTelemetry#SemConv

Stability: development

const Http('http.url')
httpUserAgent → const Http

Deprecated, use user_agent.original instead.

Examples: CERN-LineMode/2.15 libwww/2.17b3, Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1

Stability: development

const Http('http.user_agent')

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
key → String
The attribute key string as defined in the OpenTelemetry specification.
final
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMapEntry(Object value) → MapEntry<String, Object>

Available on OTelSemantic, provided by the OTelSemanticExtension extension

Converts this semantic attribute and its value to a MapEntry.
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<Http>
A constant List of the values in this enum, in order of their declaration.