From 57012d5d5a1590db3fd6610b0dcd082b4aeab67a Mon Sep 17 00:00:00 2001 From: David Glasser Date: Mon, 31 Oct 2022 15:10:22 -0700 Subject: [PATCH] docs: document new usage reporting option (#7107) Also tweak a comment. --- .changeset/quick-ghosts-reply.md | 2 ++ docs/source/api/plugin/usage-reporting.mdx | 16 ++++++++++++++++ .../server/src/plugin/usageReporting/options.ts | 6 +++--- 3 files changed, 21 insertions(+), 3 deletions(-) create mode 100644 .changeset/quick-ghosts-reply.md diff --git a/.changeset/quick-ghosts-reply.md b/.changeset/quick-ghosts-reply.md new file mode 100644 index 00000000000..a845151cc84 --- /dev/null +++ b/.changeset/quick-ghosts-reply.md @@ -0,0 +1,2 @@ +--- +--- diff --git a/docs/source/api/plugin/usage-reporting.mdx b/docs/source/api/plugin/usage-reporting.mdx index 942670fd0dd..c37416394a8 100644 --- a/docs/source/api/plugin/usage-reporting.mdx +++ b/docs/source/api/plugin/usage-reporting.mdx @@ -332,6 +332,22 @@ The default value is `100`. +###### `requestTimeoutMs` + +`number` + + + +Timeout for each individual attempt to send a report to Apollo. (This is for +each HTTP POST, not for all potential retries.) + +The default value is `30000` (30 seconds). + + + + + + ###### `logger` [`Logger`](https://www.npmjs.com/package/@apollo/utils.logger) diff --git a/packages/server/src/plugin/usageReporting/options.ts b/packages/server/src/plugin/usageReporting/options.ts index 1e76b9e62e6..6936bc505e3 100644 --- a/packages/server/src/plugin/usageReporting/options.ts +++ b/packages/server/src/plugin/usageReporting/options.ts @@ -326,9 +326,9 @@ export interface ApolloServerPluginUsageReportingOptions< */ minimumRetryDelayMs?: number; /** - * Default timeout for each individual attempt to send a report to Apollo. - * (This is for each HTTP POST, not for all potential retries.) Defaults to 30 - * seconds (30000ms). + * Timeout for each individual attempt to send a report to Apollo. (This is + * for each HTTP POST, not for all potential retries.) Defaults to 30 seconds + * (30000ms). */ requestTimeoutMs?: number; /**