Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scroll Ignore
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltruefalse
Panel
titleSommaire

Table of Contents
stylenone

Description

Contexte

Le module de type livedata_module_sla_provider est un module qui permet au module de type broker-_module-_livedata du Broker de fournir une API de consultation des données SLA archivées.

  • /api/v1v2/sla
  • Il récupère les données SLA SLAs présentes dans la base de données Shinken, les données SLA sont calculées à la fin de la journée, donc   la dernière donnée disponible est celle d'hier.

Pour plus de détails sur cette API , vous pouvez consulter sa documentation d'utilisation.

Activation

Activation du module

Activer le module livedata-module-sla-provider livré par défaut

Par défaut, l’installation ou la mise à jour de Shinken Entreprise va mettre à disposition une définition du module  de type "Le module de type livedata_module_sla_provider est un module qui peut être activé seulement sur le module broker-module-livedata." appelé "livedata-module-sla-provider-example".

  • La configuration de ce module se trouve par défaut dans le fichier : /etc/shinken/modules/livedata-module-sla-provider.cfg
  • L'activation de ce

    L'activation du

    module s'effectue en ajoutant

    le

    son nom

    de ce module

    dans le fichier de configuration du module /etc/shinken/modules/broker-module-livedata.

    Pour ce faire, ouvrez le fichier de configuration

    cfg ( ou le .cfg qui est utilisé pour définir les options du broker-module-livedata

    . à l'emplacement /etc/shinken/modules/, et ajouter le nom de votre module. 
Exemple: par défaut, nous livrons un module dont le nom est "livedata-module-sla-provider":
  • ).

    Exemple :

    Code Block
    languagejs
    theme
bash
  • Confluence
    define 
module
  • broker {
        [...]
    
        module_name				  broker-module-livedata
    
        [...]
    
        modules                   Module 1, Module 2, Module 3, livedata-module-sla-provider
    
       
 
  •  [...]
    } 
  • Pour prendre en compte le changement de configuration, il faut ensuite redémarrer l'Arbiter :

code
  • No Format
    service shinken-arbiter restart
Info

Il ne peut y avoir qu'un seul module de type livedata_module_sla_provider par module broker-module-livedata.

Info

Si vous avez plusieurs modules S'il y a plusieurs modules broker-module-livedata  présents dans votre l'architecture, n'oubliez pas il ne faut pas oublier d'activer le module de type livedata_module_sla_provider dans la configuration de chacune d'elles.

Configuration

La configuration du module se trouve par défaut dans le fichier /etc/shinken/modules/livedata-module-sla-provider.cfg

  • Vous trouverez aussi systématiquement un exemple dans /etc/shinken-user-example/configuration/daemons/brokers/modules/broker-module-livedata/modules/livedata-module-sla-provider/livedata-module-sla-provider-example.cfg

Configurer le module de type livedata_module_sla_provider

  • Pour pouvoir définir ce module selon les besoins, il sera possible de définir le module grâce au module d'exemple fourni par défaut.


    Pour configurer le module de type livedata_module_sla_provider, commencez par choisir un nom à lui donner.

    • Pour l'exemple, on l'appele "Mon-Module-Livedata-Sla-Provider".
    • Remplacer dans l'exemple le mot "Mon-Module-Livedata-Sla-Provider" par le nom qui a été choisi.


    Pour définir le module à partir du module fourni par défaut, il faut : 

    • Copier le fichier de définition du module d'exemple : /etc/shinken-user-example/configuration/daemons/brokers/modules/broker-module-livedata/modules/livedata-module-sla-provider/livedata-module-sla-provider-example.cfg dans le répertoire de définition des modules  /etc/shinken/modules/ .
      ( Exemple : /etc/shinken/modules/livedata-module-sla-provider__Mon-Module-Livedata-Sla-Provider.cfg )


      Code Block
      languagetext
      themeEmacs
      cp /etc/shinken-user-example/configuration/daemons/brokers/modules/broker-module-livedata/modules/livedata-module-sla-provider/livedata-module-sla-provider-example.cfg /etc/shinken/modules/livedata-module-sla-provider__Mon-Module-Livedata-Sla-Provider.cfg
    • Ouvrer ce fichier ( livedata-module-sla-provider__Mon-Module-Livedata-Sla-Provider.cfg ) :

      • Modifier la ligne module_name en remplaçant le nom par défaut "livedata-module-sla-provider" par le nom qui a été choisi "Mon-Module-Livedata-Sla-Provider".

        Code Block
        languagejs
        themeConfluence
        ...     
        	# ─── Module name [ Must be unique ]                                                      [ MANDATORY ] ───
            # ───

