LibreNMS/doc/Extensions/Graylog.md

source: Extensions/Graylog.md path: blob/master/doc/

Graylog integration

We have simple integration for Graylog, you will be able to view any logs from within LibreNMS that have been parsed by the syslog input from within Graylog itself. This includes logs from devices which aren't in LibreNMS still, you can also see logs for a specific device under the logs section for the device.

Currently, LibreNMS does not associate shortnames from Graylog with full FQDNS. If you have your devices in LibreNMS using full FQDNs, such as hostname.example.com, be aware that rsyslogd, by default, sends the shortname only. To fix this, add

$PreserveFQDN on

to your rsyslog config to send the full FQDN so device logs will be associated correctly in LibreNMS. Also see near the bottom of this document for tips on how to enable/suppress the domain part of hostnames in syslog-messages for some platforms.

Graylog itself isn't included within LibreNMS, you will need to install this separately either on the same infrastructure as LibreNMS or as a totally standalone appliance.

Config is simple, here's an example based on Graylog 2.4:

$config['graylog']['server']   = 'http://127.0.0.1';
$config['graylog']['port']     = 9000;
$config['graylog']['username'] = 'admin';
$config['graylog']['password'] = 'admin';
$config['graylog']['version']  = '2.4';

Graylog messages are stored using GMT timezone. You can display graylog messages in LibreNMS webui using your desired timezone by setting following option in config.php:

$config['graylog']['timezone'] = 'Europe/Bucharest';

Timezone must be PHP supported timezones, available at: http://php.net/manual/en/timezones.php

If you are running a version earlier than Graylog then please set $config['graylog']['version'] to the version number of your Graylog install. Earlier versions than 2.1 use the default port 12900

If you have altered the default uri for your Graylog setup then you can override the default of /api/ using $config['graylog']['base_uri'] = '/somepath/';

If you choose to use another user besides the admin user, please note that currently you must give the user "admin" permissions from within Graylog, "read" permissions alone are not sufficient.

If you have enabled TLS for the Graylog API and you are using a self-signed certificate, please make sure that the certificate is trusted by your LibreNMS host, otherwise the connection will fail. Additionally, the certificate's Common Name (CN) has to match the FQDN or IP address specified in $config['graylog']['server'].

If you want to match the source address of the log entries against any IP address of a device instead of only against the primary address and the host name to assign the log entries to a device, you can activate this function using $config['graylog']['match-any-address'] = 'true';

There are 2 configuration parameters to influence the behaviour of the "Recent Graylog" table on the overview page of the devices. $config['graylog']['device-page']['rowCount'] sets the maximum number of rows to be displayed (default: 10) With $config['graylog']['device-page']['loglevel'] you can set which loglevels should be displayed on the overview page. (default: 7, min: 0, max: 7) $config['graylog']['device-page']['loglevel'] = 4 shows only entries with a log level less than or equal to 4 (Emergency, Alert, Critical, Error, Warning).

You can set a default Log Level Filter with $config['graylog']['loglevel'] (applies to /graylog and /device/device=/tab=logs/section=graylog/ (min: 0, max: 7)

Suppressing/enabling the domain part of a hostname for specific platforms

You should see if what you get in syslog/Graylog matches up with your configured hosts first. If you need to modify the syslog messages from specific platforms, this may be of assistance:

IOS (Cisco)

router(config)# logging origin-id hostname

or

router(config)# logging origin-id string

JunOS (Juniper Networks)

set system syslog host yourlogserver.corp log-prefix YOUR_PREFERRED_STRING

PanOS (Palo Alto Networks)

set deviceconfig setting management hostname-type-in-syslog hostname

or

set deviceconfig setting management hostname-type-in-syslog FQDN