50 lines
2.6 KiB
Markdown
50 lines
2.6 KiB
Markdown
<!--- Hugo front matter used to generate the website version of this page:
|
|
linkTitle: GraphQL Server
|
|
--->
|
|
|
|
# Semantic Conventions for GraphQL Server
|
|
|
|
**Status**: [Experimental][DocumentStatus]
|
|
|
|
This document defines semantic conventions to apply when instrumenting the GraphQL implementation. They map GraphQL
|
|
operations to attributes on a Span.
|
|
|
|
The **span name** MUST be of the format `<graphql.operation.type> <graphql.operation.name>` provided that
|
|
`graphql.operation.type` and `graphql.operation.name` are available. If `graphql.operation.name` is not available, the
|
|
span SHOULD be named `<graphql.operation.type>`. When `<graphql.operation.type>` is not available, `GraphQL Operation`
|
|
MAY be used as span name.
|
|
|
|
<!-- semconv graphql(full) -->
|
|
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
|
<!-- see templates/registry/markdown/snippet.md.j2 -->
|
|
<!-- prettier-ignore-start -->
|
|
<!-- markdownlint-capture -->
|
|
<!-- markdownlint-disable -->
|
|
|
|
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
|
|---|---|---|---|---|---|
|
|
| [`graphql.document`](/docs/attributes-registry/graphql.md) | string | The GraphQL document being executed. [1] | `query findBookById { bookById(id: ?) { name } }` | `Recommended` |  |
|
|
| [`graphql.operation.name`](/docs/attributes-registry/graphql.md) | string | The name of the operation being executed. | `findBookById` | `Recommended` |  |
|
|
| [`graphql.operation.type`](/docs/attributes-registry/graphql.md) | string | The type of the operation being executed. | `query`; `mutation`; `subscription` | `Recommended` |  |
|
|
|
|
**[1]:** The value may be sanitized to exclude sensitive information.
|
|
|
|
|
|
|
|
`graphql.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
|
|
|
|
| Value | Description | Stability |
|
|
|---|---|---|
|
|
| `query` | GraphQL query |  |
|
|
| `mutation` | GraphQL mutation |  |
|
|
| `subscription` | GraphQL subscription |  |
|
|
|
|
|
|
|
|
<!-- markdownlint-restore -->
|
|
<!-- prettier-ignore-end -->
|
|
<!-- END AUTOGENERATED TEXT -->
|
|
<!-- endsemconv -->
|
|
|
|
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.33.0/specification/document-status.md
|