mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #11516 from SourceDoctor/rrdcached_doc_update

Browse Source 
Update RRDCached Documentation
This commit is contained in:
Tony Murray
2020-06-15 13:26:36 -05:00
committed by GitHub
parent 2a1e934bee f5d537ff18
commit 8c19cfeadd
1 changed files with 102 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

164
doc/Extensions/RRDCached.md
View File

@ -40,35 +40,16 @@ Features: Supported features in the version indicated.
It is recommended that you monitor your LibreNMS server with LibreNMS
so you can view the disk I/O usage delta.
## RRDCached installation CentOS 7
1: Create `/etc/systemd/system/rrdcached.service` with this content:
# Installation Manual for
```
[Unit]
Description=Data caching daemon for rrdtool
After=network.service
1. [RRDCached installation Ubuntu 16](#RRDCached-installation-Ubuntu-16)
1. [RRDCached installation Debian Buster](#RRDCached-installation-Debian-Buster)
1. [RRDCached installation Debian Stretch](#RRDCached-installation-Debian-Stretch)
1. [RRDCached installation CentOS 7](#RRDCached-installation-CentOS-7)
1. [RRDCached installation CentOS 6](#RRDCached-installation-CentOS-6)
1. [Securing RRCached](#Securing-RRCached)
[Service]
Type=forking
PIDFile=/run/rrdcached.pid
ExecStart=/usr/bin/rrdcached -w 1800 -z 1800 -f 3600 -s librenms -U librenms -G librenms -B -R -j /var/tmp -l unix:/run/rrdcached.sock -t 4 -F -b /opt/librenms/rrd/
[Install]
WantedBy=default.target
```
2: Start rrdcached
```bash
systemctl enable --now rrdcached.service
```
3: Edit `/opt/librenms/config.php` to include:
```php
$config['rrdcached'] = "unix:/run/rrdcached.sock";
```
## RRDCached installation Ubuntu 16
@ -110,40 +91,11 @@ systemctl restart rrdcached.service
5: Edit `/opt/librenms/config.php` to include:
```php
$config['rrdcached'] = "unix:/var/run/rrdcached.sock";
$config['rrdcached'] = "unix:/run/rrdcached.sock";
```
## RRDCached installation Debian Jessie (rrdcached 1.4.8)
1: Install rrdcached
```bash
sudo apt-get install rrdcached
```
2: Edit /etc/default/rrdcached to include:
```bash
OPTS="-s librenms"
OPTS="$OPTS -l unix:/var/run/rrdcached.sock"
OPTS="$OPTS -j /var/lib/rrdcached/journal/ -F"
OPTS="$OPTS -b /opt/librenms/rrd/ -B"
OPTS="$OPTS -w 1800 -z 1800 -f 3600 -t 4"
```
3: Restart the rrdcached service
```bash
systemctl restart rrdcached.service
```
4: Edit /opt/librenms/config.php to include:
```php
$config['rrdcached'] = "unix:/var/run/rrdcached.sock";
```
## RRDCached installation Debian Stretch (rrdcached 1.6.0)
## RRDCached installation Debian Buster
(rrdcached 1.7.1)
1: Install rrdcached
@ -161,7 +113,7 @@ WRITE_THREADS=4
BASE_PATH=/opt/librenms/rrd/
JOURNAL_PATH=/var/lib/rrdcached/journal/
PIDFILE=/var/run/rrdcached.pid
SOCKFILE=/var/run/rrdcached.sock
SOCKFILE=/run/rrdcached.sock
SOCKGROUP=librenms
DAEMON_GROUP=librenms
DAEMON_USER=librenms
@ -185,7 +137,7 @@ chown librenms:librenms /var/lib/rrdcached/journal/
For local RRDCached server
```php
$config['rrdcached'] = "unix:/var/run/rrdcached.sock";
$config['rrdcached'] = "unix:/run/rrdcached.sock";
```
For remote RRDCached server make sure you have network option in /var/default/rrdcached
@ -200,6 +152,94 @@ $config['rrdcached'] = "IPADDRESS:42217";
NOTE: change IPADDRESS to the ip the rrdcached server is listening on.
## RRDCached installation Debian Stretch
(rrdcached 1.6.0)
1: Install rrdcached
```bash
sudo apt-get install rrdcached
```
2; Edit /etc/default/rrdcached to include:
```bash
DAEMON=/usr/bin/rrdcached
WRITE_TIMEOUT=1800
WRITE_JITTER=1800
WRITE_THREADS=4
BASE_PATH=/opt/librenms/rrd/
JOURNAL_PATH=/var/lib/rrdcached/journal/
PIDFILE=/var/run/rrdcached.pid
SOCKFILE=/run/rrdcached.sock
SOCKGROUP=librenms
DAEMON_GROUP=librenms
DAEMON_USER=librenms
BASE_OPTIONS="-B -F -R"
```
3: Fix permissions
```bash
chown librenms:librenms /var/lib/rrdcached/journal/
```
4: Restart the rrdcached service
```bash
systemctl restart rrdcached.service
```
5: Edit /opt/librenms/config.php to include:
For local RRDCached server
```php
$config['rrdcached'] = "unix:/run/rrdcached.sock";
```
For remote RRDCached server make sure you have network option in /var/default/rrdcached
```bash
NETWORK_OPTIONS="-L"
```
```php
$config['rrdcached'] = "IPADDRESS:42217";
```
NOTE: change IPADDRESS to the ip the rrdcached server is listening on.
## RRDCached installation CentOS 7
1: Create `/etc/systemd/system/rrdcached.service` with this content:
```
[Unit]
Description=Data caching daemon for rrdtool
After=network.service
[Service]
Type=forking
PIDFile=/run/rrdcached.pid
ExecStart=/usr/bin/rrdcached -w 1800 -z 1800 -f 3600 -s librenms -U librenms -G librenms -B -R -j /var/tmp -l unix:/run/rrdcached.sock -t 4 -F -b /opt/librenms/rrd/
[Install]
WantedBy=default.target
```
2: Start rrdcached
```bash
systemctl enable --now rrdcached.service
```
3: Edit `/opt/librenms/config.php` to include:
```php
$config['rrdcached'] = "unix:/run/rrdcached.sock";
```
## RRDCached installation CentOS 6
This example is based on a fresh LibreNMS install, on a minimal CentOS 6 installation.
@ -223,7 +263,7 @@ vi /etc/yum.repos.d/rpmforge.repo
vi /etc/sysconfig/rrdcached
# Settings for rrdcached
OPTIONS="-w 1800 -z 1800 -f 3600 -s librenms -U librenms -G librenms -B -R -j /var/tmp -l unix:/var/run/rrdcached/rrdcached.sock -t 4 -F -b /opt/librenms/rrd/"
OPTIONS="-w 1800 -z 1800 -f 3600 -s librenms -U librenms -G librenms -B -R -j /var/tmp -l unix:/run/rrdcached.sock -t 4 -F -b /opt/librenms/rrd/"
RRDC_USER=librenms
mkdir /var/run/rrdcached
@ -237,7 +277,7 @@ service rrdcached start
- Edit /opt/librenms/config.php to include:
```php
$config['rrdcached'] = "unix:/var/run/rrdcached/rrdcached.sock";
$config['rrdcached'] = "unix:/run/rrdcached.sock";
```
# Verify