Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .chloggen/abernix_graphql-spec-requirements.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Use this changelog template to create an entry for release notes.
#
# If your change doesn't affect end users you should instead start
# your pull request title with [chore] or use the "Skip Changelog" label.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
change_type: enhancement
change_type: breaking

Right? because now it won't be recorded by default anymore.


# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
component: graphql

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: "Change `graphql.document` attribute requirement level from Recommended to Opt-In due to sensitive data, cardinality, and size concerns"

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
# The values here must be integers.
issues: [2985]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext: |
The `graphql.document` attribute contains user-inputted data that is often sensitive,
potentially unbounded in length, and high-cardinality. Moving from Recommended to Opt-In
ensures operators make an informed decision before enabling this attribute.
Also updated the note to use SHOULD for stronger normative language regarding sanitization.
4 changes: 2 additions & 2 deletions docs/graphql/graphql-spans.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ the span SHOULD be named `GraphQL Operation`.

| Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values |
|---|---|---|---|---|---|
| [`graphql.document`](/docs/registry/attributes/graphql.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The GraphQL document being executed. [1] | `query findBookById { bookById(id: ?) { name } }` |
| [`graphql.operation.name`](/docs/registry/attributes/graphql.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The name of the operation being executed. | `findBookById` |
| [`graphql.operation.type`](/docs/registry/attributes/graphql.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The type of the operation being executed. | `query`; `mutation`; `subscription` |
| [`graphql.document`](/docs/registry/attributes/graphql.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | string | The GraphQL document being executed. [1] | `query findBookById { bookById(id: ?) { name } }` |

**[1] `graphql.document`:** The value may be sanitized to exclude sensitive information.
**[1] `graphql.document`:** The value SHOULD be sanitized to exclude sensitive information.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/registry/attributes/graphql.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This document defines attributes for GraphQL.
| <a id="graphql-operation-name" href="#graphql-operation-name">`graphql.operation.name`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | The name of the operation being executed. | `findBookById` |
| <a id="graphql-operation-type" href="#graphql-operation-type">`graphql.operation.type`</a> | ![Development](https://img.shields.io/badge/-development-blue) | string | The type of the operation being executed. | `query`; `mutation`; `subscription` |

**[1] `graphql.document`:** The value may be sanitized to exclude sensitive information.
**[1] `graphql.document`:** The value SHOULD be sanitized to exclude sensitive information.

---

Expand Down
2 changes: 1 addition & 1 deletion model/graphql/registry.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@ groups:
brief: "The GraphQL document being executed."
type: string
stability: development
note: The value may be sanitized to exclude sensitive information.
note: The value SHOULD be sanitized to exclude sensitive information.
examples: 'query findBookById { bookById(id: ?) { name } }'
2 changes: 1 addition & 1 deletion model/graphql/spans.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ groups:
- ref: graphql.operation.type
requirement_level: recommended
- ref: graphql.document
requirement_level: recommended
requirement_level: opt_in
Loading