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

enh(doc): Add EN & FR chapters for data retention #7269

Merged
merged 3 commits into from
Mar 19, 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
47 changes: 47 additions & 0 deletions doc/en/administration_guide/data_retention.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
==============
Data retention
==============

By accessing to **Administration > Parameters > Options** menu you can define
retention durations for the Centreon platform:

.. image:: /images/guide_exploitation/data_retention.png
:align: center

************************
Performance data storage
************************

This setting is for the folders for storing performance data.
Performance data make it possible to visualize the performance graphs of the
collected metrics by the monitoring, to follow the evolution of the status of the
services, or to follow certain indicators of the collection engines.

.. warning::
These values were set during the installation process, it is not recommended
to change them.

* **Path to RRDTool Database For Metrics**: by default **/var/lib/centreon/metrics/**.
* **Path to RRDTool Database For Status**: by default **/var/lib/centreon/status/**.
* **Path to RRDTool Database For Monitoring Engine Statistics**: by default **/var/lib/centreon/nagios-perf/**.

*******************
Retention durations
*******************

Setting the retention time limits the size of the database:

* **Retention duration for reporting data (Dashboard)**: availability report data, by default **365 days**.
* **Retention duration for logs**: activity log of the monitoring engines, by default **31 days**.
* **Retention duration for performance data in MySQL database**: performance data stored into database, by default **365 days**
* **Retention duration for performance data in RRDTool databases**: graphs performance data, by default **180 days**.
* **Retention duration for downtimes**: downtimes data, unlimited by default (0 day).
* **Retention duration for comments**: comments data, unlimited by default (0 day).

.. note::
It is possible not to save performance data to the MySQL database if you are
not using extraction to add-on software such as Centreon MBI.

.. note::
If you change the retention time for performance charts, this value will only
be used for newly added services.
1 change: 1 addition & 0 deletions doc/en/administration_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Administration
extensions
media
parameters
data_retention
logs
backup
partitioning
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 48 additions & 0 deletions doc/fr/administration_guide/data_retention.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
=====================
Rétention des données
=====================

En accédant au menu **Administration > Paramètres > Options**, il est possible
de définir les durées de rétention des données de la plate-forme Centreon :

.. image:: /images/guide_exploitation/data_retention.png
:align: center

***********************************
Stockage des données de performance
***********************************

Ce paramétrage concerne les dossiers de stockage des données de performances.
Ces dernières permettent de visualiser les graphiques de performance des métriques
collectées par la supervision, de suivre l'évolution du statut des services, ou
encore de suivre certains indicateurs des moteurs de collectes.

.. warning::
Ces valeurs ont été paramétrées durant le processus d'installation, il
n'est pas recommandé de changer celles-ci.

* **Chemin d'accès vers les fichiers RRDTool pour les métriques** : par défaut **/var/lib/centreon/metrics/**.
* **Chemin d'accès vers les fichiers RRDTool pour les statuts** : par défaut **/var/lib/centreon/status/**.
* **Chemin vers la base de données RRDTool pour les statistiques du moteur de supervision**: par défaut **/var/lib/centreon/nagios-perf/**.

******************************
Durée de rétention des données
******************************

Le paramétrage de la durée de rétention permet de limiter la taille de la base de données :

* **Retention duration for reporting data (Dashboard)** : durée de rétention des données des rapports de disponibilité, par défaut **365 jours**.
* **Retention duration for logs** : durée de rétention du journal d'activité des moteurs de collecte, par défaut **31 jours**.
* **Retention duration for performance data in MySQL database** : durée de rétention des données de performance en base de données, par défaut **365 jours**
* **Retention duration for performance data in RRDTool databases** : durée de rétention des données de performance pour les graphiques de performance, par défaut **180 jours**.
* **Retention duration for downtimes** : durée de rétention des données des temps d'arrêts, par défaut illimité (0 jour).
* **Retention duration for comments** : durée de rétention des commentaires, par défaut illimité (0 jour).

.. note::
Il est possible de ne pas sauvegarder les données de performance en base
de données MySQL si vous n'utilisez pas d'extraction vers des logiciels
complémentaires tels que Centreon MBI.

.. note::
Si vous changez la durée de rétention pour les graphiques de performance,
cette valeur ne sera utilisée que pour les nouveaux services ajoutés.
1 change: 1 addition & 0 deletions doc/fr/administration_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Guide d'administration
extensions
media
parameters
data_retention
logs
backup
partitioning
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 16 additions & 28 deletions www/include/Administration/parameters/centstorage/help.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@
* Engine Status
*/

$help['tip_enable_centstorage_engine'] = dgettext('help', 'Enables Centstorage Engine.');
$help['tip_insert_in_index_data'] = dgettext('help', 'Enables resource\'s insertion in index_data.');
$help['tip_path_to_rrdtool_database_for_metrics'] = dgettext('help', 'Path to RRDTool database for graphs of metrics.');
$help['tip_path_to_rrdtool_database_for_status'] = dgettext('help', 'Path to RRDTool database for graphs of status.');
$help['tip_path_to_rrdtool_database_for_nagios_statistics'] = dgettext(
Expand All @@ -32,36 +30,10 @@
'Duration of retention regarding comments stored in database. 0 means that no retention will be applied.'
);

/**
* Purge options
*/

$help['tip_rrdtool_auto_delete'] = dgettext('help', 'Enables RRDTool auto purge system.');

/**
* Censtorage Core Options
*/

$help['tip_purge_check_interval'] = dgettext('help', 'Centstorage will check for data to purge every now and then.');

/**
* Input treatment options
*/

$help['tip_storage_type'] = dgettext('help', 'Storage Type.');

/**
* Drop possibility after parsing performance data
*/

$help['tip_drop_data_in_another_file'] = dgettext('help', 'Dumps data into another file.');
$help['tip_drop_file'] = dgettext('help', 'Dump file.');

/**
* Logs Integration Properties
*/

$help['tip_archive_nagios_logs'] = dgettext('help', 'Archives logs of monitoring engine.');
$help['tip_logs_retention_duration'] = dgettext(
'help',
'Retention duration of logs. 0 means that no retention will be applied.'
Expand All @@ -76,6 +48,22 @@
'Retention duration of reporting data. 0 means that no retention will be applied.'
);

/**
* Partitioning retention options
*/
$help['tip_partitioning_retention'] = dgettext(
'help',
'Retention time for partitioned tables (data_bin, logs, log_archive_host, log_archive_service), by default 365 days.'
);
$help['tip_partitioning_retention_forward'] = dgettext(
'help',
'number of partitions created in advance to prevent issues, by default 10 days.'
);
$help['tip_partitioning_backup_directory'] = dgettext(
'help',
'Backup directory to store partition, by default /var/cache/centreon/backup.'
);

/**
* Audit Logs
*/
Expand Down