Skip to content
This repository has been archived by the owner on Dec 13, 2022. It is now read-only.

fix(doc): update FAQ to install RRDCacheD on el7 #8052

Merged
merged 6 commits into from
Oct 31, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 57 additions & 20 deletions doc/en/faq/performance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,14 +79,16 @@ Centreon storage database schema can be view here :
RRDCacheD
*********

RRDCacheD is a process to reduce disk I/O during the update of performance's graphs and status' graphs.
The RRDCacheD process is loaded by the Centreon Broker module and mutualise I/O disques instead of recording
one by one the data from the collect.
RRDCacheD is a process to reduce disk I/O during the update of performance's graphs and status' graphs. The RRDCacheD
process is loaded by the Centreon Broker module and mutualise I/O disques instead of recording one by one the data from
the collect.

Installation
============

The RRDCacheD process is available in **rrdtool** package and already installed on your server.
Execute the following command: ::

# yum install rrdtool-cached

Configuration
=============
Expand All @@ -98,14 +100,13 @@ Edit the **/etc/sysconfig/rrdcached** file and complete information::

# Settings for rrdcached
OPTIONS="-m 664 -l unix:/var/rrdtool/rrdcached/rrdcached.sock -s rrdcached -b /var/rrdtool/rrdcached -w 3600 -z 3600 -f 7200"
RRDC_USER=rrdcach
RRDC_USER=rrdcached

.. note::
The order of setting is pretty important. If **-m 664** is define before **-l unix:/var/rrdtool/rrdcached/rrdcached.sock** option then rights will be incorrect on socket.

Options are following one:


+--------+-----------------------------------------------------------------------------------+
| Option | Description |
+========+===================================================================================+
Expand All @@ -118,44 +119,80 @@ Options are following one:
+--------+-----------------------------------------------------------------------------------+

.. note::
Please modify values with you needs.
Please modify values with your needs.

Creating the service startup file
*********************************

Replace the default **/usr/lib/systemd/system/rrdcached.service** init script: ::

# cp /usr/share/centreon/examples/rrdcached.systemd /usr/lib/systemd/system/rrdcached.service

Execute following commands: ::

mkdir -p /var/rrdtool
useradd rrdcached -d '/var/rrdtool/rrdcached' -G centreon-broker,centreon -m
chmod 775 -R /var/rrdtool

Groups configuration
********************

Create groups using commands::
Create groups using commands: ::

# usermod -a -g rrdcached centreon-broker
# usermod -a -g rrdcached apache
# usermod -a -g centreon rrdcached
# usermod -a -g centreon-broker rrdcached
# usermod -a -G rrdcached centreon-broker
# usermod -a -G rrdcached apache
# usermod -a -G centreon rrdcached
# usermod -a -G centreon-broker rrdcached

Restart Apache process::
Restart process: ::

# systemctl restart httpd24-httpd
# systemctl daemon-reload
# systemctl enable rrdcached
# systemctl start rrdcached

Start RRDCacheD process::
Check the status of the process: ::

# /etc/init.d/rrdcached start
# systemctl status rrdcached
● rrdcached.service - Data caching daemon for rrdtool
Loaded: loaded (/etc/systemd/system/rrdcached.service; disabled; vendor preset: disabled)
Active: active (running) since ven. 2018-10-26 10:14:08 UTC; 39min ago
Docs: man:rrdcached(1)
Main PID: 28811 (rrdcached)
CGroup: /system.slice/rrdcached.service
└─28811 /usr/bin/rrdcached -m 664 -l unix:/var/rrdtool/rrdcached/rrdcached.sock -s rrdcached -b /var/rrdtool/rrdcached -w 7200 -f 14400 -z 3600 -p /var/rrdtool/rrdcached/rrdcached.pid

oct. 26 10:14:08 demo-front rrdcached[28811]: starting up
oct. 26 10:14:08 demo-front systemd[1]: Started Data caching daemon for rrdtool.
oct. 26 10:14:08 demo-front rrdcached[28811]: listening for connections
oct. 26 10:14:08 demo-front systemd[1]: Starting Data caching daemon for rrdtool...

Centreon web configuration
**************************

Go to **Administration > Options > RRDTool** menu, enable process and set unix socket path:
Go to **Configuration > Pollers > Broker configuration** menu, select the broker inserting data into RRD files then in
the **Output** tab enable process and set unix socket path:

