3pp-mirror/pomerium
1
0
Fork 0
mirror of https://github.com/pomerium/pomerium.git synced 2025-06-06 21:04:39 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update metrics address copy (#3079) (#3133)

Browse source 
Co-authored-by: Alex Fornuto <afornuto@pomerium.com>
This commit is contained in:
backport-actions-token[bot] 2022-03-10 18:54:48 +00:00 • committed by GitHub
parent 5f865283f3
commit 345ef96d07
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/enterprise/metrics.md
View file

@ -14,13 +14,15 @@ For production deployments, we suggest using a dedicated Prometheus instance.
## Prepare Pomerium ## 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 ```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 ## External Prometheus