-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
docs(javascript): Add docs for GraphQL Client #13801
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.
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
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
64 changes: 64 additions & 0 deletions
64
docs/platforms/javascript/common/configuration/integrations/graphqlclient.mdx
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
title: GraphQL Client | ||
description: "Enhance spans and breadcrumbs with data from GraphQL requests." | ||
notSupported: | ||
- javascript.cordova | ||
- javascript.node | ||
- javascript.aws-lambda | ||
- javascript.azure-functions | ||
- javascript.connect | ||
- javascript.express | ||
- javascript.fastify | ||
- javascript.gcp-functions | ||
- javascript.hapi | ||
- javascript.hono | ||
- javascript.koa | ||
- javascript.nestjs | ||
- javascript.deno | ||
- javascript.cloudflare | ||
- javascript.bun | ||
--- | ||
|
||
<Alert> | ||
|
||
This integration only works inside a browser environment. | ||
|
||
</Alert> | ||
|
||
_Import name: `Sentry.graphqlClientIntegration`_ | ||
|
||
This integration enhances the data captured from GraphQL requests in your application. | ||
It extracts GraphQL-specific information from HTTP requests matching your configured endpoints and enriches | ||
both spans and breadcrumbs with GraphQL operation details. | ||
|
||
When enabled, this integration will: | ||
- Update span names with the GraphQL operation type and name | ||
- Add GraphQL query documents to spans | ||
- Add GraphQL operation information to breadcrumbs | ||
|
||
## Options | ||
|
||
### `endpoints` | ||
|
||
_Type: `(string|RegExp)[]`_ | ||
|
||
An array of URLs or URL patterns that should be treated as GraphQL endpoints. | ||
The integration will only process requests to these endpoints. This array can contain strings, regular expressions, or a combination of both. | ||
|
||
Example: | ||
```javascript | ||
Sentry.init({ | ||
integrations: [ | ||
Sentry.graphqlClientIntegration({ | ||
endpoints: [ | ||
'https://graphql-api.example.com', | ||
/\/graphql$/ | ||
] | ||
}) | ||
] | ||
}); | ||
``` | ||
|
||
To **match all** endpoints with the `graphqlClientIntegration`, you would set the endpoints option to `[/.*/]` in your configuration. | ||
This regex pattern will match any URL. | ||
|
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.
Uh oh!
There was an error while loading. Please reload this page.