Graphql Attributes

3 attributes in this category.3 stable

Scrubbing Visibility OTel

3 attributes

Stable Attributes

`graphql.document`

stringScrub: AutoVisibility: PublicOTel: True

The GraphQL document being executed.

Scrubbing ReasonThe document may contain sensitive information in arguments or variables. Instrumentation should redact sensitive information when possible.

Examplequery findBookById { bookById(id: ?) { name } }

Changelog

v0.7.0Adds the `graphql.document` attribute to track the GraphQL document being executed.

Raw JSON

{
  "key": "graphql.document",
  "brief": "The GraphQL document being executed.",
  "type": "string",
  "apply_scrubbing": {
    "key": "auto",
    "reason": "The document may contain sensitive information in arguments or variables. Instrumentation should redact sensitive information when possible."
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "query findBookById { bookById(id: ?) { name } }",
  "changelog": [
    {
      "version": "0.7.0",
      "description": "Adds the `graphql.document` attribute to track the GraphQL document being executed."
    }
  ]
}

`graphql.operation.name`

stringScrub: ManualVisibility: PublicOTel: True

The name of the operation being executed.

ExamplefindBookById

Changelog

v0.1.0#127

v0.0.0

Raw JSON

{
  "key": "graphql.operation.name",
  "brief": "The name of the operation being executed.",
  "type": "string",
  "apply_scrubbing": {
    "key": "manual"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "findBookById",
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        127
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}

`graphql.operation.type`

stringScrub: ManualVisibility: PublicOTel: True

The type of the operation being executed.

Examplequery

Changelog

v0.1.0#127

v0.0.0

Raw JSON

{
  "key": "graphql.operation.type",
  "brief": "The type of the operation being executed.",
  "type": "string",
  "apply_scrubbing": {
    "key": "manual"
  },
  "is_in_otel": true,
  "visibility": "public",
  "example": "query",
  "changelog": [
    {
      "version": "0.1.0",
      "prs": [
        127
      ]
    },
    {
      "version": "0.0.0"
    }
  ]
}