From 5dcd0daa4295d8fec49c0ad34487835af58c5d18 Mon Sep 17 00:00:00 2001 From: Daniel Nelson Date: Mon, 9 Sep 2019 17:50:46 -0700 Subject: [PATCH] Document the pros and cons of increasing the metric_buffer_limit --- docs/CONFIGURATION.md | 4 +++- internal/config/config.go | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md index 071a92f1c..36feac791 100644 --- a/docs/CONFIGURATION.md +++ b/docs/CONFIGURATION.md @@ -112,7 +112,9 @@ The agent table configures Telegraf and the defaults used across all plugins. This controls the size of writes that Telegraf sends to output plugins. - **metric_buffer_limit**: - Maximum number of unwritten metrics per output. + Maximum number of unwritten metrics per output. Increasing this value + allows for longer periods of output downtime without dropping metrics at the + cost of higher maximum memory usage. - **collection_jitter**: Collection jitter is used to jitter the collection by a random [interval][]. diff --git a/internal/config/config.go b/internal/config/config.go index 43866a32e..d7fe11427 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -257,7 +257,9 @@ var agentConfig = ` ## This controls the size of writes that Telegraf sends to output plugins. metric_batch_size = 1000 - ## Maximum number of unwritten metrics per output. + ## Maximum number of unwritten metrics per output. Increasing this value + ## allows for longer periods of output downtime without dropping metrics at the + ## cost of higher maximum memory usage. metric_buffer_limit = 10000 ## Collection jitter is used to jitter the collection by a random amount.