GraphQLClient

Enhance spans and breadcrumbs with data from GraphQL requests.

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

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:

Copied
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.

Was this helpful?
Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").