1.1.0

🔥 Initial stable release

This package provides a new link to connect Sentry with Apollo Client, in order to automatically report GraphQL errors to Sentry in a meaningful way.

Usage

Initialize Sentry as you would normally. Then, build the error link with your settings and add it to your Apollo Client's link array:

import { buildSentryErrorLink } from "apollo-sentry-helper";

const sentryErrorLink = buildSentryErrorLink();

const client = new ApolloClient({
  cache: new InMemoryCache(),
  link: ApolloLink.from([
    // Other links here
    sentryErrorLink,
  ]),
});

Options

You can customize what is going to be included in the error report, and which errors should be reported.

const sentryErrorLink = buildSentryErrorLink({
  // Defines if the operation body is going to be included in the error report.
  // Defaults to true.
  includeBody: true,

  // Defines if the response is going to be included in the error report.
  // Defaults to true.
  includeResponse: true,

  // Defines if variables are going to be included in the error report.
  // Defaults to true.
  includeVariables: true,

  // Allows the user to filter errors that should be included in the error report.

  // By default errors will only be reported if there was a network error, or if
  // the operation hasn't returned any data, meaning that the server processed the request,
  // but it was invalid. You can override this behavior by setting the "filter" option.
  filter: (error: ErrorResponse) => boolean,
});