From 5867b50d0aa1feae52524e3d7219e8aaf93e8dc3 Mon Sep 17 00:00:00 2001 From: Alex Fornuto Date: Thu, 10 Mar 2022 12:34:37 -0600 Subject: [PATCH] Update metrics address copy (#3079) --- docs/enterprise/metrics.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/enterprise/metrics.md b/docs/enterprise/metrics.md index d69244c44..c263b38b2 100644 --- a/docs/enterprise/metrics.md +++ b/docs/enterprise/metrics.md @@ -14,13 +14,15 @@ For production deployments, we suggest using a dedicated Prometheus instance. ## Prepare Pomerium -1. In the Pomerium `config.yaml`, define the `metrics_address` key to a network interface and/or port. For example: +1. In the Pomerium `config.yaml`, define the [`metrics_address`](/reference/readme.md#metrics-address) key to a network interface and/or port. For example: ```yaml - metrics_address: 0.0.0.0:9999 + metrics_address: 192.0.2.31:9999 ``` - The example above has Pomerium providing metrics at port `9999` on all network interfaces. + The example above has Pomerium providing metrics at port `9999` on an IP address reachable by the Pomerium Console service. + + If you're running Pomerium Enterprise in a distributed environment where the IP address is not known at the time of deployment, you can use the resolvable FQDN of the Pomerium host (`pomerium0.internal.mycompany.com`, for example), or override this key with the environment variable `METRICS_ADDRESS`. We do not recommend exposing this endpoint to public traffic as it can contain potentially sensitive information. ## External Prometheus