import { H } from '@highlight-run/node'

H.init({
	projectID: '<YOUR_PROJECT_ID>',
	serviceName: '<YOUR_SERVICE_NAME>',
	environment: 'production',
})

Add the Apollo Server integration.

ApolloServerHighlightPlugin is an Apollo Server plugin to capture errors in your graphql handlers.

import { ApolloServer } from '@apollo/server'
import { ApolloServerHighlightPlugin } from '@highlight-run/apollo'
// on legacy Apollo V3, use the following import 
// import { ApolloServerV3HighlightPlugin as ApolloServerHighlightPlugin } from '@highlight-run/apollo'

// ...

const server = new ApolloServer({
  typeDefs,
  resolvers,
  plugins: [
		ApolloServerHighlightPlugin({ projectID: '<YOUR_PROJECT_ID>', serviceName: 'my-apollo-app', serviceVersion: 'git-sha', environment: 'production' }),
	],
})

Optionally, report manual errors in your app.

If you need to report exceptions outside of a handler, use the Highlight SDK.

const parsed = H.parseHeaders(request.headers)
H.consumeError(error, parsed?.secureSessionId, parsed?.requestId)

Verify that your SDK is reporting errors.

You'll want to throw an exception in one of your apollo handlers. Access the API handler and make sure the error shows up in Highlight.

const server = new ApolloServer({
  typeDefs,
  resolvers: {
    Query: {
      books: () => {
        throw new Error('a sample error!');
      },
    },
  },
});

Verify your backend logs are being recorded.

Visit the highlight logs portal and check that backend logs are coming in.

Verify your backend traces are being recorded.

Visit the highlight traces portal and check that backend traces are coming in.

Highlight Integration in Javascript / Typescript AWS Lambda Node.JS Quick Start