semantic-conventions/docs/attributes-registry/graphql.md

2.0 KiB

GraphQL

Graphql Attributes

This document defines attributes for GraphQL.

Attribute Type Description Examples Stability
graphql.document string The GraphQL document being executed. [1] query findBookById { bookById(id: ?) { name } } Experimental
graphql.operation.name string The name of the operation being executed. findBookById Experimental
graphql.operation.type string The type of the operation being executed. query; mutation; subscription Experimental

[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 Experimental
mutation GraphQL mutation Experimental
subscription GraphQL subscription Experimental