2018-04-13 10:46:19 -04:00
|
|
|
source: Extensions/metrics/Prometheus.md
|
2018-10-27 23:04:34 +01:00
|
|
|
path: blob/master/doc/
|
2018-04-13 10:46:19 -04:00
|
|
|
# Enabling support for Prometheus.
|
|
|
|
|
|
|
|
|
|
Please be aware Prometheus support is alpha at best, It hasn't been extensively tested and is still in development
|
|
|
|
|
All it provides is the sending of data to a a Prometheus PushGateway. Please be careful when enabling this support
|
|
|
|
|
you use it at your own risk!
|
|
|
|
|
|
|
|
|
|
### Requirements (Older versions may work but haven't been tested
|
|
|
|
|
- Prometheus >= 2.0
|
|
|
|
|
- PushGateway >= 0.4.0
|
|
|
|
|
- Grafana
|
|
|
|
|
- PHP-CURL
|
|
|
|
|
|
|
|
|
|
The setup of the above is completely out of scope here and we aren't really able to provide any help with this side
|
|
|
|
|
of things.
|
|
|
|
|
|
|
|
|
|
### What you don't get
|
|
|
|
|
- Pretty graphs, this is why at present you need Grafana. You need to build your own graphs within Grafana.
|
|
|
|
|
- Support for Prometheus or Grafana, we would highly recommend that you have some level of experience with these.
|
|
|
|
|
|
|
|
|
|
RRD will continue to function as normal so LibreNMS itself should continue to function as normal.
|
|
|
|
|
|
|
|
|
|
### Configuration
|
|
|
|
|
```php
|
|
|
|
|
$config['prometheus']['enable'] = true;
|
|
|
|
|
$config['prometheus']['url'] = 'http://127.0.0.1:9091';
|
|
|
|
|
$config['prometheus']['job'] = 'librenms'; # Optional
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Sample Prometheus Scrape Config (for scraping the Push Gateway)
|
|
|
|
|
```yml
|
|
|
|
|
- job_name: pushgateway
|
|
|
|
|
scrape_interval: 300s
|
|
|
|
|
honor_labels: true
|
|
|
|
|
static_configs:
|
|
|
|
|
- targets: ['127.0.0.1:9091']
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The same data then stored within rrd will be sent to Prometheus and recorded. You can then create graphs within Grafana
|
|
|
|
|
to display the information you need.
|
