adds error events and logs #50
Open
+134
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
PascalSenn
commented
Oct 23, 2025
| requirement_level: required | ||
|
|
||
| - id: graphql.error.path | ||
| type: string[] |
There was a problem hiding this comment.
I just found out that an attribute can be either a string[] or a number[], but not a mix of both (string | number)[]. So we should either use jsonpath or a stringified representation of the path.
PascalSenn
commented
Oct 23, 2025
| stability: development | ||
| brief: > | ||
| The locations in the GraphQL document associated with the error. | ||
| examples: ['[{"line":3,"column":7}]'] |
There was a problem hiding this comment.
Proposition from last working group:
Suggested change
| examples: ['[{"line":3,"column":7}]'] | |
| examples: [['3:7', '5:4']] |
so a simple string[]
PascalSenn
commented
Oct 23, 2025
| integers. If the error happens in an aliased field, the path to the error should use the | ||
| aliased name, since it represents a path in the response, not in the request. | ||
| - id: graphql.error.extensions.code |
There was a problem hiding this comment.
Suggested change
| - id: graphql.error.extensions.code | |
| - id: graphql.error.code |
| brief: > | ||
| This document defines the shared attributes used to | ||
| report GraphQL errors associated with a span or event. | ||
| attributes: |
There was a problem hiding this comment.
Suggestion from the last meeting, the schema coordinate of the field that experienced the error. This allows to easily group errors by field and identify resolver with hight fault rate.
Suggested change
| attributes: | |
| attributes: | |
| - id: graphql.error.schema-coordinate | |
| type: string | |
| stability: development | |
| brief: > | |
| The coordinate of the field in the schema which experienced the error. | |
| examples: ['User.friends', 'Query.me'] | |
| note: > | |
| If an error can be associated to a particular field in the GraphQL schema, it must a schema coordinate in the form of `typeName.fieldName` identifying the field which experienced the error. |
| requirement_level: | ||
| conditionally_required: Must be included when the error can be associated with a particular field in the GraphQL result. | ||
| - ref: graphql.error.extensions.code | ||
| requirement_level: opt_in |
There was a problem hiding this comment.
Suggestion from last meeting.
See coment in registry.yml for more details.
Suggested change
| requirement_level: opt_in | |
| requirement_level: opt_in | |
| - ref: graphql.error.schema-coordinate | |
| requirement_level: opt_in |
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds semantic conventions for GraphQL errors following OpenTelemetry patterns and the GraphQL specification.
Summary
Adds support for reporting GraphQL errors as both span events and log records, following the same pattern as the existing
exceptionsemantic conventions in OpenTelemetry.Changes
Registry (
spec/registry.yaml)registry.graphql.errorwith four attributes:graphql.error.message(required): Error message for developersgraphql.error.locations(conditional): Line/column locations in the GraphQL documentgraphql.error.path(conditional): Path to the response field that experienced the errorgraphql.error.extensions.code(optional): Error categorization codeEvents (
spec/events.yaml)event.graphql.errorfor recording GraphQL errors as span eventsLogs (
spec/logs.yaml)log-graphql.errorfor recording GraphQL errors as log recordsDesign Decisions (Based on WG Meeting Feedback)
Based on the working group discussion, the following decisions were made:
error.extensions.codefield is opt_in for categorizing errors (e.g.,GRAPHQL_VALIDATION_FAILED,UNAUTHENTICATED,FORBIDDEN)