GraphQL

Enhance spans and breadcrumbs with data from GraphQL requests in React Native.

(Available in version 7.5.0 and above)

Import name: Sentry.graphqlClientIntegration

The graphqlClientIntegration enhances the data captured from GraphQL requests in your React Native 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
Copied
import * as Sentry from "@sentry/react-native";

Sentry.init({
  dsn: "___PUBLIC_DSN___",
  integrations: [
    Sentry.graphqlClientIntegration({
      endpoints: ["https://graphql-api.example.com", /\/graphql$/],
    }),
  ],
});

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.

To match all endpoints, set the endpoints option to [/.*/].

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").