mirror of
https://github.com/librenms/librenms.git
synced 2024-09-22 19:08:15 +00:00
42 lines
4.2 KiB
Markdown
42 lines
4.2 KiB
Markdown
source: Extensions/Poller-Service.md
|
|
# Poller Service
|
|
|
|
# WARNING: THIS IS HIGHLY EXPERIMENTAL AND MAY NOT WORK
|
|
|
|
The Poller service is an alternative to polling and discovery cron jobs and provides support for distributed polling without memcache. It is multi-threaded and runs continuously discovering and polling devices with the oldest data attempting to honor the polling frequency configured in `config.php`. This service replaces all the required cron jobs except for `/opt/librenms/daily.sh` and `/opt/librenms/alerts.php`.
|
|
|
|
Configure the maximum number of threads for the service in `$config['poller_service_workers']`. Configure the minimum desired polling frequency in `$config['poller_service_poll_frequency']` and the minimum desired discovery frequency in `$config['poller_service_discover_frequency']`. The service will not poll or discover devices which have data newer than this this configured age in seconds. Configure how frequently the service will attempt to poll devices which are down in `$config['poller_service_down_retry']`. If you have enough pollers that the worker threads run out of work, the service will query looking for devices every `$config['poller_service_retry_query']` seconds.
|
|
|
|
The poller service is designed to gracefully degrade. If not all devices can be polled within the configured frequency, the service will continuously poll devices refreshing as frequently as possible using the configured number of threads.
|
|
|
|
The service logs to syslog. A loglevel of INFO will print status updates every 5 minutes. Loglevel of DEBUG will print updates on every device as it is scanned.
|
|
|
|
## Configuration
|
|
```php
|
|
// Poller-Service settings
|
|
$config['poller_service_loglevel'] = "INFO";
|
|
$config['poller_service_workers'] = 16;
|
|
$config['poller_service_poll_frequency'] = 300;
|
|
$config['poller_service_discover_frequency'] = 21600;
|
|
$config['poller_service_down_retry'] = 60;
|
|
$config['poller_service_retry_query'] = 1;
|
|
$config['poller_service_single_connection'] = false;
|
|
```
|
|
|
|
## Distributed Polling
|
|
Distributed polling is possible, and uses the same configuration options as are described for traditional distributed polling, except that the memcached options are not necessary. The database must be accessible from the distributed pollers, and properly configured. Remote access to the RRD directory must also be configured as described in the Distributed Poller documentation. Memcache is not required. Concurrency is managed using mysql GET_LOCK to ensure that devices are only being polled by one device at at time. The poller service is compatible with poller groups.
|
|
|
|
## Multi-Master MySQL considerations
|
|
Because locks are not replicated in Multi-Master MySQL configurations, if you are using such a configuration, you will need to make sure that all pollers are using the same MySQL server.
|
|
|
|
## Single Connection
|
|
If you are running MariaDB 10.2 or newer, you can tell poller-service to use a single mysql connection for managing locks by setting `$config['poller_service_single_connection']` to `true`. *DO NOT* configure this for any version of MariaDB less than 10.2 or any version of MySQL.
|
|
|
|
## Service Installation
|
|
### Upstart
|
|
An upstart configuration file can be found in `scripts/librenms-poller-service.conf`. To install run `cp /opt/librenms/scripts/librenms-poller-service.conf /etc/init/librenms-poller-service.conf`. The service will start on boot and can be started manually by running `start librenms-poller-service`. If you receive an error that the service does not exist, run `initctl reload-configuration`. The service is configured to run as the user `librenms` and will fail if that user does not exist.
|
|
### LSB
|
|
An LSB init script can be found in `scripts/librenms-poller-service.init`. To install run `cp /opt/librenms/scripts/librenms-poller-service.init /etc/init.d/librenms-poller-service && update-rc.d librenms-poller-service defaults`.
|
|
### systemd
|
|
A systemd unit file can be found in `scripts/librenms-poller-service.service`. To install run `cp /opt/librenms/scripts/librenms-poller-service.service /etc/systemd/system/librenms-poller-service.service && systemctl enable --now librenms-poller-service.service`.
|