Exemple de fichier de configuration

Code Block
languagejs
#================================================================================ # livedata_module_sla_provider #================================================================================ # Modules that can load this module: # - broker-module-livedata (to add new route to this module) # This module is an API providing information on SLA of monitored elements #================================================================================ define module { # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ # # │ ────────────────────────────────────── MODULE IDENTITY ────────────────────────────────────── │ # # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ # # ─── Module name [ Must be unique ]
      •                                                       
[
      •  
MANDATORY
      •  
]
      •  
───
      •     
#
      •  
───
      •                                      ───
            module_name                                         Mon-Module-Livedata-Sla-Provider  
        ...
        
    • Une fois que le fichier a été édité, vérifiez que le fichier possède comme droits utilisateurs shinken. Si ce n'est pas le cas, effectuez la commande suivante :

      Code Block
      languagetext
      themeEmacs
      chown -R shinken:shinken /etc/shinken/modules/livedata-module-sla-provider__Mon-Module-Livedata-Sla-Provider.cfg
    • Ajouter le nom du nouveau module au module broker-module-livedata en modifiant le paramètre modules du fichier /etc/shinken/modules/broker-module-livedata.cfg ( ou le .cfg qui est utilisé pour définir les options du broker-module-livedata ).

      Code Block
      languagejs
      themeConfluence
      define module { 
      	[...] 
      	modules       					Module 1, Module 2, Module 3, Mon-Module-Livedata-Sla-Provider     
      	[...] 
      }


    • Redémarrez l'Arbiter pour que le Broker puisse prendre en compte ce nouveau module.

      Code Block
      languagetext
      themeEmacs
      service shinken-arbiter restart

Configuration

Voici le détail de fichier de configuration du module qui se trouve :

  • Soit le fichier /etc/shinken/modules/livedata-module-sla-provider.cfg ( livré par défaut )
  • Soit dans le fichier qui vient d'être créé en ajoutant le module ( par exemple /etc/shinken/modules/livedata-module-sla-provider__Module-Livedata-Sla-Provider.cfg )

Exemple de fichier de configuration

Code Block
languagejs
themeConfluence
# CFG_FORMAT_VERSION 1 ( SHINKEN : DON'T TOUCH THIS LINE )

#================================================================================
# livedata_module_sla_provider
#================================================================================
# Modules that can load this module:
# - broker-module-livedata (to add new route to this module)
# This module is an API providing information on SLA of monitored elements
#================================================================================

