Skip to content

Commit 40fcd3d

Browse files
committed
Backport #7107 (docs: document new usage reporting option)
1 parent f519e1d commit 40fcd3d

File tree

2 files changed

+19
-3
lines changed

2 files changed

+19
-3
lines changed

docs/source/api/plugin/usage-reporting.md

+16
Original file line numberDiff line numberDiff line change
@@ -346,6 +346,22 @@ The default value is `100`.
346346
<tr>
347347
<td>
348348

349+
###### `requestTimeoutMs`
350+
351+
`number`
352+
</td>
353+
<td>
354+
355+
Timeout for each individual attempt to send a report to Apollo. (This is for
356+
each HTTP POST, not for all potential retries.)
357+
358+
The default value is `30000` (30 seconds).
359+
</td>
360+
</tr>
361+
362+
<tr>
363+
<td>
364+
349365
###### `logger`
350366

351367
[`Logger`](https://www.npmjs.com/package/@apollo/utils.logger)

packages/apollo-server-core/src/plugin/usageReporting/options.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -259,9 +259,9 @@ export interface ApolloServerPluginUsageReportingOptions<TContext> {
259259
*/
260260
minimumRetryDelayMs?: number;
261261
/**
262-
* Default timeout for each individual attempt to send a report to Apollo.
263-
* (This is for each HTTP POST, not for all potential retries.) Defaults to 30
264-
* seconds (30000ms).
262+
* Timeout for each individual attempt to send a report to Apollo. (This is
263+
* for each HTTP POST, not for all potential retries.) Defaults to 30 seconds
264+
* (30000ms).
265265
*/
266266
requestTimeoutMs?: number;
267267
/**

0 commit comments

Comments
 (0)