From 2e4cb440951d390e727731e7a1b8ca48a99d106e Mon Sep 17 00:00:00 2001 From: Michel Vocks Date: Mon, 7 Oct 2019 17:54:09 +0200 Subject: [PATCH] Docs: Add unauthenticated metrics access docs (#7566) --- .../docs/configuration/listener/tcp.html.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/website/source/docs/configuration/listener/tcp.html.md b/website/source/docs/configuration/listener/tcp.html.md index d8e0297a910f..f23a05b22e80 100644 --- a/website/source/docs/configuration/listener/tcp.html.md +++ b/website/source/docs/configuration/listener/tcp.html.md @@ -140,6 +140,11 @@ advertise the correct address to other nodes. there is no X-Forwarded-For header or it is empty, the client address will be used as-is, rather than the client connection rejected. +### `telemetry` Parameters + +- `unauthenticated_metrics_access` `(string: "false")` - If set to true, allows + unauthenticated access to the `/v1/sys/metrics` endpoint. + ## `tcp` Listener Examples ### Configuring TLS @@ -171,6 +176,18 @@ api_addr = "https://10.0.0.5:8200" cluster_addr = "https://10.0.0.5:8201" ``` +### Configuring unauthenticated metrics access + +This example shows enabling unauthenticated metrics access. + +```hcl +listener "tcp" { + telemetry { + unauthenticated_metrics_access = true + } +} +``` + [golang-tls]: https://golang.org/src/crypto/tls/cipher_suites.go [api-addr]: /docs/configuration/index.html#api_addr [cluster-addr]: /docs/configuration/index.html#cluster_addr