View Source OpenTelemetry.SemConv.Incubating.HTTPAttributes (OpenTelemetry.SemConv v1.27.0)

OpenTelemetry Semantic Conventions for HTTP attributes.

Summary

Types

State of the HTTP connection in the HTTP connection pool.

Deprecated, use network.protocol.name instead.

Functions

http_client_ip() deprecated

State of the HTTP connection in the HTTP connection pool.

http_flavor() deprecated
http_host() deprecated
http_method() deprecated

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.

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.

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.

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_scheme() deprecated
http_server_name() deprecated
http_status_code() deprecated
http_target() deprecated
http_url() deprecated
http_user_agent() deprecated

Types

Link to this type

http_connection_state_values()

View Source
@type http_connection_state_values() :: %{active: :active, idle: :idle}

State of the HTTP connection in the HTTP connection pool.

Enum Values

  • :active e - active state.
  • :idle e - idle state.
@type http_flavor_values() :: %{
  http_1_0: :"1.0",
  http_1_1: :"1.1",
  http_2_0: :"2.0",
  http_3_0: :"3.0",
  spdy: :SPDY,
  quic: :QUIC
}

Deprecated, use network.protocol.name instead.

Enum Values

  • :http_1_0 e - HTTP/1.0
  • :http_1_1 e - HTTP/1.1
  • :http_2_0 e - HTTP/2
  • :http_3_0 e - HTTP/3
  • :spdy e - SPDY protocol.
  • :quic e - QUIC protocol.

Functions

This function is deprecated. Replaced by `client.address`. .
@spec http_client_ip() :: :"http.client_ip"
@spec http_connection_state() :: :"http.connection.state"

State of the HTTP connection in the HTTP connection pool.

Examples

["active", "idle"]
iex> OpenTelemetry.SemConv.Incubating.HTTPAttributes.http_connection_state()
:"http.connection.state"

iex> OpenTelemetry.SemConv.Incubating.HTTPAttributes.http_connection_state_values().active
:active

iex> %{OpenTelemetry.SemConv.Incubating.HTTPAttributes.http_connection_state() => OpenTelemetry.SemConv.Incubating.HTTPAttributes.http_connection_state_values().active}
%{:"http.connection.state" => :active}
Link to this function

http_connection_state_values()

View Source
@spec http_connection_state_values() :: http_connection_state_values()
This function is deprecated. Replaced by `network.protocol.name`. .
@spec http_flavor() :: :"http.flavor"
@spec http_flavor_values() :: http_flavor_values()
This function is deprecated. Replaced by one of `server.address`, `client.address` or `http.request.header.host`, depending on the usage. .
@spec http_host() :: :"http.host"
This function is deprecated. Replaced by `http.request.method`. .
@spec http_method() :: :"http.method"
Link to this function

http_request_body_size()

View Source
@spec http_request_body_size() :: :"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.

Value type

Value must be of type integer().

Examples

3495
iex> OpenTelemetry.SemConv.Incubating.HTTPAttributes.http_request_body_size()
:"http.request.body.size"
Link to this function

http_request_content_length()

View Source
This function is deprecated. Replaced by `http.request.header.content-length`. .
@spec http_request_content_length() :: :"http.request_content_length"
Link to this function

http_request_content_length_uncompressed()

View Source
This function is deprecated. Replaced by `http.request.body.size`. .
@spec http_request_content_length_uncompressed() ::
  :"http.request_content_length_uncompressed"

See OpenTelemetry.SemConv.HTTPAttributes.http_request_header/0.

See OpenTelemetry.SemConv.HTTPAttributes.http_request_method/0.

Link to this function

http_request_method_original()

View Source

See OpenTelemetry.SemConv.HTTPAttributes.http_request_method_original/0.

Link to this function

http_request_method_values()

View Source

See OpenTelemetry.SemConv.HTTPAttributes.http_request_method_values/0.

Link to this function

http_request_resend_count()

View Source

See OpenTelemetry.SemConv.HTTPAttributes.http_request_resend_count/0.

@spec http_request_size() :: :"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.

Value type

Value must be of type integer().

Examples

1437
iex> OpenTelemetry.SemConv.Incubating.HTTPAttributes.http_request_size()
:"http.request.size"
Link to this function

http_response_body_size()

View Source
@spec http_response_body_size() :: :"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.

Value type

Value must be of type integer().

Examples

3495
iex> OpenTelemetry.SemConv.Incubating.HTTPAttributes.http_response_body_size()
:"http.response.body.size"
Link to this function

http_response_content_length()

View Source
This function is deprecated. Replaced by `http.response.header.content-length`. .
@spec http_response_content_length() :: :"http.response_content_length"
Link to this function

http_response_content_length_uncompressed()

View Source
This function is deprecated. Replace by `http.response.body.size`. .
@spec http_response_content_length_uncompressed() ::
  :"http.response_content_length_uncompressed"

See OpenTelemetry.SemConv.HTTPAttributes.http_response_header/0.

@spec http_response_size() :: :"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.

Value type

Value must be of type integer().

Examples

1437
iex> OpenTelemetry.SemConv.Incubating.HTTPAttributes.http_response_size()
:"http.response.size"
Link to this function

http_response_status_code()

View Source

See OpenTelemetry.SemConv.HTTPAttributes.http_response_status_code/0.

See OpenTelemetry.SemConv.HTTPAttributes.http_route/0.

This function is deprecated. Replaced by `url.scheme` instead. .
@spec http_scheme() :: :"http.scheme"
This function is deprecated. Replaced by `server.address`. .
@spec http_server_name() :: :"http.server_name"
This function is deprecated. Replaced by `http.response.status_code`. .
@spec http_status_code() :: :"http.status_code"
This function is deprecated. Split to `url.path` and `url.query. .
@spec http_target() :: :"http.target"
This function is deprecated. Replaced by `url.full`. .
@spec http_url() :: :"http.url"
This function is deprecated. Replaced by `user_agent.original`. .
@spec http_user_agent() :: :"http.user_agent"