From 1da1c4753e213841031dfd2dfa331826f71418bd Mon Sep 17 00:00:00 2001 From: Daniel Nelson <daniel.nelson@influxdb.com> Date: Fri, 28 Apr 2017 13:40:58 -0700 Subject: [PATCH] Clarify retention policy option for influxdb output closes #2696 --- plugins/outputs/influxdb/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/plugins/outputs/influxdb/README.md b/plugins/outputs/influxdb/README.md index 5acac6cc..3cd029d8 100644 --- a/plugins/outputs/influxdb/README.md +++ b/plugins/outputs/influxdb/README.md @@ -18,7 +18,8 @@ This plugin writes to [InfluxDB](https://www.influxdb.com) via HTTP or UDP. ## The target database for metrics (telegraf will create it if not exists). database = "telegraf" # required - ## Retention policy to write to. Empty string writes to the default rp. + ## Name of existing retention policy to write to. Empty string writes to + ## the default retention policy. retention_policy = "" ## Write consistency (clusters only), can be: "any", "one", "quorum", "all" write_consistency = "any" @@ -52,7 +53,7 @@ to write to. Each URL should start with either `http://` or `udp://` ### Optional parameters: * `write_consistency`: Write consistency (clusters only), can be: "any", "one", "quorum", "all". -* `retention_policy`: Retention policy to write to. +* `retention_policy`: Name of existing retention policy to write to. Empty string writes to the default retention policy. * `timeout`: Write timeout (for the InfluxDB client), formatted as a string. If not provided, will default to 5s. 0s means no timeout (not recommended). * `username`: Username for influxdb * `password`: Password for influxdb -- GitLab