define module {

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────    MODULE IDENTITY    ────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Module name [ Must be unique ]                                     ───
    module_name                                         livedata-module-sla-provider

    # ─── Module type [ Do not edit ]                                                         [ MANDATORY ] ───
    # ───                                                                                                   ───
    module_type                     [ MANDATORY ] ───
    #   ───          livedata_module_sla_provider

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    #  ────────────────────────────────────    DATABASE CONNECTION    ────────────────────────────────────  #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─────────────────  MongoDB parameters  ────────────────────────────────────────────────────────────────── 

    # ─── MongoDB uri definition . You can find the mongodb uri syntax at                                   ───
    module_name # ─── https://docs.mongodb.com/manual/reference/connection-string/                                      ───livedata-module-sla-provider

    # ─── Module type [ Do not edit ]                                                         [ MANDATORY ] ───
    # ───                              ───
    #           Default : mongodb://localhost/?w=1&fsync=false                                              ───
    #  ───
    module_type                                         livedata_module_sla_provider

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    #  ────────────────────────────────────    DATABASE CONNECTION    ────────────────────────────────────  #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─────────────────  MongoDB parameters  ──────────────────────────────────────────────────────────────── #

    # ─── MongoDB uri definition . You can find the mongodb uri ───
syntax at   # livedata_module_sla_provider__database__uri         mongodb://localhost/?w=1&fsync=false

    # ─── Which database contains sla data            ───
    # ─── https://docs.mongodb.com/manual/reference/connection-string/                                      ───
    #       ───
    #                                                                                            ───
    #       ───
    #Default : mongodb://localhost/?w=1&fsync=false         Default : shinken                                   ───
    # ───                                   ───
    #                                                            ───
    # broker__module_livedata__module_sla_provider__database__uri mongodb://localhost/?w=1&fsync=false

    # ─── Which database contains sla data                           ───
    # livedata_module_sla_provider__database__name        shinken

    # ─── SSH tunnel activation to secure your mongodb connection             ───
    #                          ───
    # ─── That will allow all mongodb to be encrypted & authenticated with SSH                              ───
    #                          ───
    #           Default : shinken                                                            ───
    #           Default───
 : 0 => Disable# (─── disable ssh tunnel )                                               ───
    #           ...     : 1 => Enable  ( enable ssh tunnel )                   ───
    # broker__module_livedata__module_sla_provider__database__name shinken

    # ─── username/password to authenticate to MongoDB.             ───
    #                                    ───
    # ─── Both parameters must be provided for authentication to function correctly.                        ───
    # ───                       ───
    # livedata_module_sla_provider__use_ssh_tunnel        0

    # ─── SSH user to connect to the mongodb server.                                                   ───
     ───# broker__module_livedata__module_sla_provider__database__username

    #    ───                                                                                                   ───
    # broker__module_livedata__module_sla_provider__database__password

    # ─── SSH tunnel activation to secure your Defaultmongodb :connection shinken                                          ───
    # ─── That will allow all mongodb to be encrypted & authenticated with SSH                ───
    #          ───
    #                                                                                         ───
    # livedata_module_sla_provider__ssh_user         ───
    # shinken

    # ─── SSH keyfile to connect toDefault the: mongodb0 server.=> Disable ( disable ssh tunnel )                                               ───
    #           ...     : 1 => Enable  ( enable ssh tunnel )                                                ───
    # ───                         ───
    #           Default : ~shinken/.ssh/id_rsa                                                              ───
    #     broker__module_livedata__module_sla_provider__use_ssh_tunnel 0

    # ─── SSH user to connect to the mongodb server.                                                        ───
    #                          ───
    # livedata_module_sla_provider__ssh_keyfile           ~shinken/.ssh/id_rsa

    # ─── SSH Timeout used to test if the SSH tunnel is viable or not, in seconds.                          ───
    #           ───
    #           Default : shinken                                                                           ───
    # ───          Default : 10 ( seconds )                                                                    ───
    #            ───
              # broker__module_livedata__module_sla_provider__ssh_user shinken

    # ─── SSH keyfile to connect to the             mongodb server.                                                     ───
    # livedata_module_sla_provider__ssh_tunnel_timeout    10

    # ──────────────  AutoReconnect Management  ─────────────────────────────────────────────────────────────── 

    # ─── When MongoDB require you to reconnect ( For example, It can occur when a new PRIMARY is elected   ───
    # ─── in a MongoDB cluster ), it will raised the MongoDB AutoReconnect exception.                       ───

    # ─── How many try to reconnect before module go in error      ───
    #           Default : ~shinken/.ssh/id_rsa                        ───
    #                                  ───
    # ───                                                                 ───
     #           Default : 4 ( number of try )           ───
    # broker__module_livedata__module_sla_provider__ssh_keyfile ~shinken/.ssh/id_rsa

    # ─── SSH Timeout used to test if the SSH tunnel is viable or not, in seconds.                          ───
    #                                                                                                       ───
    # livedata_module_sla_provider__database__retry_connection_X_times_before_considering_an_error 4

    # ─── Time between each tryDefault : 10 ( seconds )                                                                    ───
    # ───
    #                                                                                               ───
    #    ───broker__module_livedata__module_sla_provider__ssh_tunnel_timeout 10

    # ──────────────  AutoReconnect Management  ───────────────────────────────────────────────────────────── #

    Default# :─── 3When (MongoDB secondsrequire )you to reconnect ( For example, It can occur when a new PRIMARY is elected   ───
    # ─── in a MongoDB cluster ), it will raised the MongoDB AutoReconnect exception.                       ───

    # ─── How many try to reconnect before ───
module go in error #                                              ───
    #                                                     ───
    # livedata_module_sla_provider__database__wait_X_seconds_before_reconnect 3

           # ─── NOTE: Change these values only if you have a MongoDB cluster and you change the                   ───
    # ───       heartbeatTimeoutSecs of your MongoDBDefault replica: set4 ( number of try )                                       ───
    # ───       The value of          ───
    # ───                                                                 ───
    # ───       retry_connection_X_times_before_considering_an_error * wait_X_seconds_before_reconnect      ───
    # ───       must be higher───
 than heartbeatTimeoutSecs in the rs.conf(); of your MongoDB replica set.     ───

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────    SLA CALCULATION    ────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── No_data periods ( "Missing data" and "Shinken inactive" status )# broker__module_livedata__module_sla_provider__database__retry_connection_X_times_before_considering_an_error 4

    # ─── Time between each try                                                                             ───
    #                                                                                                       ───
    #           Default : include => Only status is considered. "Missing data" and "Shinken inactive"3 ( seconds )               ───
    #                                status are counted negatively in the SLA.            ───
    # ───             ───
    #           ...     : exclude => No_data are not counted from SLA considered period.                    ───
    #           ...     : ok      => No_data are considered as UP periods.   ───
    # broker__module_livedata__module_sla_provider__database__wait_X_seconds_before_reconnect 3

    # ─── NOTE: Change these values only if you have a MongoDB cluster and you change the     ───
    #          ───
    # ───       heartbeatTimeoutSecs of your MongoDB replica set                                            ───
    # ───       The value of                                                                                ───
    # livedata_module_sla_provider__no_data_period  ───       retry_connection_X_times_before_considering_an_error * wait_X_seconds_before_reconnect      include

}

