From 360b10c4deecb5a3b5f9322cb5702c42ed205671 Mon Sep 17 00:00:00 2001
From: Daniel Nelson <danielnelson@users.noreply.github.com>
Date: Wed, 12 Apr 2017 10:42:11 -0700
Subject: [PATCH] Clarify precision documentation (#2655)
---
internal/config/config.go | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)
diff --git a/internal/config/config.go b/internal/config/config.go
index f8c30417..61263f49 100644
--- a/internal/config/config.go
+++ b/internal/config/config.go
@@ -85,8 +85,8 @@ type AgentConfig struct {
// ie, if Interval=10s then always collect on :00, :10, :20, etc.
RoundInterval bool
- // By default, precision will be set to the same timestamp order as the
- // collection interval, with the maximum being 1s.
+ // 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.
// ie, when interval = "10s", precision will be "1s"
// when interval = "250ms", precision will be "1ms"
// Precision will NOT be used for service inputs. It is up to each individual
@@ -230,10 +230,13 @@ var header = `# Telegraf Configuration
## ie, a jitter of 5s and interval 10s means flushes will happen every 10-15s
flush_jitter = "0s"
- ## By default, precision will be set to the same timestamp order as the
- ## collection interval, with the maximum being 1s.
- ## Precision will NOT be used for service inputs, such as logparser and statsd.
- ## Valid values are "ns", "us" (or "µs"), "ms", "s".
+ ## 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.
+ ## ie, when interval = "10s", precision will be "1s"
+ ## when interval = "250ms", precision will be "1ms"
+ ## Precision will NOT be used for service inputs. It is up to each individual
+ ## service input to set the timestamp at the appropriate precision.
+ ## Valid time units are "ns", "us" (or "µs"), "ms", "s".
precision = ""
## Logging configuration:
--
GitLab