Module pavex_tracing::fields

Utilities to log common resources with consistent naming and representations.

For well-known resources, this module exposes:

• A constant holding the conventional field name used when logging that resource
• A function to compute the conventional log representation of that resource in the context of an HTTP API

For example, you have HTTP_REQUEST_METHOD and http_request_method for the http.request.method field.

The naming follows OpenTelemetry’s semantic convention whenever possible.

Exhaustiveness

The module doesn’t cover the entirety of OpenTelemetry’s semantic convention specification.
Feel free to open a PR if you need a stable field that isn’t currently covered!

Constants

• ERROR_DETAILS
  The field name to record the Debug representation of an error.
  This field doesn’t appear in OpenTelemetry’s semantic convention specification.
• ERROR_MESSAGE
  The field name to record the Display representation of an error.
  This field doesn’t appear in OpenTelemetry’s semantic convention specification.
• ERROR_SOURCE_CHAIN
  The field name to record the chain of sources for an error.
  This field doesn’t appear in OpenTelemetry’s semantic convention specification.
• HTTP_REQUEST_METHOD
  The field name for the HTTP method of the incoming request (if canonical), according to OpenTelemetry’s semantic convention.
• HTTP_REQUEST_SERVER_ID
  The field name to record the server-generated identifier for this request.
  This field doesn’t appear in OpenTelemetry’s semantic convention specification.
• HTTP_RESPONSE_STATUS_CODE
  The field name for the HTTP status code of the outgoing response, according to OpenTelemetry’s semantic convention.
• HTTP_ROUTE
  The field name for path pattern matched by the incoming request, according to OpenTelemetry’s semantic convention.
• NETWORK_PROTOCOL_NAME
  The name of the network protocol used by the incoming request, according to OpenTelemetry’s semantic convention.
• NETWORK_PROTOCOL_VERSION
  The version of the network protocol used by the incoming request, according to OpenTelemetry’s semantic convention.
• URL_PATH
  The path targeted by the incoming request, according to OpenTelemetry’s semantic convention.
• URL_QUERY
  The query string of the incoming request, according to OpenTelemetry’s semantic convention.
• USER_AGENT_ORIGINAL
  The user agent header for the incoming request, according to OpenTelemetry’s semantic convention.

Functions

• error_details
  The canonical representation for the value in ERROR_DETAILS.
• error_message
  The canonical representation for the value in ERROR_MESSAGE.
• error_source_chain
  The canonical representation for the value in ERROR_SOURCE_CHAIN.
• http_request_method
  The canonical representation for the value in HTTP_REQUEST_METHOD.
• http_request_server_id
  The canonical representation for the value in HTTP_REQUEST_SERVER_ID.
• http_response_status_code
  The canonical representation for the value in HTTP_RESPONSE_STATUS_CODE.
• http_route
  The canonical representation for the value in HTTP_ROUTE.
• network_protocol_name
  The canonical representation for the value in NETWORK_PROTOCOL_NAME.
• network_protocol_version
  The canonical representation for the value in NETWORK_PROTOCOL_VERSION.
• url_path
  The canonical representation for the value in URL_PATH.
• url_query
  The canonical representation for the value in URL_QUERY.
• user_agent_original
  The canonical representation for the value in USER_AGENT_ORIGINAL.