LemmyNet/lemmy-docs
2
0
Fork 0
mirror of https://github.com/LemmyNet/lemmy-docs.git synced 2024-11-21 20:01:10 +00:00
Code Issues Projects Releases Wiki Activity

Clarify that prometheus is included by default (#292)

Browse source
This commit is contained in:
Cole Gerdemann 2024-02-08 01:44:44 -08:00 committed by GitHub
parent f886b9b847
commit 0c4b47c148
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 1 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
src/administration/prometheus.md
View file

@ -4,27 +4,6 @@ Lemmy supports the export of metrics in the [Prometheus](https://prometheus.io/)
format. This document outlines how to enable the feature and begin collecting format. This document outlines how to enable the feature and begin collecting
metrics. metrics.
## Build
A cargo feature flag gates the inclusion of the Prometheus components in the
Lemmy server. To build Lemmy with the Prometheus components included, enable the
`prometheus-metrics` feature.
```shell
cargo build --features prometheus-metrics
```
If using the `docker-compose.yml` from the [Lemmy
repository](https://github.com/LemmyNet/lemmy/blob/main/docker/docker-compose.yml),
enable the feature flag through the `CARGO_BUILD_FEATURES` build arg.
```yaml
lemmy:
build:
args:
CARGO_BUILD_FEATURES: prometheus-metrics
```
## Configuration ## Configuration
Configuration of the Prometheus endpoint is contained under the optional Configuration of the Prometheus endpoint is contained under the optional
@ -43,7 +22,7 @@ prometheus: {
## Scrape ## Scrape
After Lemmy has been built and deployed, test that it is serving properly After Lemmy has been deployed, test that it is serving properly
(substitute the correct hostname if not running locally). (substitute the correct hostname if not running locally).
```shell ```shell