Gitlab: Run benchmark in CI.
[akkoma] / docs / api / prometheus.md
1 # Prometheus Metrics
2
3 Pleroma includes support for exporting metrics via the [prometheus_ex](https://github.com/deadtrickster/prometheus.ex) library.
4
5 ## `/api/pleroma/app_metrics`
6 ### Exports Prometheus application metrics
7 * Method: `GET`
8 * Authentication: not required
9 * Params: none
10 * Response: JSON
11
12 ## Grafana
13 ### Config example
14 The following is a config example to use with [Grafana](https://grafana.com)
15
16 ```
17 - job_name: 'beam'
18 metrics_path: /api/pleroma/app_metrics
19 scheme: https
20 static_configs:
21 - targets: ['pleroma.soykaf.com']
22 ```