Backport #7107 (docs: document new usage reporting option)

apollographql · Oct 31, 2022 · 40fcd3d · 40fcd3d
1 parent f519e1d
commit 40fcd3d
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git 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`.
 <tr>
 <td>
 
+###### `requestTimeoutMs`
+
+`number`
+</td>
+<td>
+
+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).
+</td>
+</tr>
+
+<tr>
+<td>
+
 ###### `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
@@ -259,9 +259,9 @@ export interface ApolloServerPluginUsageReportingOptions<TContext> {
    */
   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;
   /**