Documentation navigation

Apollo Server

The AppSignal for Node.js integration for Apollo GraphQL (apollo-server) v2.0.0+.

Installation

Add both the @appsignal/nodejs and @appsignal/apollo-server packages to your package.json. Then, run yarn install/npm install.

You can also add these packages to your package.json on the command line:

1
2
yarn add @appsignal/nodejs @appsignal/apollo-server
npm install --save @appsignal/nodejs @appsignal/apollo-server

You can then import and use the package in your app.

Usage

The module includes an Apollo Server plugin for automatically instrumenting the resolvers of your application.

To use the Apollo Server plugin, require it from the @appsignal/apollo-server package, and pass it in the plugins property when initialising ApolloServer, with an Appsignal instance as an argument:

1
2
3
4
5
6
const { createApolloPlugin } = require("@appsignal/apollo-server");

const server = new ApolloServer({
  /* ... */
  plugins: [createApolloPlugin(appsignal)],
});

NOTE: In order for a GraphQL query to have its own entry in the Performance view of AppSignal.com, you must give it a name. For example, the named query query AllBooks { books } will show up in the performance view as an entry named AllBooks, but the unnamed query { books } will be grouped together with all other unnamed queries, showing up in the performance view as a single entry named [unknown graphql query].

Full example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
// ENSURE APPSIGNAL IS THE FIRST THING TO BE REQUIRED/IMPORTED
// INTO YOUR APP!
const { Appsignal } = require("@appsignal/nodejs");
const { createApolloPlugin } = require("@appsignal/apollo-server");

// You can also use one of the apollo-server integrations here,
// e.g. `apollo-server-<integration>`. Note that you will also need to require
// the AppSignal integration for it separately.
const { ApolloServer } = require("apollo-server");

const appsignal = new Appsignal({
  active: true,
  name: "<YOUR APPLICATION NAME>",
  pushApiKey: "<YOUR API KEY>", // Note: renamed from `apiKey` in version 2.2.5
});

// The GraphQL schema
const typeDefs = gql`
  type Query {
    "A simple type for getting started!"
    hello: String
  }
`;

// A map of functions which return data for the schema.
const resolvers = {
  Query: {
    hello: () => "world",
  },
};

const server = new ApolloServer({
  typeDefs,
  resolvers,
  plugins: [createApolloPlugin(appsignal)],
});

server.listen().then(({ url }) => {
  console.log(`🚀 Server ready at ${url}`);
});

Features

The integration will send the following instrumentation data to AppSignal:

  • ✅ Query duration
  • ✅ GraphQL query bodies
  • ✅ Errors

We'd like to set cookies, read why.