mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00

VVelox 06b85f5b07 docs: more md linting (#10371 )

* clean 1-Minute-Polling.md formatting

* cleanup formatting for Adding-a-Device.md

* clean up formatting of Cleanup-options.md

* cleanup formatting some for CLI-Tools.md

* cleanup formatting for Syslog.md and Configuration.md

* cleanup formatting for Device-Sensors.md

* cleanup formatting for Device-Troubleshooting.md

* cleanup Discovery Support.md

* cleanup Environment-Variables.md

* cleanup Example-Hardware-Setup.md and FAQ.mg

* update Features.md, Install Validation.md, Perfermance.md, Poller Support.md, and index.md

* cleanup Remote-Monitoring-VPN.md, SNMP-Configuration-Examples.md, and SSL-Configuration.md

* lots of updates for Installation docs

* more installation doc cleanup

* more formatting cleanup

* clean Work-Map.md up some

2019-07-18 21:25:53 -05:00

1.5 KiB

Raw Blame History

source: Extensions/metrics/Prometheus.md path: blob/master/doc/

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

$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)

- 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.

1.5 KiB Raw Blame History