From 6ed1431348c200760443c2a0422b0d54bea927ec Mon Sep 17 00:00:00 2001
From: Samantha Wang <32681364+sjwang90@users.noreply.github.com>
Date: Fri, 15 Jan 2021 10:16:37 -0800
Subject: [PATCH] update readme: prometheus remote write (#8683)

---
 plugins/serializers/prometheusremotewrite/README.md | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/plugins/serializers/prometheusremotewrite/README.md b/plugins/serializers/prometheusremotewrite/README.md
index 8bad919b2..a0dc4a8de 100644
--- a/plugins/serializers/prometheusremotewrite/README.md
+++ b/plugins/serializers/prometheusremotewrite/README.md
@@ -1,4 +1,4 @@
-# Prometheus
+# Prometheus remote write
 
 The `prometheusremotewrite` data format converts metrics into the Prometheus protobuf
 exposition format.
@@ -13,11 +13,17 @@ use only the `prometheus_client` output.
 
 ```toml
 [[outputs.http]]
+  ## URL is the address to send metrics to
   url = "https://cortex/api/prom/push"
-  data_format = "prometheusremotewrite"
+  
+  ## Optional TLS Config
   tls_ca = "/etc/telegraf/ca.pem"
   tls_cert = "/etc/telegraf/cert.pem"
   tls_key = "/etc/telegraf/key.pem"
+  
+  ## Data format to output.
+  data_format = "prometheusremotewrite"
+  
   [outputs.http.headers]
      Content-Type = "application/x-protobuf"
      Content-Encoding = "snappy"