Skip to content

Commit

Permalink
Docs: Add unauthenticated metrics access docs (#7566)
Browse files Browse the repository at this point in the history
  • Loading branch information
michelvocks authored and chrishoffman committed Oct 7, 2019
1 parent 9291e79 commit 2e4cb44
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions website/source/docs/configuration/listener/tcp.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

0 comments on commit 2e4cb44

Please sign in to comment.