docs(agent): Specify jitter value must be non-zero (#15363)

This commit is contained in:
Joshua Powers 2024-05-16 02:54:11 -06:00 committed by GitHub
parent 729ff2ada4
commit bf2dd12e1e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 3 deletions

View File

@ -391,12 +391,12 @@ Parameters that can be used with any input plugin:
- **collection_jitter**:
Overrides the `collection_jitter` setting of the [agent][Agent] for the
plugin. Collection jitter is used to jitter the collection by a random
[interval][].
[interval][]. The value must be non-zero to override the agent setting.
- **collection_offset**:
Overrides the `collection_offset` setting of the [agent][Agent] for the
plugin. Collection offset is used to shift the collection by the given
[interval][].
[interval][]. The value must be non-zero to override the agent setting.
- **name_override**: Override the base name of the measurement. (Default is
the name of the input).
@ -481,7 +481,8 @@ Parameters that can be used with any output plugin:
- **flush_interval**: The maximum time between flushes. Use this setting to
override the agent `flush_interval` on a per plugin basis.
- **flush_jitter**: The amount of time to jitter the flush interval. Use this
setting to override the agent `flush_jitter` on a per plugin basis.
setting to override the agent `flush_jitter` on a per plugin basis. The value
must be non-zero to override the agent setting.
- **metric_batch_size**: The maximum number of metrics to send at once. Use
this setting to override the agent `metric_batch_size` on a per plugin basis.
- **metric_buffer_limit**: The maximum number of unsent metrics to buffer.