API Reference: Schema reporting plugin

Using the plugin

This article documents the options for the ApolloServerPluginSchemaReporting plugin, which you can import from @apollo/server/plugin/schemaReporting.

This plugin enables your GraphQL server to register its latest schema with the Apollo schema registry every time it starts up. Full details on schema reporting can be found in the Apollo Studio docs.

In order to use this plugin, you must configure your server with a graph API key, either with the APOLLO_KEY environment variable or by passing it directly to your ApolloServer constructor (e.g., new ApolloServer({apollo: {key: KEY}})). This is the same way you configure usage reporting.

You must explicitly enable schema reporting. If you want to turn on schema reporting with its default configuration, you can set the APOLLO_SCHEMA_REPORTING environment variable to true.

If you want to configure schema reporting (or prefer your setup to be via code rather than using environment variables), import the ApolloServerPluginSchemaReporting plugin and pass it to the ApolloServer constructor:

1
import { ApolloServer } from '@apollo/server';
2
import { ApolloServerPluginSchemaReporting } from '@apollo/server/plugin/schemaReporting';
3

4
const server = new ApolloServer({
5
  typeDefs,
6
  resolvers,
7
  plugins: [ApolloServerPluginSchemaReporting()],
8
});

1
import { ApolloServer } from '@apollo/server';
2
import { ApolloServerPluginSchemaReporting } from '@apollo/server/plugin/schemaReporting';
3

4
const server = new ApolloServer({
5
  typeDefs,
6
  resolvers,
7
  plugins: [ApolloServerPluginSchemaReporting()],
8
});

Options

1
new ApolloServer({
2
  plugins: [
3
    ApolloServerPluginSchemaReporting({
4
      overrideReportedSchema: schema
5
    }),
6
    ApolloServerPluginUsageReporting({
7
      overrideReportedSchema: schema
8
    }),
9
  ],
10
  // ...
11
})

Disabling the plugin

The schema reporting plugin is only automatically installed if the APOLLO_SCHEMA_REPORTING is set to true, so the easiest way to disable the plugin is to avoid setting that environment variable (and to not explicitly install ApolloServerPluginSchemaReporting). However, if you'd like to ensure that the schema reporting plugin is not installed in your server (perhaps for a test that might run with arbitrary environment variables set), you can disable schema reporting by installing the ApolloServerPluginSchemaReportingDisabled plugin, like so:

1
import { ApolloServer } from '@apollo/server';
2
import { ApolloServerPluginSchemaReportingDisabled } from '@apollo/server/plugin/disabled';
3

4
const server = new ApolloServer({
5
  typeDefs,
6
  resolvers,
7
  plugins: [ApolloServerPluginSchemaReportingDisabled()],
8
});

1
import { ApolloServer } from '@apollo/server';
2
import { ApolloServerPluginSchemaReportingDisabled } from '@apollo/server/plugin/disabled';
3

4
const server = new ApolloServer({
5
  typeDefs,
6
  resolvers,
7
  plugins: [ApolloServerPluginSchemaReportingDisabled()],
8
});