httpconv

Documentation

Overview

Package httpconv provides OpenTelemetry HTTP semantic conventions for tracing telemetry.

Index

• func ClientRequest(req *http.Request) []attribute.KeyValue
• func ClientResponse(resp *http.Response) []attribute.KeyValue
• func ClientStatus(code int) (codes.Code, string)
• func RequestHeader(h http.Header) []attribute.KeyValue
• func ResponseHeader(h http.Header) []attribute.KeyValue
• func ServerRequest(server string, req *http.Request) []attribute.KeyValue
• func ServerStatus(code int) (codes.Code, string)

Functions

func ClientRequest

func ClientRequest(req *http.Request) []attribute.KeyValue

ClientRequest returns trace attributes for an HTTP request made by a client. The following attributes are always returned: "http.url", "net.protocol.(name|version)", "http.method", "net.peer.name". The following attributes are returned if the related values are defined in req: "net.peer.port", "http.user_agent", "http.request_content_length", "enduser.id".

func ClientResponse

func ClientResponse(resp *http.Response) []attribute.KeyValue

ClientResponse returns trace attributes for an HTTP response received by a client from a server. It will return the following attributes if the related values are defined in resp: "http.status.code", "http.response_content_length".

This does not add all OpenTelemetry required attributes for an HTTP event, it assumes ClientRequest was used to create the span with a complete set of attributes. If a complete set of attributes can be generated using the request contained in resp. For example:

append(ClientResponse(resp), ClientRequest(resp.Request)...)

func ClientStatus

func ClientStatus(code int) (codes.Code, string)

ClientStatus returns a span status code and message for an HTTP status code value received by a client.

func RequestHeader

func RequestHeader(h http.Header) []attribute.KeyValue

RequestHeader returns the contents of h as attributes.

Instrumentation should require an explicit configuration of which headers to captured and then prune what they pass here. Including all 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 from ClientRequest and ServerRequest. Instrumentation may provide an option to capture that header here even though it is not recommended. Otherwise, instrumentation should filter that out of what is passed.

func ResponseHeader

func ResponseHeader(h http.Header) []attribute.KeyValue

ResponseHeader returns the contents of h as attributes.

Instrumentation should require an explicit configuration of which headers to captured and then prune what they pass here. Including all 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 from ClientRequest and ServerRequest. Instrumentation may provide an option to capture that header here even though it is not recommended. Otherwise, instrumentation should filter that out of what is passed.

func ServerRequest

func ServerRequest(server string, req *http.Request) []attribute.KeyValue

ServerRequest returns trace attributes for an HTTP request received by a server.

The server must be the primary server name if it is known. For example this would be the ServerName directive (https://httpd.apache.org/docs/2.4/mod/core.html#servername) for an Apache server, and the server_name directive (http://nginx.org/en/docs/http/ngx_http_core_module.html#server_name) for an nginx server. More generically, the primary server name would be the host header value that matches the default virtual host of an HTTP server. It should include the host identifier and if a port is used to route to the server that port identifier should be included as an appropriate port suffix.

If the primary server name is not known, server should be an empty string. The req Host will be used to determine the server instead.

The following attributes are always returned: "http.method", "http.scheme", ""net.protocol.(name|version)", "http.target", "net.host.name". The following attributes are returned if they related values are defined in req: "net.host.port", "net.sock.peer.addr", "net.sock.peer.port", "user_agent.original", "enduser.id", "http.client_ip".

func ServerStatus

func ServerStatus(code int) (codes.Code, string)

ServerStatus returns a span status code and message for an HTTP status code value returned by a server. Status codes in the 400-499 range are not returned as errors.