Skip to content

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.

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 3 commits into from
May 23, 2025
Merged

docs(javascript): Add docs for GraphQL Client #13801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b42fbe
docs(javascript): Add docs for GraphQL Client
s1gr1d May 22, 2025
88c4bf5
review suggestions
s1gr1d May 22, 2025
dbe817f
add tables
s1gr1d May 23, 2025
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
63 changes: 63 additions & 0 deletions docs/platforms/javascript/common/configuration/integrations/graphqlclient.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: GraphQLClient
description: "Enhance spans and breadcrumbs with data from GraphQL requests."
notSupported:
- 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.

3 changes: 2 additions & 1 deletion platform-includes/configuration/integrations/javascript.astro.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Depending on whether an integration enhances the functionality of a particular r
### Browser Integrations

| | **Auto Enabled** | **Errors** | **Tracing** | **Replay** | **Additional Context** |
| ----------------------------------------------------- | :--------------: | :--------: | :---------: | :--------: | :--------------------: |
|-------------------------------------------------------|:----------------:|:----------:|:-----------:|:----------:|:----------------------:|
| [`breadcrumbsIntegration`](./breadcrumbs) | ✓ | | | | ✓ |
| [`browserApiErrorsIntegration`](./browserapierrors) | ✓ | ✓ | | | |
| [`browserSessionIntegration`](./browsersession) | ✓ | | | | ✓ |
Expand All @@ -32,6 +32,7 @@ Depending on whether an integration enhances the functionality of a particular r
| [`browserProfilingIntegration`](./browserprofiling) | | | ✓ | | |
| [`contextLinesIntegration`](./contextlines) | | ✓ | | | |
| [`featureFlagsIntegration`](./featureflags) | | | | | ✓ |
| [`graphqlClientIntegration`](./graphqlclient) | | | | | ✓ |
| [`httpClientIntegration`](./httpclient) | | ✓ | | | |
| [`launchDarklyIntegration`](./launchdarkly) | | | | | ✓ |
| [`moduleMetadataIntegration`](./modulemetadata) | | | | | ✓ |
Expand Down
3 changes: 2 additions & 1 deletion platform-includes/configuration/integrations/javascript.capacitor.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### Integrations