Détails des sections composant le fichier de configuration

Identification du module

Il est possible de définir plusieurs instances de module de type livedata-module-sla-provider dans votre architecture Shinken.

  • Chaque instance devra avoir un nom unique.
───
    # ───       must be higher than heartbeatTimeoutSecs in the rs.conf(); of your MongoDB replica set.     ───

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────    SLA CALCULATION    ────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── No_data periods ( "Missing data" and "Shinken inactive" status )                                  ───
    #                                                                                                       ───
    #           Default : include => Only status is considered. "Missing data" and "Shinken inactive"       ───
    #                                status are counted negatively in the SLA.                              ───
    #           ...     : exclude => No_data are not counted from SLA considered period.                    ───
    #           ...     : ok      => No_data are considered as UP periods.                                  ───
    # ───                                                                                                   ───
    # broker__module_livedata__module_sla_provider__no_data_period include

}
 

Détails des sections composant le fichier de configuration

Identification du module

Il est possible de définir plusieurs instances de module de type livedata-module-sla-provider   dans l'architecture Shinken .

  • Chaque instance devra avoir un nom unique.


Scroll Title
anchorparameter_cfg
title
NomTypeUnitéDéfautDescription
No Format
module_name 
Texte--- livedata-module-sla-provider

Il est conseillé de choisir un nom en fonction de l'utilisation du module pour que la configuration soit simple à maintenir.

