mirrors/pleroma
1
0
Fork 0
mirror of https://git.pleroma.social/pleroma/pleroma.git synced 2024-11-13 20:41:19 +00:00
Code Issues Projects Releases Wiki Activity
pleroma/docs/API/prometheus.md
feld 86b4149a13 Merge branch '1668-prometheus-access-restrictions' into 'develop' 
[#1668] App metrics endpoint (Prometheus) access restrictions

Closes #1668

See merge request pleroma/pleroma!3093
2020-11-05 16:22:35 +03:00

1.2 KiB
Raw Blame History

Prometheus Metrics

Pleroma includes support for exporting metrics via the prometheus_ex library.

Config example:

config :prometheus, Pleroma.Web.Endpoint.MetricsExporter,
  enabled: true,
  auth: {:basic, "myusername", "mypassword"},
  ip_whitelist: ["127.0.0.1"],
  path: "/api/pleroma/app_metrics",
  format: :text
  • enabled (Pleroma extension) enables the endpoint
  • ip_whitelist (Pleroma extension) could be used to restrict access only to specified IPs
  • auth sets the authentication (false for no auth; configurable to HTTP Basic Auth, see prometheus-plugs documentation)
  • format sets the output format (:text or :protobuf)
  • path sets the path to app metrics page

/api/pleroma/app_metrics

Exports Prometheus application metrics

  • Method: GET
  • Authentication: not required by default (see configuration options above)
  • Params: none
  • Response: text

Grafana

Config example

The following is a config example to use with Grafana

  - job_name: 'beam'
    metrics_path: /api/pleroma/app_metrics
    scheme: https
    static_configs:
    - targets: ['pleroma.soykaf.com']