| | **Auto Enabled** | **Errors** | **Tracing** | **Replay** | **Additional Context** |
| ----------------------------------------------------- | :--------------: | :--------: | :---------: | :--------: | :--------------------: |
|-------------------------------------------------------|:----------------:|:----------:|:-----------:|:----------:|:----------------------:|
| [`breadcrumbsIntegration`](./breadcrumbs) | ✓ | | | | ✓ |
| [`browserApiErrorsIntegration`](./browserapierrors) | ✓ | ✓ | | | |
| [`dedupeIntegration`](./dedupe) | ✓ | ✓ | | | |
Expand All @@ -15,6 +15,7 @@
| [`captureConsoleIntegration`](./captureconsole) | | | | | ✓ |
| [`contextLinesIntegration`](./contextlines) | | ✓ | | | |
| [`extraErrorDataIntegration`](./extraerrordata) | | | | | ✓ |
| [`graphqlClientIntegration`](./graphqlclient) | | | | | ✓ |
| [`httpClientIntegration`](./httpclient) | | ✓ | | | |
| [`moduleMetadataIntegration`](./modulemetadata) | | | | | ✓ |
| [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | | |
Expand Down
3 changes: 2 additions & 1 deletion platform-includes/configuration/integrations/javascript.cordova.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### Integrations

| | **Auto Enabled** | **Errors** | **Tracing** | **Replay** | **Additional Context** |
| ----------------------------------------------------- | :--------------: | :--------: | :---------: | :--------: | :--------------------: |
|-------------------------------------------------------|:----------------:|:----------:|:-----------:|:----------:|:----------------------:|
| [`breadcrumbsIntegration`](./breadcrumbs) | ✓ | | | | ✓ |
| [`browserApiErrorsIntegration`](./browserapierrors) | ✓ | ✓ | | | |
| [`dedupeIntegration`](./dedupe) | ✓ | ✓ | | | |
Expand All @@ -12,6 +12,7 @@
| [`linkedErrorsIntegration`](./linkederrors) | ✓ | ✓ | | | |
| [`captureConsoleIntegration`](./captureconsole) | | | | | ✓ |
| [`extraErrorDataIntegration`](./extraerrordata) | | | | | ✓ |
| [`graphqlClientIntegration`](./graphqlclient) | | | | | ✓ |
| [`httpClientIntegration`](./httpclient) | | ✓ | | | |
| [`moduleMetadataIntegration`](./modulemetadata) | | | | | ✓ |
| [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | | |
Expand Down
5 changes: 3 additions & 2 deletions platform-includes/configuration/integrations/javascript.gatsby.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### Integrations

| | **Auto Enabled** | **Errors** | **Tracing** | **Replay** | **Additional Context** |
| ----------------------------------------------------- | :--------------: | :--------: | :---------: | :--------: | :--------------------: |
|-------------------------------------------------------|:----------------:|:----------:|:-----------:|:----------:|:----------------------:|
| [`breadcrumbsIntegration`](./breadcrumbs) | ✓ | | | | ✓ |
| [`browserApiErrorsIntegration`](./browserapierrors) | ✓ | ✓ | | | |
| [`dedupeIntegration`](./dedupe) | ✓ | ✓ | | | |
Expand All @@ -16,10 +16,11 @@
| [`captureConsoleIntegration`](./captureconsole) | | | | | ✓ |
| [`contextLinesIntegration`](./contextlines) | | ✓ | | | |
| [`extraErrorDataIntegration`](./extraerrordata) | | | | | ✓ |
| [`graphqlClientIntegration`](./graphqlclient) | | | | | ✓ |
| [`httpClientIntegration`](./httpclient) | | ✓ | | | |
| [`moduleMetadataIntegration`](./modulemetadata) | | | | | ✓ |
| [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | | |
| [`replayIntegration`](./replay) | | | | ✓ | ✓ |
| [`replayCanvasIntegration`](./replaycanvas) | | | | ✓ | |
| [`reportingObserverIntegration`](./reportingobserver) | | ✓ | | | |
| [`supabaseIntegration`](./supabase) | | ✓ | ✓ | | |
| [`supabaseIntegration`](./supabase) | | ✓ | ✓ | | |
5 changes: 3 additions & 2 deletions platform-includes/configuration/integrations/javascript.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### Integrations

| | **Auto Enabled** | **Errors** | **Tracing** | **Replay** | **Additional Context** |
| ----------------------------------------------------- | :--------------: | :--------: | :---------: | :--------: | :--------------------: |
|-------------------------------------------------------|:----------------:|:----------:|:-----------:|:----------:|:----------------------:|
| [`breadcrumbsIntegration`](./breadcrumbs) | ✓ | | | | ✓ |
| [`browserApiErrorsIntegration`](./browserapierrors) | ✓ | ✓ | | | |
| [`browserSessionIntegration`](./browsersession) | ✓ | | | | ✓ |
Expand All @@ -17,6 +17,7 @@
| [`contextLinesIntegration`](./contextlines) | | ✓ | | | |
| [`extraErrorDataIntegration`](./extraerrordata) | | | | | ✓ |
| [`featureFlagsIntegration`](./featureflags) | | | | | ✓ |
| [`graphqlClientIntegration`](./graphqlclient) | | | | | ✓ |
| [`httpClientIntegration`](./httpclient) | | ✓ | | | |
| [`launchDarklyIntegration`](./launchdarkly) | | | | | ✓ |
| [`moduleMetadataIntegration`](./modulemetadata) | | | | | ✓ |
Expand All @@ -26,5 +27,5 @@
| [`reportingObserverIntegration`](./reportingobserver) | | ✓ | | | |
| [`rewriteFramesIntegration`](./rewriteframes) | | ✓ | | | |
| [`statsigIntegration`](./statsig) | | | | | ✓ |
| [`supabaseIntegration`](./supabase) | | ✓ | ✓ | | |
| [`supabaseIntegration`](./supabase) | | ✓ | ✓ | | |
| [`unleashIntegration`](./unleash) | | | | | ✓ |
3 changes: 2 additions & 1 deletion platform-includes/configuration/integrations/javascript.nextjs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Depending on whether an integration enhances the functionality of a particular r
### Browser Integrations

| | **Auto Enabled** | **Errors** | **Tracing** | **Replay** | **Additional Context** |
| ----------------------------------------------------- | :--------------: | :--------: | :---------: | :--------: | :--------------------: |
|-------------------------------------------------------|:----------------:|:----------:|:-----------:|:----------:|:----------------------:|
| [`breadcrumbsIntegration`](./breadcrumbs) | ✓ | | | | ✓ |
| [`browserApiErrorsIntegration`](./browserapierrors) | ✓ | ✓ | | | |
| [`browserSessionIntegration`](./browsersession) | ✓ | | | | ✓ |
Expand All @@ -32,6 +32,7 @@ Depending on whether an integration enhances the functionality of a particular r
| [`browserProfilingIntegration`](./browserprofiling) | | | ✓ | | |
| [`contextLinesIntegration`](./contextlines) | | ✓ | | | |
| [`featureFlagsIntegration`](./featureflags) | | | | | ✓ |
| [`graphqlClientIntegration`](./graphqlclient) | | | | | ✓ |
| [`httpClientIntegration`](./httpclient) | | ✓ | | | |
| [`launchDarklyIntegration`](./launchdarkly) | | | | | ✓ |
| [`moduleMetadataIntegration`](./modulemetadata) | | | | | ✓ |
Expand Down
3 changes: 2 additions & 1 deletion platform-includes/configuration/integrations/javascript.nuxt.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Depending on whether an integration enhances the functionality of a particular r
### Browser Integrations

| | **Auto Enabled** | **Errors** | **Tracing** | **Replay** | **Additional Context** |
| ----------------------------------------------------- | :--------------: | :--------: | :---------: | :--------: | :--------------------: |
|-------------------------------------------------------|:----------------:|:----------:|:-----------:|:----------:|:----------------------:|
| [`breadcrumbsIntegration`](./breadcrumbs) | ✓ | | | | ✓ |
| [`browserApiErrorsIntegration`](./browserapierrors) | ✓ | ✓ | | | |
| [`browserSessionIntegration`](./browsersession) | ✓ | | | | ✓ |
Expand All @@ -31,6 +31,7 @@ Depending on whether an integration enhances the functionality of a particular r
| [`browserProfilingIntegration`](./browserprofiling) | | | ✓ | | |
| [`contextLinesIntegration`](./contextlines) | | ✓ | | | |
| [`featureFlagsIntegration`](./featureflags) | | | | | ✓ |
| [`graphqlClientIntegration`](./graphqlclient) | | | | | ✓ |
| [`httpClientIntegration`](./httpclient) | | ✓ | | | |
| [`launchDarklyIntegration`](./launchdarkly) | | | | | ✓ |
| [`moduleMetadataIntegration`](./modulemetadata) | | | | | ✓ |
Expand Down
3 changes: 2 additions & 1 deletion platform-includes/configuration/integrations/javascript.remix.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Depending on whether an integration enhances the functionality of a particular r
### Browser Integrations

| | **Auto Enabled** | **Errors** | **Tracing** | **Replay** | **Additional Context** |
| ----------------------------------------------------- | :--------------: | :--------: | :---------: | :--------: | :--------------------: |
|-------------------------------------------------------|:----------------:|:----------:|:-----------:|:----------:|:----------------------:|
| [`breadcrumbsIntegration`](./breadcrumbs) | ✓ | | | | ✓ |
| [`browserApiErrorsIntegration`](./browserapierrors) | ✓ | ✓ | | | |
| [`browserSessionIntegration`](./browsersession) | ✓ | | | | ✓ |
Expand All @@ -31,6 +31,7 @@ Depending on whether an integration enhances the functionality of a particular r
| [`browserProfilingIntegration`](./browserprofiling) | | | ✓ | | |
| [`contextLinesIntegration`](./contextlines) | | ✓ | | | |
| [`featureFlagsIntegration`](./featureflags) | | | | | ✓ |
| [`graphqlClientIntegration`](./graphqlclient) | | | | | ✓ |
| [`httpClientIntegration`](./httpclient) | | ✓ | | | |
| [`launchDarklyIntegration`](./launchdarkly) | | | | | ✓ |
| [`moduleMetadataIntegration`](./modulemetadata) | | | | | ✓ |
Expand Down
Loading