Skip to content

Commit

Permalink
Improve Prometheus remote_write metricset docs (elastic#16997)
Browse files Browse the repository at this point in the history
(cherry picked from commit 71b4116)
  • Loading branch information
ChrsMark committed Mar 16, 2020
1 parent d8cd2ff commit 7aad6c6
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions metricbeat/module/prometheus/remote_write/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,20 @@ remote_write:
- url: "http://localhost:9201/write"
------------------------------------------------------------------------------


Metrics sent to the http endpoint will be put by default under the `prometheus.metrics` prefix with their labels under `prometheus.labels`.
Also consider using secure settings for the server using TLS/SSL as shown
A basic configuration would look like:

["source","yaml",subs="attributes"]
------------------------------------------------------------------------------
- module: prometheus
metricsets: ["remote_write"]
host: "localhost"
port: "9201"
------------------------------------------------------------------------------
Also consider using secure settings for the server, configuring the module with TLS/SSL as shown:

["source","yaml",subs="attributes"]
------------------------------------------------------------------------------
Expand All @@ -20,3 +31,16 @@ Also consider using secure settings for the server using TLS/SSL as shown
ssl.key: "/etc/pki/server/cert.key"
port: "9201"
------------------------------------------------------------------------------
and on Prometheus side:

["source","yaml",subs="attributes"]
------------------------------------------------------------------------------
remote_write:
- url: "https://localhost:9201/write"
tls_config:
cert_file: "/etc/prometheus/my_key.pem"
key_file: "/etc/prometheus/my_key.key"
# Disable validation of the server certificate.
#insecure_skip_verify: true
------------------------------------------------------------------------------

0 comments on commit 7aad6c6

Please sign in to comment.