API Reference: Schema reporting plugin

Using the plugin

This API reference documents the ApolloServerPluginSchemaReporting plugin.

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.

Schema reporting does not currently support graphs that use Apollo Federation. This plugin will not work if your graph is a federated subgraph or a composed federated graph running in a gateway. If you have a federated graph, you will need to register schema via the CLI; see Setting up managed federation.

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 with new ApolloServer({apollo: {key: KEY}}). (This is the same way you configure your ApolloServer to enable usage reporting.)

If you just 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 environment variables), import ApolloServerPluginSchemaReporting from the apollo-server-core package and pass it to your ApolloServer in the plugins array:

1import { ApolloServer } from "apollo-server";
2import { ApolloServerPluginSchemaReporting } from "apollo-server-core";
3
4const server = new ApolloServer({
5  typeDefs,
6  resolvers,
7  plugins: [
8    ApolloServerPluginSchemaReporting(),
9  ],
10});

This plugin was introduced in Apollo Server 2.18. In previous versions, schema reporting was configured using the engine option to the ApolloServer constructor. That option continues to work; see the migration guide for details.

Options

initialDelayMaxMs

number

The schema reporter waits before starting reporting. By default, the report waits some random amount of time between 0 and 10 seconds. A longer interval leads to more staggered starts which means it is less likely multiple servers will get asked to upload the same schema.

If this server runs in lambda or in other constrained environments it would be useful to decrease the schema reporting max wait time to be less than default.

This number will be the max for the range in ms that the schema reporter will wait before starting to report.

overrideReportedSchema

string

Override the reported schema that is reported to the Apollo registry. This schema does not go through any normalizations and the string is directly sent to the Apollo registry. This can be useful for comments or other ordering and whitespace changes that get stripped when generating a GraphQLSchema.

If you pass this option to this plugin, you should explicitly configure ApolloServerPluginUsageReporting and pass the same value to its overrideReportedSchema option. This ensures that the schema ID associated with requests reported by the usage reporting plugin matches the schema ID that this plugin reports. For example:

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

endpointUrl

string

The URL to use for reporting schemas. Primarily for testing and internal Apollo use.

fetcher

typeof fetch

Specifies which Fetch API function implementation to use when reporting schemas.