Description

Shinken Entreprise V02.06.00 introduit un nouveau module permettant d'effectuer une sauvegarde automatique à intervalles réguliers de la base de données du Synchronizer.

Cela vous permettra, en cas de mauvaise manipulation, de restaurer facilement une ancienne version.

Par défaut, une sauvegarde est effectuée toutes les heures, et les données sont conservées pendant 21 jours. Ces paramètres sont configurables, et il est possible de définir des périodes pendant lesquelles la fréquence de sauvegarde est différente.

Cette fonctionnalité est activée automatiquement à l'installation d'une version 2.6 (ou ultérieure) mais aussi lors de la mise à jour depuis une version 2.5.

Ce module ne remplace pas une sauvegarde complète et régulière ! En effet, elle ne sauvegarde que les données de la base MongoDB du Synchronizer en l'état. Les fichiers de configuration, les logs, les SLA, les métriques et les données utilisateur ne sont pas traités par ce module.

Pour la gestion des sauvegardes complètes, veuillez-vous référer à Shinken-backup et Shinken-restore, les commandes de sauvegarde et de restauration.


La page Restaurer une sauvegarde automatique de la base de données du Synchronizer explique comment restaurer l'une de ces sauvegardes.


Activation du module

Le module synchronizer-module-database-backup est un module qui peut être activé seulement sur le démon Synchronizer.

  • L'activation du module s'effectue en ajoutant le nom de ce module dans le fichier de configuration du démon Synchronizer.
  • Pour ce faire, ouvrer le fichier de configuration du Synchronizer à l'emplacement /etc/shinken/synchronizers/, et ajouter le nom de votre module "synchronizer-module-database-backup".


Exemple: par défaut, nous livrons un module dont le nom est "synchronizer-module-database-backup":

define synchronizer {
    [...]
    modules                   Module 1, Module 2, Module 3, synchronizer-module-database-backup
    [...]
}


Pour prendre en compte le changement de configuration, redémarrer le Synchronizer:

service shinken-synchronizer restart


Configuration

La configuration du module se trouve par défaut dans le fichier  /etc/shinken/modules/synchronizer-module-database-backup.cfg

  • Vous trouverez aussi systématiquement un exemple dans /etc/shinken-user-example/configuration/daemons/synchronizers/modules/synchronizer-module-database-backup/synchronizer-module-database-backup.cfg


Exemple de fichier de configuration


#===============================================================================
# Configuration Database Backup
#===============================================================================
# Daemons that can load this module:
# - synchronizer
# This module backup the configuration mongo database
#===============================================================================


define module {

    # Shinken Enterprise. Lines added by import core. Do not remove it, it's used by Shinken Enterprise to update your objects if you re-import them.
    _SE_UUID             core-module-91dad8dedeac11e8a43d484d7eb6be52
    _SE_UUID_HASH        83f1c80c198953bd295e3e0b5b285939
    # End of Shinken Enterprise part

    #======== Module identity =========
    # Module name. Must be unique
    module_name                 synchronizer-module-database-backup

    # Module type (to load module code). Do not edit.
    module_type                 synchronizer_module_database_backup

    #======== Backup Rate =========
    # The default backup rate in minutes
    backup_rate                 60

    #======== Work hours  =========
    # You can use the work hours to define a period of time. During this time period, the rate will be modified. Disable by default
    enable_specific_backup_interval_during_working_hours             0

    # Set the works hours. Format is HH:MM
    #work_hours_start            08:00
    #work_hours_end              18:00
    # The days worked in the week to 0 (monday) to 6 (sunday). If not defined, all the days use this timeperiod
    #days_worked                 0-4

    # Rate to backup during non works hours in minutes
    #backup_interval_during_working_hours         15


    #======== Location and name =========
    backup_directory            /var/shinken-user/backup/synchronizer-module-database-backup
    backup_name                 synchronizer_localhost

    #======== Retention =========
    retention_days              21
}
  


Détails des sections composant le fichier de configuration

Identification du module

Il est possible de définir plusieurs instances de module de type MODULE-NAME. Chaque instance devra avoir un nom unique.

NomTypeUnitéDéfautCommentaire


module_name 


Texte---synchronizer-module-database-backupNous vous conseillons de choisir un nom en fonction de l'utilisation du module pour que votre configuration soit simple à maintenir.


module_type 


Texte---synchronizer_module_database_backupNe peut être modifié.


Fréquence de sauvegarde


   ... 
  #======== Backup Rate =========
  # The default backup rate in minutes
  backup_rate 60    
  ...


Description du chapitre


NomTypeUnitéDéfautCommentaire


 backup_rate 


Entierminutes60Définit fréquence à laquelle les sauvegarde de la base de données seront réalisées


xxxxx


   ... 
  #======== Work hours =========
  # You can use the work hours to define a period of time. During this time period, the rate will be modified. Disable by default
  enable_specific_backup_interval_during_working_hours 0

  # Set the works hours. Format is HH:MM
  #work_hours_start 08:00
  #work_hours_end 18:00
  # The days worked in the week to 0 (monday) to 6 (sunday). If not defined, all the days use this timeperiod
  #days_worked 0-4

  # Rate to backup during non works hours in minutes
  #backup_interval_during_working_hours 15    
  ...


Description du chapitre


Mettre tous les paramètres présents dans le chapitre de configuration


NomTypeUnitéDéfautCommentaire


XXXX 


XXXXXXXXXXXX


XXXX 


TexteXXXXXXXX







La sauvegarde est effectuée par un module nommé synchronizer-module-database-backup chargé dans le Synchronizer.

Le fichier de configuration est le suivant : /etc/shinken/modules/synchronizer-module-database-backup.cfg

Lorsque vous modifiez les paramètres de ce module, vous devez redémarrer le Synchronizer pour les prendre en compte.


Voici les paramètres relatifs à la définition des sauvegardes :

Nom du paramètreDescription

Valeur par défaut

backup_rateFréquence de sauvegarde (en minutes)60
enable_specific_backup_interval_during_working_hours

Permet de spécifier une fréquence de sauvegarde différente durant les "horaires de travail".

  • 0 = Périodes "horaires de travail" non activées
  • 1 = Périodes de travail activées
0
days_worked

Jours pendant lesquels les "horaires de travail" sont appliqués. 0=lundi, 6=dimanche

Ils sont spécifiés sous la forme d'un intervalle "jour_de_départ"-"jour_de_fin"

Exemple : 0-4 signifie "du lundi au vendredi"

0-6
work_hours_startPour chaque jour spécifié dans days_worked, heure de début de la période au format HH:MM (Obligatoire si enable_specific_backup_interval_during_working_hours est à 1)Aucun
work_hours_endPour chaque jour spécifié dans days_worked, heure de fin de la période au format HH:MM (Obligatoire si enable_specific_backup_interval_during_working_hours est à 1)Aucun
backup_interval_during_working_hoursFréquence de sauvegarde appliquée durant les horaires de travail (en minutes)15



Voici les paramètres système du module :

Nom du paramètreDescriptionValeur par défaut
backup_directoryRépertoire où les sauvegardes seront stockées/var/shinken-user/backup/synchronizer-module-database-backup
backup_nameChaîne de caractère qui sera ajoutée à l'horodatage pour former le nom des fichiers de sauvegardesynchronizer_localhost