OpenTelemetry standard attributes

OpenTelemetry semantic conventions define a set of standard attributes that can be attached to spans, instruments and events. These attributes are used to filter and group data in your application performance monitor (APM).

The attributes available depend on the service of the router pipeline.

For example, set the standard attribute http.response.status_code on the router span:

1telemetry:
2  instrumentation:
3    spans:
4      router:
5        attributes:
6          # Standard attributes
7          http.response.status_code: true

Alias

If you don't want to use the standard name you can still create an alias and use that alias for the name, for example:

1telemetry:
2  instrumentation:
3    spans:
4      router:
5        attributes:
6          # Standard attributes
7          http.response.status_code:
8            alias: status_code # It will be named status_code instead of http.response.status_code

Attribute configuration reference

A router's request lifecycle has three major services:

• Router service - Handles an incoming request before it is parsed. Works within a context of opaque bytes.

• Supergraph service - Handles a request after it has been parsed and before it is sent to the subgraph. Works within a GraphQL context.

• Subgraph service - Handles a request after it has been sent to the subgraph. Works within a GraphQL context.

Each service supports a unique set of standard attributes.

Router

Standard attributes of the router service:

1telemetry:
2  instrumentation:
3    spans:
4      router:
5        attributes:
6          "http.request.header.x-my-header":
7            request_header: "x-my-header"

Supergraph

Standard attributes of the supergraph service:

Subgraph

Standard attributes of the subgraph service: