Skip to content

feat(graphql): Document useOperationNameForRootSpan #12124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 30, 2024
Merged

feat(graphql): Document useOperationNameForRootSpan #12124

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d4208a
feat(graphql): Document `useOperationNameForRootSpan`
s1gr1d Dec 13, 2024
0efdaff
Update docs/platforms/javascript/common/configuration/integrations/gr…
s1gr1d Dec 20, 2024
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
12 changes: 12 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/graphql.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,15 @@ _Type: `boolean`_
If spans for the execution of the default resolver on object properties should not be created. Default is `true`.

When a resolver function is not defined on the schema for a field, GraphQL will use the default resolver which just looks for a property with that name on the object. If the property is not a function, it's not very interesting to trace. This option can reduce noise and number of spans created.

### `useOperationNameForRootSpan`

_Type: `boolean`_

By default, this option is `true`.

With this setting enabled, the GraphQL instrumentation dynamically updates the name of the `http.server` root span by appending
the operation names. Instead of generic span names like `POST /graphql`, span names will be more descriptive, such as `POST /graphql (query MyQuery)`.
For requests containing multiple operations, the span names will aggregate operation names, for example `POST /graphql (query Query1, query Query2)`

Set the option to `false` to preserve the default `http.server` span name without this additional context.
Loading