mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
Merge pull request #733 from laf/docs-syslog
Added new doc showing syslog setup
This commit is contained in:
108
doc/Extensions/Syslog.md
Normal file
108
doc/Extensions/Syslog.md
Normal file
@@ -0,0 +1,108 @@
|
||||
# Setting up syslog support
|
||||
|
||||
This document will explain how to send syslog data to LibreNMS.
|
||||
|
||||
### Syslog server installation
|
||||
|
||||
For Debian / Ubuntu:
|
||||
```ssh
|
||||
apt-get install syslog-ng
|
||||
```
|
||||
|
||||
For CentOS / RedHat
|
||||
```ssh
|
||||
yum install syslog-ng
|
||||
```
|
||||
|
||||
Once syslog-ng is installed, edit the relevant config file (most likely /etc/syslog-ng/syslog-ng.conf) and paste the following:
|
||||
|
||||
```ssh
|
||||
# First, set some global options.
|
||||
options {
|
||||
chain_hostnames(0);
|
||||
flush_lines(0);
|
||||
use_dns(1); # Search name with DNS of the machine
|
||||
use_fqdn(1); # Use all FQDN name of the machine
|
||||
perm(0640);
|
||||
stats_freq(0);
|
||||
keep_hostname(0);
|
||||
log_fifo_size (1000);
|
||||
time_reopen (10);
|
||||
create_dirs (no);
|
||||
};
|
||||
|
||||
|
||||
source s_sys {
|
||||
system();
|
||||
internal();
|
||||
};
|
||||
|
||||
|
||||
source s_net {
|
||||
udp(port(514) flags(syslog-protocol));
|
||||
tcp(port(514) flags(syslog-protocol));
|
||||
};
|
||||
|
||||
|
||||
destination d_librenms {
|
||||
program("/opt/librenms/syslog.php" template ("$HOST||$FACILITY||$PRIORITY||$LEVEL||$TAG||$YEAR-$MONTH-$DAY $HOUR:$MIN:$SEC||$MSG||$PROGRAM\n") template-escape(yes));
|
||||
};
|
||||
|
||||
|
||||
log {
|
||||
source(s_net);
|
||||
source(s_sys);
|
||||
destination(d_librenms);
|
||||
};
|
||||
|
||||
|
||||
@include "/etc/syslog-ng/conf.d/"
|
||||
```
|
||||
|
||||
Next start syslog-ng:
|
||||
|
||||
```ssh
|
||||
service syslog-ng restart
|
||||
```
|
||||
|
||||
### Client configuration
|
||||
|
||||
Below are sample configurations for a variety of clients. You should understand the config before using it as you may want to make some slight changes.
|
||||
|
||||
Replace librenms.ip with IP or hostname of your LibreNMS install.
|
||||
|
||||
Replace any variables in <brackets> with the relevant information.
|
||||
|
||||
#### syslog
|
||||
```config
|
||||
*.* @librenms.ip
|
||||
```
|
||||
|
||||
#### rsyslog
|
||||
```config
|
||||
*.* @librenms.ip:514
|
||||
```
|
||||
|
||||
#### Cisco ASA
|
||||
```config
|
||||
logging enable
|
||||
logging timestamp
|
||||
logging buffer-size 200000
|
||||
logging buffered debugging
|
||||
logging trap notifications
|
||||
logging host <outside interface name> librenms.ip
|
||||
```
|
||||
|
||||
#### Cisco IOS
|
||||
```config
|
||||
logging trap debugging
|
||||
logging facility local6
|
||||
logging librenms.ip
|
||||
```
|
||||
|
||||
#### Cisco NXOS
|
||||
```config
|
||||
logging server librenms.ip 5 use-vrf default facility local6
|
||||
```
|
||||
|
||||
If you have permitted udp and tcp 514 through any firewall then that should be all you need. Logs should start appearing and displayed within the LibreNMS web ui.
|
||||
Reference in New Issue
Block a user