CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: better specify agent precision is integer + unit (#10746) 

Fixes: #10734
This commit is contained in:
Joshua Powers 2022-03-03 08:20:02 -07:00 committed by GitHub
parent 21f60512fe
commit 4aa87229e6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
config/config.go
View File

@ -139,10 +139,15 @@ type AgentConfig struct {
// ie, if Interval=10s then always collect on :00, :10, :20, etc. // ie, if Interval=10s then always collect on :00, :10, :20, etc.
RoundInterval bool RoundInterval bool
// Collected metrics are rounded to the precision specified. Precision is
// specified as an interval with an integer + unit (e.g. 0s, 10ms, 2us, 4s).
// Valid time units are "ns", "us" (or "µs"), "ms", "s".
//
// By default or when set to "0s", precision will be set to the same // By default or when set to "0s", precision will be set to the same
// timestamp order as the collection interval, with the maximum being 1s. // timestamp order as the collection interval, with the maximum being 1s:
// ie, when interval = "10s", precision will be "1s" // ie, when interval = "10s", precision will be "1s"
// when interval = "250ms", precision will be "1ms" // when interval = "250ms", precision will be "1ms"
//
// Precision will NOT be used for service inputs. It is up to each individual // Precision will NOT be used for service inputs. It is up to each individual
// service input to set the timestamp at the appropriate precision. // service input to set the timestamp at the appropriate precision.
Precision Duration Precision Duration
@ -365,13 +370,17 @@ var agentConfig = `
## ie, a jitter of 5s and interval 10s means flushes will happen every 10-15s ## ie, a jitter of 5s and interval 10s means flushes will happen every 10-15s
flush_jitter = "0s" flush_jitter = "0s"
## Collected metrics are rounded to the precision specified. Precision is
## specified as an interval with an integer + unit (e.g. 0s, 10ms, 2us, 4s).
## Valid time units are "ns", "us" (or "µs"), "ms", "s".
##
## By default or when set to "0s", precision will be set to the same ## By default or when set to "0s", precision will be set to the same
## timestamp order as the collection interval, with the maximum being 1s. ## timestamp order as the collection interval, with the maximum being 1s:
## ie, when interval = "10s", precision will be "1s" ## ie, when interval = "10s", precision will be "1s"
## when interval = "250ms", precision will be "1ms" ## when interval = "250ms", precision will be "1ms"
##
## Precision will NOT be used for service inputs. It is up to each individual ## Precision will NOT be used for service inputs. It is up to each individual
## service input to set the timestamp at the appropriate precision. ## service input to set the timestamp at the appropriate precision.
## Valid time units are "ns", "us" (or "µs"), "ms", "s".
precision = "" precision = ""
## Log at debug level. ## Log at debug level.