fix(wavefront output): update documentation to reflect current behavi…

…or and deprecated fields
influxdata · Jul 29, 2022 · 932d285 · 932d285
1 parent 1297d0b
commit 932d285
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 15 deletions.
diff --git a/plugins/outputs/wavefront/README.md b/plugins/outputs/wavefront/README.md
@@ -1,27 +1,24 @@
 # Wavefront Output Plugin
 
-This plugin writes to a [Wavefront](https://www.wavefront.com) proxy, in
-Wavefront data format over TCP.
+This plugin writes to a [Wavefront](https://www.wavefront.com) instance or a Wavefront Proxy instance over HTTP or HTTPS.
 
 ## Configuration
 
 ```toml @sample.conf
-# Configuration for Wavefront server to send metrics to
 [[outputs.wavefront]]
-  ## Url for Wavefront Direct Ingestion. For Wavefront Proxy Ingestion, see
-  ## the 'host' and 'port' options below.
+  ## Url for Wavefront API or Wavefront Proxy instance.
   url = "https://metrics.wavefront.com"
 
-  ## Authentication Token for Wavefront. Only required if using Direct Ingestion
+  ## Authentication Token for Wavefront. Required if using Direct Ingestion. Not required if using a Wavefront Proxy.
   #token = "DUMMY_TOKEN"
 
-  ## Maximum number of metrics to send per batch for Direct Ingestion. Ignored unless 'url' is set. This value should be higher than the `metric_batch_size`. Default is 10,000. Values higher than 40,000 are not recommended.
+  ## Maximum number of metrics to send per HTTP request. This value should be higher than the `metric_batch_size`. Default is 10,000. Values higher than 40,000 are not recommended.
   # http_maximum_batch_size = 10000
 
-  ## DNS name of the wavefront proxy server. Do not use if url is specified
+  ## Deprecated. DNS name of the Wavefront server or Wavefront Proxy. Use the `url` field instead.
   #host = "wavefront.example.com"
 
-  ## Port that the Wavefront proxy server listens on. Do not use if url is specified
+  ## Deprecated. Wavefront proxy port. Use the `url` field instead.
   #port = 2878
 
   ## prefix for metrics keys

diff --git a/plugins/outputs/wavefront/sample.conf b/plugins/outputs/wavefront/sample.conf
@@ -1,19 +1,18 @@
 # Configuration for Wavefront server to send metrics to
 [[outputs.wavefront]]
-  ## Url for Wavefront Direct Ingestion. For Wavefront Proxy Ingestion, see
-  ## the 'host' and 'port' options below.
+  ## Url for Wavefront API or Wavefront Proxy instance.
   url = "https://metrics.wavefront.com"
 
-  ## Authentication Token for Wavefront. Only required if using Direct Ingestion
+  ## Authentication Token for Wavefront. Required if using Direct Ingestion. Not required if using a Wavefront Proxy.
   #token = "DUMMY_TOKEN"
 
-  ## Maximum number of metrics to send per batch for Direct Ingestion. Ignored unless 'url' is set. This value should be higher than the `metric_batch_size`. Default is 10,000. Values higher than 40,000 are not recommended.
+  ## Maximum number of metrics to send per HTTP request. This value should be higher than the `metric_batch_size`. Default is 10,000. Values higher than 40,000 are not recommended.
   # http_maximum_batch_size = 10000
 
-  ## DNS name of the wavefront proxy server. Do not use if url is specified
+  ## Deprecated. DNS name of the Wavefront server or Wavefront Proxy. Use the `url` field instead.
   #host = "wavefront.example.com"
 
-  ## Port that the Wavefront proxy server listens on. Do not use if url is specified
+  ## Deprecated. Wavefront proxy port. Use the `url` field instead.
   #port = 2878
 
   ## prefix for metrics keys