Feat/prometheus-exporter : Add prometheus exporter docs in en and de language. #812
Conversation
There was a problem hiding this comment.
Sorry to make things harder for you, but I took this opportunity to change a couple of things about the exporter - the exporter was started as a quick and dirty solution for myself and I wanted to have something more presentable and secure if it was going to be added to official docs
| The following prometheus configuration can be used in order to pass these information | ||
| to the endpoint: | ||
|
|
||
| ```yaml |
There was a problem hiding this comment.
scrape_configs:
- job_name: 'mailcow'
static_configs:
- targets: [ 'mailcow_exporter:9099' ]
params:
token: [ 'YOUR-APIKEY-HERE' ]|
|
||
| ### Usage | ||
|
|
||
| The `/metrics` endpoint requires `host` and `apiKey` URL parameters. `host` is the |
There was a problem hiding this comment.
In order to prevent using the exporter to be instrumented to access third party domains, providing host and apikey using URL parameters is not supported anymore. Instead, they must be provided on startup using MAILCOW_EXPORTER_HOST & MAILCOW_EXPORTER_API_KEY or --host=... & --api-key=....
|
|
||
| ### Setting host or api key on application start-up | ||
|
|
||
| When using the exporter for a single mailcow host, it might be useful not to send `host` and `apiKey` with every request, since they don't change. |
There was a problem hiding this comment.
When using the exporter for a single mailcow host
Using a single exporter for multiple mailcow hosts now isn't supported anymore. An exporter must always be provided with host & apiKey on startup
| ``` | ||
|
|
||
|
|
||
| [Prometheus](https://prometheus.io) exporter for information about a |
|
|
||
|  | ||
|
|
||
| **ImpoWichtigrtant:** Beschränken Sie den Zugriff auf den Exporter und schützen Sie Ihren API-Schlüssel! |
Following your suggestion on
pull request #6314 ( mailcow/mailcow-dockerized#6314 ),
I have separated the documentation changes into this new pull request within the mailcow repository., in to third-party - Prometheus exporter section.
I've tested the documentation locally using
mkdocs servefor two languages, and it appears to be rendering correctly.