* Enable RRDCached: unix
* RRDCacheD listening socket/port: /var/rrdtool/rrdcached/rrdcached.sock

Enable process and set unix socket path:

.. image:: /images/faq/rrdcached_config.png
:align: center

.. warning::
Instead of configuration was made into **Administration** you need to generate and export configuration of central server and restart cbd process to apply changes.
Instead of configuration was made into **Administration** you need to generate and export configuration of central
server and restart cbd process to apply changes.

.. image:: /images/faq/rrd_file_generator.png
:align: center

Centreon web interface
**********************

RRDCacheD don't update performances graphs in real time. If a blank range appears on right of performances graphs it means that cache are not yet written to disk.
RRDCacheD don't update performances graphs in real time. If a blank range appears on right of performances graphs it
means that cache are not yet written to disk.

.. warning::
If the **RRDCacheD process crash** (in theory because it's a stable process) data will be lost! It is not possible to get data unless rebuild all graphs from Centreon web.
If the **RRDCacheD process crash** (in theory because it's a stable process) data will be lost! It is not possible
to get data unless rebuild all graphs from Centreon web.
Binary file modified doc/en/images/faq/rrdcached_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
73 changes: 54 additions & 19 deletions doc/fr/faq/performance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ cas où des index sont manquants les requêtes sont plus longues à être exécu
Synchronisation des index
*************************

Des fichiers d'index sont générées pour chaque version de Centreon depuis la version `2.4.0``.
Des fichiers d'index sont générées pour chaque version de Centreon depuis la version ``2.4.0``.
Ils sont situés dans le répertoire ``data`` normalement situé dans les répertoires ``bin``
ou ``www``. Il y a un fichier JSON pour chaque base de données:

Expand Down Expand Up @@ -79,15 +79,16 @@ Le schéma de la base de données Centreon_storage ici :
RRDCacheD
*********

RRDCacheD est un processus qui permet de limiter les E/S disque lors de la mise à jour des graphiques
de performance et/ou des graphiques de statut (fichiers RRDs).
Pour cela, le processus RRDCacheD est appelé par le module Centreon Broker et mutualise les écritures
sur disque plutôt que d'enregistrer une à une les données issues de la collecte.
RRDCacheD est un processus qui permet de limiter les E/S disque lors de la mise à jour des graphiques de performance
et/ou des graphiques de statut (fichiers RRDs). Pour cela, le processus RRDCacheD est appelé par le module Centreon
Broker et mutualise les écritures sur disque plutôt que d'enregistrer une à une les données issues de la collecte.

Installation
============

Le processus RRDCacheD est disponible dnas le paquet **rrdtool** déjà installé sur votre serveur Centreon.
Exécuter la commande suivante : ::

# yum install rrdtool-cached

Configuration
=============
Expand All @@ -98,11 +99,12 @@ Options générales
Éditer le fichier **/etc/sysconfig/rrdcached** et modifier les informations suivantes ::

# Settings for rrdcached
OPTIONS="-m 664 -l unix:/var/rrdtool/rrdcached/rrdcached.sock -s rrdcached -b /var/rrdtool/rrdcached -w 3600 -z 3600 -f 7200"
OPTIONS="-m 664 -l unix:/var/rrdtool/rrdcached/rrdcached.sock -s rrdcached -b /var/rrdtool/rrdcached -w 3600 -z 3600 -f 7200"
RRDC_USER=rrdcached

.. note::
L'ordre des options est très important, si l'option ** -m 664** est placée après l'option **-l unix:/var/rrdtool/rrdcached/rrdcached.sock** alors la socket sera créée avec les mauvais droits.
L'ordre des options est très important, si l'option ** -m 664** est placée après l'option
**-l unix:/var/rrdtool/rrdcached/rrdcached.sock** alors la socket sera créée avec les mauvais droits.

Concernant les autres options importantes :

Expand All @@ -123,34 +125,66 @@ Concernant les autres options importantes :
.. note::
Ces valeurs doivent être adaptées en fonction du besoin/des contraintes de la plate-forme concernée !

Création du fichier de démarrage du service
*******************************************

Remplacer le fichier par defaut **/usr/lib/systemd/system/rrdcached.service** : ::

# cp /usr/share/centreon/examples/rrdcached.systemd /usr/lib/systemd/system/rrdcached.service

Exécuter les actions suivantes : ::

mkdir -p /var/rrdtool
useradd rrdcached -d '/var/rrdtool/rrdcached' -G centreon-broker,centreon -m
chmod 775 -R /var/rrdtool

Configuration des groupes
*************************

Créer les groupes en exécutant les commandes suivantes ::

# usermod -a -g rrdcached centreon-broker
# usermod -a -g rrdcached apache
# usermod -a -g centreon rrdcached
# usermod -a -g centreon-broker rrdcached
# usermod -a -G rrdcached centreon-broker
# usermod -a -G rrdcached apache
# usermod -a -G centreon rrdcached
# usermod -a -G centreon-broker rrdcached

Redémarrer le processus Apache pour prendre en compte les modifications ::
Redémarrer les processus : ::

# systemctl restart httpd24-httpd
# systemctl daemon-reload
# systemctl enable rrdcached
# systemctl start rrdcached

Démarrer le processus RRDCacheD ::
Contrôler le statut du processus : ::

# /etc/init.d/rrdcached start
# systemctl status rrdcached
● rrdcached.service - Data caching daemon for rrdtool
Loaded: loaded (/etc/systemd/system/rrdcached.service; disabled; vendor preset: disabled)
Active: active (running) since ven. 2018-10-26 10:14:08 UTC; 39min ago
Docs: man:rrdcached(1)
Main PID: 28811 (rrdcached)
CGroup: /system.slice/rrdcached.service
└─28811 /usr/bin/rrdcached -m 664 -l unix:/var/rrdtool/rrdcached/rrdcached.sock -s rrdcached -b /var/rrdtool/rrdcached -w 7200 -f 14400 -z 3600 -p /var/rrdtool/rrdcached/rrdcached.pid

oct. 26 10:14:08 demo-front rrdcached[28811]: starting up
oct. 26 10:14:08 demo-front systemd[1]: Started Data caching daemon for rrdtool.
oct. 26 10:14:08 demo-front rrdcached[28811]: listening for connections
oct. 26 10:14:08 demo-front systemd[1]: Starting Data caching daemon for rrdtool...

Configurer le processus dans l'interface web Centreon
*****************************************************

Se rendre dans le menu **Administration > Options > RRDTool**, activer l'utilisation du processus et renseigner l'accès au socket **/var/rrdtool/rrdcached/rrdcached.sock** :
Se rendre dans le menu **Configuration > Pollers > Broker configuration**, éditer le broker insérant les données dans
les fichiers RRD, sans l'onglet "Output" renseigner les données suivantes :

* Enable RRDCached: unix
* RRDCacheD listening socket/port: /var/rrdtool/rrdcached/rrdcached.sock

.. image:: /images/faq/rrdcached_config.png
:align: center

.. warning::
Attention, même si la modification a été réalisé dans le menu **Administration**, il est nécessaire d'exporter la configuration et de redémarrer le processus centreon-broker via un export de la configuration du serveur central et un redémarrage du processus cbd.
Attention, même si la modification a été réalisé, il est nécessaire d'exporter la configuration et de redémarrer le
processus centreon-broker via un export de la configuration du serveur central et un redémarrage du processus cbd.

.. image:: /images/faq/rrd_file_generator.png
:align: center
Expand All @@ -163,4 +197,5 @@ Il est donc possible de voir un petit blanc sur la droite de certains graphiques
Cela veut dire que les données sont encore dans le cache du processus, cela est normal !

.. warning::
Attention, si le **processus crash** pour une raison quelconque (aucune en théorie c'est plutôt stable), les **données** sont **perdues**, donc aucun moyen de les rejouer sauf en reconstruisant les graphiques via centreon-broker.
Attention, si le **processus crash** pour une raison quelconque (aucune en théorie c'est plutôt stable), les
**données** sont **perdues**, donc aucun moyen de les rejouer sauf en reconstruisant les graphiques via centreon-broker.
Binary file modified doc/fr/images/faq/rrdcached_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions tmpl/install/redhat/rrdcached.systemd
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[Unit]
Description=Data caching daemon for rrdtool
Documentation=man:rrdcached(1)

[Service]
# If you enable socket-activable rrdcached.socket,
# command line socket declarations will be ignored
PIDFile=/var/rrdtool/rrdcached/rrdcached.pid
EnvironmentFile=/etc/sysconfig/rrdcached
ExecStart=/usr/bin/rrdcached $OPTIONS -p /var/rrdtool/rrdcached/rrdcached.pid
User=rrdcached

[Install]
WantedBy=multi-user.target