Built-In Plugins

OSZAR »
"]}],[0,{"type":[0,"mdxJsxFlowElement"],"name":[0,"CodeBlockHTML"],"attributes":[1,[]],"children":[1,[]],"data":[0,{"props":[0,{"json":[0,{"tabs":[1,[[0,{"lang":[0,"ts"],"disableCopy":[0,false],"showLineNumbers":[0,true],"code":[0,"import { ApolloServer } from \"@apollo/server\";\nimport { ApolloServerPluginUsageReporting } from '@apollo/server/plugin/usageReporting';\n\nconst server = new ApolloServer({\n typeDefs,\n resolvers,\n plugins: [\n // Sets a non-default option on the usage reporting plugin\n ApolloServerPluginUsageReporting({\n sendVariableValues: { all: true },\n }),\n ],\n});"],"hast":[0,{"type":[0,"root"],"children":[1,[[0,{"type":[0,"element"],"tagName":[0,"pre"],"properties":[0,{"class":[1,[[0,"shiki"],[0,"shiki-themes"],[0,"github-light-default"],[0,"houston"],[0,"p-4"],[0,"rounded-b-md"],[0,"max-w-96"]]],"style":[0,"background-color:#F2F4F4;--shiki-dark-bg:#0D171C;color:#546461;--shiki-dark:#B4C0BE; font-variant-ligatures: none;"],"tabindex":[0,"0"]}],"children":[1,[[0,{"type":[0,"element"],"tagName":[0,"code"],"properties":[0,{}],"children":[1,[[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"class":[0,"line"]}],"children":[1,[[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"className":[1,[[0,"select-none inline-block text-right w-8 mr-4"]]]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"1"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#005AAF;--shiki-dark:#5C95B2"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"import"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," { "]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#7DC0FF"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"ApolloServer"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," } "]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#005AAF;--shiki-dark:#5C95B2"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"from"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#7D6800;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," \"@apollo/server\""]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,";"]}]]]}]]]}],[0,{"type":[0,"text"],"value":[0,"\n"]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"class":[0,"line"]}],"children":[1,[[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"className":[1,[[0,"select-none inline-block text-right w-8 mr-4"]]]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"2"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#005AAF;--shiki-dark:#5C95B2"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"import"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," { "]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#7DC0FF"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"ApolloServerPluginUsageReporting"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," } "]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#005AAF;--shiki-dark:#5C95B2"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"from"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#7D6800;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," '@apollo/server/plugin/usageReporting'"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,";"]}]]]}]]]}],[0,{"type":[0,"text"],"value":[0,"\n"]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"class":[0,"line"]}],"children":[1,[[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"className":[1,[[0,"select-none inline-block text-right w-8 mr-4"]]]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"3"]}]]]}]]]}],[0,{"type":[0,"text"],"value":[0,"\n"]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"class":[0,"line"]}],"children":[1,[[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"className":[1,[[0,"select-none inline-block text-right w-8 mr-4"]]]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"4"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#005AAF;--shiki-dark:#5C95B2"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"const"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#365E72;--shiki-dark:#ACAFFF"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," server"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#005AAF;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," ="]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#005AAF;--shiki-dark:#5C95B2"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," new"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#7B00C7;--shiki-dark:#00FAB3"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," ApolloServer"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"({"]}]]]}]]]}],[0,{"type":[0,"text"],"value":[0,"\n"]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"class":[0,"line"]}],"children":[1,[[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"className":[1,[[0,"select-none inline-block text-right w-8 mr-4"]]]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"5"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#7DC0FF"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," typeDefs"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,","]}]]]}]]]}],[0,{"type":[0,"text"],"value":[0,"\n"]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"class":[0,"line"]}],"children":[1,[[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"className":[1,[[0,"select-none inline-block text-right w-8 mr-4"]]]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"6"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#7DC0FF"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," resolvers"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,","]}]]]}]]]}],[0,{"type":[0,"text"],"value":[0,"\n"]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"class":[0,"line"]}],"children":[1,[[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"className":[1,[[0,"select-none inline-block text-right w-8 mr-4"]]]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"7"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#7DC0FF"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," plugins"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,": ["]}]]]}]]]}],[0,{"type":[0,"text"],"value":[0,"\n"]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"class":[0,"line"]}],"children":[1,[[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"className":[1,[[0,"select-none inline-block text-right w-8 mr-4"]]]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"8"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#6E7781;font-style:inherit;--shiki-dark:#EEF0F98F;--shiki-dark-font-style:italic"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," // Sets a non-default option on the usage reporting plugin"]}]]]}]]]}],[0,{"type":[0,"text"],"value":[0,"\n"]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"class":[0,"line"]}],"children":[1,[[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"className":[1,[[0,"select-none inline-block text-right w-8 mr-4"]]]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"9"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#7B00C7;--shiki-dark:#00FAB3"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," ApolloServerPluginUsageReporting"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"({"]}]]]}]]]}],[0,{"type":[0,"text"],"value":[0,"\n"]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"class":[0,"line"]}],"children":[1,[[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"className":[1,[[0,"select-none inline-block text-right w-8 mr-4"]]]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"10"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#7DC0FF"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," sendVariableValues"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,": { "]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#7DC0FF"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"all"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,": "]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#365E72;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"true"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," },"]}]]]}]]]}],[0,{"type":[0,"text"],"value":[0,"\n"]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"class":[0,"line"]}],"children":[1,[[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"className":[1,[[0,"select-none inline-block text-right w-8 mr-4"]]]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"11"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," }),"]}]]]}]]]}],[0,{"type":[0,"text"],"value":[0,"\n"]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"class":[0,"line"]}],"children":[1,[[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"className":[1,[[0,"select-none inline-block text-right w-8 mr-4"]]]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"12"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0," ],"]}]]]}]]]}],[0,{"type":[0,"text"],"value":[0,"\n"]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"class":[0,"line"]}],"children":[1,[[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"className":[1,[[0,"select-none inline-block text-right w-8 mr-4"]]]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"13"]}]]]}],[0,{"type":[0,"element"],"tagName":[0,"span"],"properties":[0,{"style":[0,"color:#546461;--shiki-dark:#B4C0BE"]}],"children":[1,[[0,{"type":[0,"text"],"value":[0,"});"]}]]]}]]]}]]]}]]]}]]]}]}]]]}]}],"majorComponent":[0,true],"divWrap":[0,true]}]}],[0,{"type":[0,"html"],"value":[0,"
OSZAR »
"]}]]]}]}" ssr="" client="load" opts="{"name":"MDXRenderRoot","value":true}" await-children="">

Plugins extend Apollo Server's functionality by performing custom operations in response to certain events. These events correspond to individual phases of the GraphQL request lifecycle, and to the lifecycle of Apollo Server itself.

Certain Apollo Server features are provided as built-in plugins that are exported from within the @apollo/server package. Apollo Server installs certain plugins automatically, but you can also install them manually to override their default settings. See each plugin's documentation for details.

You can also create custom plugins.

List of built-in plugins

NameDescriptionLocation
Usage reportingGathers helpful operation usage data and reports it to GraphOS for visualization, alerting, and more.@apollo/server/plugin/usageReporting
Schema reportingAutomatically reports the server's schema to GraphOS on startup to enable schema history and up-to-date metrics.@apollo/server/plugin/schemaReporting
Inline traceUsed primarily by federated subgraphs to include operation trace data in responses to the gateway.@apollo/server/plugin/inlineTrace
Cache controlCalculates caching behavior for operation responses.@apollo/server/plugin/cacheControl
Landing page (multiple)Handle displaying a default or custom landing page at Apollo Server's base URL.@apollo/server/plugin/landingPage/default
Draining an HTTP serverUsed to ensure your Node.js servers gracefully shut down.@apollo/server/plugin/drainHttpServer
Enable federated subscriptionsEnables your server to handle federated subscription requests from Apollo Router via the callback protocol.@apollo/server/plugin/subscriptionCallback

Installing plugins

You can install a plugin that isn't installed by default (or customize a default plugin) by providing a plugins configuration option to the ApolloServer constructor, like so:

TypeScript
1import { ApolloServer } from "@apollo/server";
2import { ApolloServerPluginUsageReporting } from '@apollo/server/plugin/usageReporting';
3
4const server = new ApolloServer({
5  typeDefs,
6  resolvers,
7  plugins: [
8    // Sets a non-default option on the usage reporting plugin
9    ApolloServerPluginUsageReporting({
10      sendVariableValues: { all: true },
11    }),
12  ],
13});
OSZAR »