mirror of https://github.com/librenms/librenms.git synced 2024-09-22 19:08:15 +00:00

mcq8 5ff03d5942 refactor: Refactor alert transports to classes (#7844 )

* Refactor alert transports to classes

* Fix linting

* Make Slack alert transport php 5.3 compatible

* Rename call method to deliverAlert for alert transport

2017-12-10 20:20:28 +00:00

20 KiB

Raw Blame History

source: Alerting/Transports.md

Transports

Transports are located within LibreNMS/Alert/Transport/ and defined as well as configured via ~~$config['alert']['transports']['Example'] = 'Some Options'~~.

Contacts will be gathered automatically and passed to the configured transports. By default the Contacts will be only gathered when the alert triggers and will ignore future changes in contacts for the incident. If you want contacts to be re-gathered before each dispatch, please set ~~$config['alert']['fixed-contacts'] = false;~~ in your config.php.

The contacts will always include the SysContact defined in the Device's SNMP configuration and also every LibreNMS-User that has at least read-permissions on the entity that is to be alerted.

At the moment LibreNMS only supports Port or Device permissions.

You can exclude the SysContact by setting:

$config['alert']['syscontact'] = false;

To include users that have Global-Read or Administrator permissions it is required to add these additions to the config.php respectively:

$config['alert']['globals'] = true; //Include Global-Read into alert-contacts
$config['alert']['admins']  = true; //Include Administrators into alert-contacts

E-Mail

You can configure these options within the WebUI now, please avoid setting these options within config.php

For all but the default contact, we support setting multiple email addresses separated by a comma. So you can set the devices sysContact, override the sysContact or have your users emails set like:

email@domain.com, alerting@domain.com

E-Mail transport is enabled with adding the following to your config.php:

$config['alert']['transports']['mail'] = true;

The E-Mail transports uses the same email-configuration like the rest of LibreNMS. As a small reminder, here is it's configuration directives including defaults:

$config['email_backend']                   = 'mail';               // Mail backend. Allowed: "mail" (PHP's built-in), "sendmail", "smtp".
$config['email_from']                      = NULL;                 // Mail from. Default: "ProjectName" <projectid@`hostname`>
$config['email_user']                      = $config['project_id'];
$config['email_sendmail_path']             = '/usr/sbin/sendmail'; // The location of the sendmail program.
$config['email_html']                      = FALSE;                // Whether to send HTML email as opposed to plaintext
$config['email_smtp_host']                 = 'localhost';          // Outgoing SMTP server name.
$config['email_smtp_port']                 = 25;                   // The port to connect.
$config['email_smtp_timeout']              = 10;                   // SMTP connection timeout in seconds.
$config['email_smtp_secure']               = NULL;                 // Enable encryption. Use 'tls' or 'ssl'
$config['email_smtp_auth']                 = FALSE;                // Whether or not to use SMTP authentication.
$config['email_smtp_username']             = NULL;                 // SMTP username.
$config['email_smtp_password']             = NULL;                 // Password for SMTP authentication.

$config['alert']['default_only']           = false;                //Only issue to default_mail
$config['alert']['default_mail']           = '';                   //Default email

API

You can configure these options within the WebUI now, please avoid setting these options within config.php

API transports definitions are a bit more complex than the E-Mail configuration. The basis for configuration is ~~$config['alert']['transports']['api'][METHOD]~~ where METHOD can be get,post or put. This basis has to contain an array with URLs of each API to call. The URL can have the same placeholders as defined in the Template-Syntax. If the METHOD is get, all placeholders will be URL-Encoded. The API transport uses cURL to call the APIs, therefore you might need to install php5-curl or similar in order to make it work. Note: it is highly recommended to define own Templates when you want to use the API transport. The default template might exceed URL-length for GET requests and therefore cause all sorts of errors.

Example:

$config['alert']['transports']['api']['get'][] = "https://api.thirdparti.es/issue?apikey=abcdefg&subject=%title";

Nagios Compatible

You can configure these options within the WebUI now, please avoid setting these options within config.php

The nagios transport will feed a FIFO at the defined location with the same format that nagios would. This allows you to use other Alerting-Systems to work with LibreNMS, for example Flapjack.

$config['alert']['transports']['nagios'] = "/path/to/my.fifo"; //Flapjack expects it to be at '/var/cache/nagios3/event_stream.fifo'

IRC

You can configure these options within the WebUI now, please avoid setting these options within config.php

The IRC transports only works together with the LibreNMS IRC-Bot. Configuration of the LibreNMS IRC-Bot is described here.

$config['alert']['transports']['irc'] = true;

Slack

You can configure these options within the WebUI now, please avoid setting these options within config.php

20 KiB Raw Blame History

Transports

E-Mail

API

Nagios Compatible

IRC

Slack

Rocket.chat

HipChat

PagerDuty

Pushover

Boxcar

Telegram

Pushbullet

Clickatell

PlaySMS

VictorOps

Canopsis

osTicket

Microsoft Teams

Cisco Spark

SMSEagle

Syslog

Elasticsearch

JIRA

20 KiB

Raw Blame History