Skip to content

Commit

Permalink
docs: fix config reference for collectDefaultMetrics
Browse files Browse the repository at this point in the history
The docs for `collectDefaultMetrics` mention that the config object accepts a
`registry`, but the property is actually `register`.
  • Loading branch information
mdeltito authored and zbjornson committed Aug 2, 2021
1 parent 83cb173 commit 2335e00
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -51,7 +51,7 @@ available on Linux.
`collectDefaultMetrics` optionally accepts a config object with following entries:

- `prefix` an optional prefix for metric names. Default: no prefix.
- `registry` to which metrics should be registered. Default: the global default registry.
- `register` to which metrics should be registered. Default: the global default registry.
- `gcDurationBuckets` with custom buckets for GC duration histogram. Default buckets of GC duration histogram are `[0.001, 0.01, 0.1, 1, 2, 5]` (in seconds).
- `eventLoopMonitoringPrecision` with sampling rate in milliseconds. Must be greater than zero. Default: 10.

Expand Down

0 comments on commit 2335e00

Please sign in to comment.