ComputerSurge/shields
3
0
Fork 0
Code Pull Requests 1 Activity

Update self-hosting.md documentation for running with Prometheus (#6052)

Browse Source 
* Update documentation for running with Prometheus

There's two environment variables that need to be set in order to use Prometheus and the /metrics endpoint.

* Missing s

* Update doc/self-hosting.md

Co-authored-by: Caleb Cartwright <calebcartwright@users.noreply.github.com>

Co-authored-by: Caleb Cartwright <calebcartwright@users.noreply.github.com>
Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
This commit is contained in:
Cobertos / Samantha
2021-01-16 12:54:43 -05:00
committed by GitHub
parent 2d9ac83bb4
commit 7a1eee06a2
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/self-hosting.md
View File

@@ -198,10 +198,10 @@ sudo node server
### Prometheus
Shields uses [prom-client](https://github.com/siimon/prom-client) to provide [default metrics](https://prometheus.io/docs/instrumenting/writing_clientlibs/#standard-and-runtime-collectors). These metrics are disabled by default.
You can enable them by `METRICS_PROMETHEUS_ENABLED` environment variable.
You can enable them by `METRICS_PROMETHEUS_ENABLED` and `METRICS_PROMETHEUS_ENDPOINT_ENABLED` environment variables.
```bash
METRICS_PROMETHEUS_ENABLED=true npm start
METRICS_PROMETHEUS_ENABLED=true METRICS_PROMETHEUS_ENDPOINT_ENABLED=true npm start
```
Metrics are available at `/metrics` resource.