diff options
| author | Ilja <pleroma@spectraltheorem.be> | 2021-01-10 08:25:36 +0000 |
|---|---|---|
| committer | rinpatch <rinpatch@sdf.org> | 2021-01-10 08:25:36 +0000 |
| commit | 6284e8f4b2e9b737d1ed256e89f2ac3ba673d6f8 (patch) | |
| tree | c56758cdaa95ce053e04952497386542e1b28531 /docs/API/prometheus.md | |
| parent | 5822338f3a42852c18a323c35041b14b29661de6 (diff) | |
| download | pleroma-6284e8f4b2e9b737d1ed256e89f2ac3ba673d6f8.tar.gz pleroma-6284e8f4b2e9b737d1ed256e89f2ac3ba673d6f8.zip | |
Add development section
* I cretaed a folder 'development'
* I split up the file dev.md into three parts and moved it to this folder
* index.md
* authentication_authorization.md
* mrf.md
* I also moved ap_extensions.md
* I created a new file setting_up_pleroma_dev.md
Diffstat (limited to 'docs/API/prometheus.md')
| -rw-r--r-- | docs/API/prometheus.md | 44 |
1 files changed, 0 insertions, 44 deletions
diff --git a/docs/API/prometheus.md b/docs/API/prometheus.md deleted file mode 100644 index a5158d905..000000000 --- a/docs/API/prometheus.md +++ /dev/null @@ -1,44 +0,0 @@ -# Prometheus Metrics - -Pleroma includes support for exporting metrics via the [prometheus_ex](https://github.com/deadtrickster/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](https://github.com/deadtrickster/prometheus-plugs#exporting) 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](https://grafana.com) - -``` - - job_name: 'beam' - metrics_path: /api/pleroma/app_metrics - scheme: https - static_configs: - - targets: ['pleroma.soykaf.com'] -``` |