feat: allow specifying timeout for cluster metrics aggregation #645
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -36,10 +36,11 @@ class AggregatorRegistry extends Registry { | |||
| /** | |||
| * Gets aggregated metrics for all workers. The optional callback and | |||
| * returned Promise resolve with the same value; either may be used. | |||
| * @param {ClusterMetricsOptions|undefined} options Additional options for cluster metrics aggregation. | |||
There was a problem hiding this comment.
Suggested change
| * @param {ClusterMetricsOptions|undefined} options Additional options for cluster metrics aggregation. | |
| * @param {ClusterMetricsOptions|undefined} options Additional options for cluster metrics aggregation. | |
| * @param {number} [options.timeoutMs=5000] Timeout to wait for all workers to respond before error. |
You can document the timeoutMs field as well
| @@ -136,10 +136,11 @@ export class AggregatorRegistry< | |||
| > extends Registry<T> { | |||
| /** | |||
| * Gets aggregated metrics for all workers. | |||
| * @param {ClusterMetricsOptions|undefined} options Additional options for cluster metrics aggregation | |||
There was a problem hiding this comment.
Suggested change
| * @param {ClusterMetricsOptions|undefined} options Additional options for cluster metrics aggregation | |
| * @param {ClusterMetricsOptions|undefined} options Additional options for cluster metrics aggregation | |
| * @param {number} [options.timeoutMs=5000] Timeout to wait for all workers to respond before error. |
| @@ -192,6 +193,10 @@ export enum MetricType { | |||
| Summary, | |||
| } | |||
|
|
|||
| export type ClusterMetricsOptions = { | |||
| timeoutMs?: number; | |||
There was a problem hiding this comment.
Suggested change
| timeoutMs?: number; | |
| /** Timeout to wait for all workers to respond before error. */ | |
| timeoutMs?: number; |
This can be documented as well
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds ability to specify cluster metrics aggregation timeout.
Overriding hard-coded timeout as a workaround for #628 where scraping in larger projects end up in a timeout most of the time.