git.squeep.com Git - akkoma/blob - docs/docs/development/API/prometheus.md

   1 # Prometheus Metrics
   2
   3 Akkoma includes support for exporting metrics via the [prometheus_ex](https://github.com/deadtrickster/prometheus.ex) library.
   4
   5 Config example:
   6
   7 ```
   8 config :pleroma, :instance,
   9   export_prometheus_metrics: true
  10 ```
  11
  12 ## `/api/v1/akkoma/metrics`
  13
  14 ### Exports Prometheus application metrics
  15
  16 * Method: `GET`
  17 * Authentication: required
  18 * Params: none
  19 * Response: text
  20
  21 ## Grafana
  22
  23 ### Config example
  24
  25 The following is a config example to use with [Grafana](https://grafana.com)
  26
  27 ```
  28   - job_name: 'beam'
  29     metrics_path: /api/v1/akkoma/metrics
  30     scheme: https
  31     static_configs:
  32     - targets: ['otp.akkoma.dev']
  33 ```