Doit être unique.

No Format
module_type 
Texte--- livedata_module_sla_provider Ne dois pas être modifié.



Accès à la base MongoDB

Cette configuration s'effectue dans le fichier de configuration du module. 

Pour se connecter à la base MongoDB utilisée pour le stockage des données, 2 méthodes sont disponibles :

  • Connexion directe: Par défaut, mais non sécurisée.
  • Tunnel SSH: Shinken se connecte à la base MongoDB au travers d'un module SSH pour plus de sécurité
Configuration de l'URI de connexion et de l'authentification par mot de passe
Code Block
languagejs
themeConfluence
    # ─────────────────  MongoDB parameters  ──────────────────────────────────────────────────────────────── #

    # ─── MongoDB uri definition . You can find the mongodb uri syntax at                                   ───
    # ─── https://docs.mongodb.com/manual/reference/connection-string/                                      ───
    #                                                                                                       ───
    #           Default : mongodb://localhost/?w=1&fsync=false                                              ───
    # ───                                                                                                   ───
    # broker__module_livedata__module_sla_provider__database__uri mongodb://localhost/?w=1&fsync=false
NomTypeUnitéDéfautCommentaire
Code Block
module_name 
Texte---livedata-module-sla-provider

Nous vous conseillons de choisir un nom en fonction de l'utilisation du module pour que votre configuration soit simple à maintenir.

Doit être unique.

Code Block
module_type 
Texte---livedata_module_sla_providerNe peut être modifié.

Accès à la base MongoDB

Cette configuration s'effectue dans le fichier de configuration du module. 

Pour se connecter à la base MongoDB utilisée pour le stockage des données, 2 méthodes sont disponibles:

  • Connexion directe : Par défaut, mais non sécurisée.
  • Tunnel SSH : Shinken se connecte à la base MongoDB au travers d'un module SSH pour plus de sécurité
Configuration des paramètres communs aux deux méthodes
Code Block
languagejs
themeConfluence
    # ─────────────────  MongoDB parameters  ──────────────────────────────────────────────────────────────────
 
    # ─── MongoDB uri definition . You can find the mongodb uri syntax atWhich database contains sla data                                                   ───
    # ─── https://docs.mongodb.com/manual/reference/connection-string/         ───
    #                         ───
    #                                                                          ───
    #           Default : shinken            ───
    #           Default : mongodb://localhost/?w=1&fsync=false                                              ───
    #    ───                                                                                                   ───
    # broker__module_livedata__module_sla_provider__database__uriname         mongodb://localhost/?w=1&fsync=false
 shinken  

    # ─── Whichusername/password databaseto containsauthenticate sla data             to MongoDB.                                                     ───
    # ─── Both parameters must be provided for authentication to function correctly.                        ───
           # ───                                                         ───
    #           Default : shinken                         ───
    # broker__module_livedata__module_sla_provider__database__username

    # ───                                        ───
    #                                                       ───
                                                ───
    # livedata_# broker__module_livedata__module_sla_provider__database__password
Scroll Title
anchorparameter_cfg
title
NomTypeUnitéDéfautDescription
No Format
broker__module_livedata__module_sla_provider__database_uri
TexteURL mongodb://localhost/?w=1&fsync=false La description de la syntaxe de l'URI de MongoDB est disponible à l'adresse suivante https://docs.mongodb.com/manual/reference/connection-string/
No Format
broker__module_livedata__module_sla_provider__database__name
shinken
NomTypeUnitéDéfautCommentaire Code Block
Texte--- shinken Nom de la base de données où sont stockées les données SLA.
No Format
broker__module_livedata__
livedata_
module_sla_provider__database_
uri
_username
Texte
URLmongodb://localhost/?w=1&fsync=falseURL mongo de connexion à la base de données cf. https://docs.mongodb.com/manual/reference/connection-string/ Code Block
---

