From 40fcd3d1a0b5f0d9887c6c2e2f731a90eebfa238 Mon Sep 17 00:00:00 2001 From: David Glasser Date: Mon, 31 Oct 2022 15:10:22 -0700 Subject: [PATCH] Backport #7107 (docs: document new usage reporting option) --- docs/source/api/plugin/usage-reporting.md | 16 ++++++++++++++++ .../src/plugin/usageReporting/options.ts | 6 +++--- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/docs/source/api/plugin/usage-reporting.md b/docs/source/api/plugin/usage-reporting.md index 42d3a63eaea..d817d5a4897 100644 --- a/docs/source/api/plugin/usage-reporting.md +++ b/docs/source/api/plugin/usage-reporting.md @@ -346,6 +346,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/apollo-server-core/src/plugin/usageReporting/options.ts b/packages/apollo-server-core/src/plugin/usageReporting/options.ts index b2af01c3086..07e662f9be8 100644 --- a/packages/apollo-server-core/src/plugin/usageReporting/options.ts +++ b/packages/apollo-server-core/src/plugin/usageReporting/options.ts @@ -259,9 +259,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; /**