Prometheus
Prometheus Support must be enabled explicitly by editing /etc/bondixserver.json (/etc/saneserver.json). You can either use the default https port to also serve Prometheus metrics, or use a dedicated listener.
Once enabled, prometheus metrics will be accessible via https://<server-ip>/metrics
Serving Prometheus over default https port
In /etc/bondixserver.json, locate the following line:
{"target": "server", "action": "add-https", "host": "0.0.0.0", "port": "443", "allowMonitor": true},
Here, we'll add the following properties:
| Property | Value | Description |
|---|---|---|
| allowPrometheus | true | enables Prometheus metric reports |
| prometheusUser | <username> | Optional. If provided, the metrics are password protected |
| prometheusPassword | <password> | Optional, If provided, the metrics are password protected. Note that both username and password must be provided. Otherwise, metrics are not password protected! |
Ideally, your modified configuration line would look something like this:
{"target": "server", "action": "add-https", "host": "0.0.0.0", "port": "443", "allowMonitor": true, "allowPrometheus": true, "prometheusUser": "prometheus", "prometheusPassword": "a-good-password"},
Serving Prometheus over dedicated port
To add a dedicated prometheus listener, we'll have to add an additional configuration entry in the json file. Here we'll take some precautions to ensure that only Prometheus metrics are served - you can also choose whether to use https or http. Depending on your configuration you might limit access to the port by other means, making user based authentication optional. This is however completely in your responsbility.
{"target": "server", "action": "add-http", "host": "127.0.0.1", "port": "181818", "allowMonitor": false, "allowTunnel": false, "allowPrometheus": true, "prometheusUser": "prometheus", "prometheusPassword": "a-good-password"},
Use action: "add-http" for http, or action: "add-https" for https. Select host and port according to your requirements.
Adding bondix server to Prometheus
Here is an example snippet to for scraping Bondix servers using https and basic_auth
- job_name: 'endpoints'
static_configs:
- targets: ['your_endpoint_server.com']
scheme: https
basic_auth: username: 'prometheus'
password: 'a-good-password'
tls_config:
insecure_skip_verify: true
enable_http2: false