Utilisateur pour l'authentification avec mot de passe à la base MongoDB.

Utile uniquement si l'activation par mot de passe a été activé ( voir la page MongoDB - activation de l'authentification par mot de passe )

No Format
broker__module_livedata_
livedata
_module_sla_provider__database__
name
password
Texte---
shinkenNom de la base de données où sont stockés les données SLA

Mot de passe de l'utilisateur utilisé pour l'authentification avec mot de passe à la base MongoDB.

Utile uniquement si l'activation par mot de passe a été activé ( voir la page MongoDB - activation de l'authentification par mot de passe )

Connexion directe au serveur MongoDB

Par défaut, le module se connecte de manière directe à la base MongoDB, définie avec les paramètres communs listés ci-dessus, car le paramètre "use_ssh_tunnel" est à 0.

Connexion par SSH au serveur MongoDB

Par défaut, le module se connecte de manière directe à la base MongoDB pour y lire et écrire les données.
Dans la configuration du module, on sait que la connexion se fait de manière directe lorsque le ceci correspond au paramètre "use_ssh_tunnel" est à 0.

Cette

C'est la méthode de connexion

a pour avantage d'être facile à configurer au niveau de Shinken.
  • Par contre, elle oblige à permettre l'accès à la base MongoDB au monde extérieur, et donc s'exposer à des problèmes de sécurité.
  • par défaut lorsque la base est sur la même machine que le démon ( quand l'URL de la base est localhost ).

    Si la base est sur une autre machine, il faudra alors se connecter à la base via un tunnel SSH. Cela permet à la base distance de rester en écoute réseau sur l'interface réseau local, ce qui la sécurise des accès extérieurs ( voir la pageLa sécurisation de la base MongoDB est bien sûr toujours possible ( voir Sécurisation des connexions aux bases MongoDB  ), mais bien plus complexe à mettre en place.

    La méthode de connexion par SSH est donc préférable pour des raisons pratiques et de sécurité.

    Code Block
    languagejs
    themeConfluence
     	# ─── SSH tunnel activation to secure your mongodb connection                                           ───
        # ─── That will allow all mongodb to be encrypted & authenticated with SSH                              ───
        #                                                                                                       ───
        #           Default : 0 => Disable ( disable ssh tunnel )                                               ───
        #           ...     : 1 => Enable  ( enable ssh tunnel )                                                ───
        #                                                                                                       ───
        # broker__module_livedata__module_sla_provider__use_ssh_tunnel        0
     
        # ─── SSH user to connect to the mongodb server.                                                        ───
        #                                                                                                       ───
        #           Default : shinken                                                                           ───
        #                                                                                                       ───
        # broker__module_livedata__module_sla_provider__ssh_user              shinken
     
        # ─── SSH keyfile to connect to the mongodb server.                                                     ───
        #                                                                                                       ───
        #           Default : ~shinken/.ssh/id_rsa                                                              ───
        #                                                                                                       ───
        # broker__module_livedata__module_sla_provider__ssh_keyfile           ~shinken/.ssh/id_rsa
     
        # ─── SSH Timeout used to test if the SSH tunnel is viable or not, in seconds.                          ───
        #                                                                                                       ───
        #           Default : 10 ( seconds )                                                                    ───
        #                                                                                                       ───
        # broker__module_livedata__module_sla_provider__ssh_tunnel_timeout    10    10
    Scroll Title
    anchorparameter_cfg
    title

    Le module peut également se connecter par tunnel SSH à la base MongoDB, pour des raisons de sécurité.

    En effet, le paramétrage de MongoDB permet de définir sur quelle interface réseau ce dernier écoute les requêtes.
    En n'autorisant seulement interface réseau avec l'adresse 127.0.0.1, cela évite d'ouvrir la base au monde extérieur.

    Dans la configuration de la base MongoDB ( /etc/mongod.conf ), assurez-vous que le paramètre "bind_ip" est positionné pour n'écouter que sur l'interface locale:

    • bind_ip=127.0.0.1
    Dans cette configuration la base MongoDB écoute que sur l'interface réseau local, pour que le module se connecte, il faut passer par un tunnel SSH. Pour ce faire, activez les options suivantes :
    NomTypeUnitéDéfaut
    Commentaire
    Description
    code
    No Format
    broker__module_livedata__module_sla_provider__use_ssh_tunnel
    Booléen--- 0
    • 1 : Connexion par tunnel SSH
    • 0 : Connexion directe
    code
    No Format
    broker__module_livedata__module_sla_provider__ssh_user
    TexteUtilisateur unix shinken L'utilisateur avec lequel le tunnel sera établi
    .
    No Format
    broker__module_livedata_
    Code Blocklivedata
    _module_sla_provider__ssh_keyfile
    TexteChemin de fichier ~shinken/.ssh/id_rsa

    La clé SSH privée présente sur le serveur Shinken qui sera utilisé pour établir

    le tunnel.
    Code Block
    livedata_module_sla_provider__ssh_tunnel_timeout
    EntierSecondes10Spécifie

    le

    timeout en secondes de la vérification du

    tunnel

    SSH avant que la connexion vers MongoDB soit effectuéeLe tunnel SSH va permettre au module de se connecter comme si ses requêtes étaient locales à la base MongoDB ( en 127

    .

    0.0.1 )
  • Connectez-vous avec l'utilisateur lançant le démon sur le serveur Shinken
  • Générez la paire de clés SSH si nécessaire
  • Copiez la clé publique sur le serveur mongo
    Copie de la clé SSH

    No Format
    broker__module_livedata__module_sla_provider__ssh_tunnel_timeout
    EntierSeconde 10
    Spécifie le timeout en secondes de la vérification du tunnel SSH avant que la connexion versMongoDB soit effectuée

    root@serveur_shinken # su - shinken
    shinken@serveur_shinken $ ssh-keygen
    shinken@serveur_shinken $ ssh-copy-id user_distant@serveur_mongo
    [...]
    shinken@serveur_shinken $ ssh user_distant@serveur_mongo
    user_distant@serveur_mongo $

    Cette manipulation est aussi nécessaire dans le cas où la base MongoDB est sur le même serveur que le module, même si le tunnel est ouvert localement
    .
    Gestion de la reconnexion automatique avec un
    cluster MongoDB
    cluster MongoDB
    code
    Code Block
    languagejs
    themeConfluence
    	# ──────────────  AutoReconnect Management  ───────────────────────────────────────────────────────────────
     
        # ─── When MongoDB require you to reconnect ( For example, It can occur when a new PRIMARY is elected   ───
        # ─── in a MongoDB cluster ), it will raised the MongoDB AutoReconnect exception.                       ───
     
        # ─── How many try to reconnect before module go in error                                               ───
        #                                                                                                       ───
        #           Default : 4 ( number of try )                                                               ───
        #                                                                                                       ───
        # broker__module_livedata__module_sla_provider__database__retry_connection_X_times_before_considering_an_error 4
     
        # ─── Time between each try                                                                             ───
        #                                                                                                       ───
        #           Default : 3 ( seconds )                                                                     ───
        #                                                                                                       ───
        # broker__module_livedata__module_sla_provider__database__wait_X_seconds_before_reconnect 3
     
        # ─── NOTE: Change these values only if you have a MongoDB cluster and you change the                   ───
        # ───       heartbeatTimeoutSecs of your MongoDB replica set                                            ───
        # ───       The value of                                                                                ───
        # ───       retry_connection_X_times_before_considering_an_error * wait_X_seconds_before_reconnect      ───
        # ───       must be higher than heartbeatTimeoutSecs in the rs.conf(); of your MongoDB replica set.     ───
    Info
    titleDéfinitions
    • Primaire: nom de MongoDB pour désigner un serveur maître, le serveur sur lequel il est possible de faire des requêtes d'écriture dans la base. 
    • Election : processus de MongoDB pour choisir un nouveau membre Primaire si le membre Primaire devient inaccessible 

    Voir : ( voir la page Haute disponibilité de la base MongoDB (mise en place d'un cluster) )


    Dans le cas de l'utilisation d'un cluster MongoDB, lorsque le membre Primaire devient inaccessible, une nouvelle élection est déclenchée, ce qui provoque une coupure temporaire de l'accès à la base.

    Dans le but de ne pas interrompre le service, le module "livedataevent-modulemanager-sla-providerreader"  va va se reconnecter automatiquement au cluster MongoDB.
    Pour ce faire, il va faire un nombre d'essais égal égaux au paramètre "auto_reconnect_max_try " avec une pause de X secondes entre chaque essai ( correspondant au paramètre "auto_reconnect_sleep_between_try" ).

    Par défaut pour MongoDB le temps maximum avant qu'un membre Primaire soit considéré comme indisponible et qu'une nouvelle élection ait lieu est de 10 secondes.
    Voir : "heartbeatTimeoutSecs" donné par la commande rs.conf(); dans un shell de MongoDB.


    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfaut
    Commentaire
    Description
    code
    No Format
    broker__module_livedata__module_sla_provider__database__retry_connection_X_times_before_considering_an_error
    Entier
    essais
    --- 4

    Nombre d'essais de reconnexion à la

    base

    base.

                      
    No Format
    broker__module_livedata__
    Code Blocklivedata_
    module_sla_provider__database__wait_X_seconds_before_reconnect
    Entier
    secondes
    seconde 3

    Temps entre chaque essai en seconde.


    Les valeurs par défauts du fichier laissent 12 secondes, ce qui est amplement suffisant avec la configuration par défaut de MongoDB.


    Warning

    Il est conseillé de ne pas modifier ces valeurs.

    Paramétrage des états Données manquantes ( Missing data ) et Shinken inactif ( Shinken inactive )

    Code Block
    languagejs
    themeConfluence
     	# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
        # │ ──────────────────────────────────────    SLA CALCULATION    ────────────────────────────────────── │ #
        # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
     
        # ─── No_data periods ( "Missing data" and "Shinken inactive" status )                                  ───
        #                                                                                                       ───
        #           Default : include => Only status is considered. "Missing data" and "Shinken inactive"       ───
        #                                status are counted negatively in the SLA.                              ───
        #           ...     : exclude => No_data are not counted from SLA considered period.                    ───
        #           ...     : ok      => No_data are considered as UP periods.                                  ───
        #                                                                                                       ───
        # broker__module_livedata__module_sla_provider__no_data_period        include

    Les états Données manquantes ( Missing data ) et Shinken inactif ( Shinken inactive ) ont été regroupés dans un paramètre. Ce paramètre correspond à la période durant laquelle Shinken n'a pas effectué les vérifications pour un check ( plateforme Shinken éteinte, ou vérification du check désactivé grâce aux Périodes de temps, voir la page Périodes de temps ). Le statut de ces checks est donc Données manquantes ( "Missing data"  ) ou Shinken inactif ( "Shinken inactive"  ).


    Scroll Title
    anchorparameter_cfg
    title
    NomTypeUnitéDéfaut
    Commentaire
    Description
    code
    No Format
    broker__module_livedata__module_sla_provider__no_data_period
    Texte--- include

    Choix possible :

    • include : On considère que si l'on ne peut pas savoir si le service est rendu, c'est qu'il n'est pas rendu.

    • exclude : On considère que l'état de la supervision ( de Shinken ) n'impacte pas
    le taux
    • le taux de disponibilité.

    • ok : On considère que même si la supervision ne l'a pas confirmé, le service est rendu.