Description
Le module livedata-module-sla-provider est un module qui permet au module broker-module-livedata du Broker de fournir une API de consultation des données SLA archivées.
- /api/v1/sla
- Il récupère les données SLA présentes dans la base de données Shinken.
Pour plus de détails sur cette API, vous pouvez consulter sa documentation d'utilisation.
Activation
Le module livedata-module-sla-provider est un module qui peut être activé seulement sur le module broker-module-livedata.
- L'activation du module s'effectue en ajoutant le nom de ce module dans le fichier de configuration du module broker-module-livedata.
- Pour ce faire, ouvrez le fichier de configuration du broker-module-livedata. à l'emplacement /etc/shinken/modules/, et ajouter le nom de votre module "
livedata-module-sla-provider".
Exemple: par défaut, nous livrons un module dont le nom est "livedata-module-sla-provider":
define DEMON-TYPE {
[...]
modules Module 1, Module 2, Module 3, livedata-module-sla-provider
[...]
} |
Pour prendre en compte le changement de configuration, redémarrer l'Arbiter:
service shinken-arbiter restart |
Si vous avez plusieurs modules broker-module-livedata présents dans votre architecture, n'oubliez pas d'activer le module 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.cfg
Exemple de fichier de configuration
# =========================================================================================================== #
# ------------------------------- livedata_module_sla_provider -------------------------------- #
# =========================================================================================================== #
# --- Daemons that can load this module: ---
# --- => broker-module-livedata ---
# --- This module is an API providing information on SLA of moditored elements ---
#============================================================================================================ #
define module {
# ========================================== Module identity ======================================== #
# --- Module name [ Must be unique ] ---
module_name livedata-module-sla-provider
# --- Module type [ Do not edit ] ---
module_type livedata_module_sla_provider
# ======================================================================================================= #
# ------------------------------------ SLA Database connexion -------------------------------------- #
# ------------------------------------------------------------------------------------------------------- #
# ================= Mongo parameters =================== #
# #
# --- Mongodb uri definition ---
# >>> DEFAULT : mongodb://localhost/?w=1&fsync=false ---
livedata_module_sla_provider__uri mongodb://localhost/?w=1&fsync=false
# --- Which database contains sla data ---
# >>> DEFAULT : shinken ---
livedata_module_sla_provider__database shinken
# --- if the module encounter an issue to connect on the database, it will retry X times before ---
# --- considering it as a connexion error ---
# >>> DEFAULT : 2 ---
# livedata_module_sla_provider__database__retry_connection_X_times_before_considering_an_error 2
# --- If the module face a connection error to the database, it restart the connection process ---
# --- after X seconds ---
# >>> DEFAULT : 10 ---
# livedata_module_sla_provider__database__wait_X_seconds_before_reconnect 10
# ======== SSH Tunnel for Database connection ========== #
# #
# --- SSH tunnel activation to securize your mongodb connection ---
# --- That will allow all mongodb to be encrypted & authentificated with SSH ---
# >>> Disabled : 0 ( DEFAULT ) ---
# --- Enabled : 1 ---
# livedata_module_sla_provider__use_ssh_tunnel 0
# --- SSH user to connect to the mongodb server. ---
# >>> DEFAULT : shinken ---
# livedata_module_sla_provider__ssh_user shinken
# --- SSH keyfile to connect to the mongodb server. ---
# >>> DEFAULT : ~shinken/.ssh/id_rsa ---
# 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 ---
# livedata_module_sla_provider__ssh_tunnel_timeout 10
# ======================================================================================================= #
# ---------------------------------------- SLA calculation ----------------------------------------- #
# ------------------------------------------------------------------------------------------------------- #
# #
# --- Some status can impact ---
# --- Positively ( counted as OK / UP ) ---
# --- Negatively ( counted as CRITICAL / DOWN ) ---
# --- or not impact the SLA ( is not counted, meaning the period of study is reduced by the period ---
# --- that is not counted ) ---
# --- ---
# --- This configuration aims at giving Shinken administrators a way to configure ---
# --- how the SLA are calculated. ---
# ======== No_data periods ( "Missing data" and "Shinken inactive" status ) ========== #
# #
# >>> include: ( DEFAULT ) Only status is considered. ---
# --- note: "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 ---
# 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 votre architecture Shinken.
- Chaque instance devra avoir un nom unique.
| Nom | Type | Unité | Défaut | Commentaire | |
|---|---|---|---|---|---|
| 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. | |
| Texte | --- | livedata_module_sla_provider | Ne peut être modifié. |
Paramètre de connexion à la base de données
Connexion et définition de la base de données
define module {
[...]
livedata_module_sla_provider__database__uri mongodb://localhost/?w=1&fsync=false
livedata_module_sla_provider__database__name shinken
livedata_module_sla_provider__database__retry_connection_X_times_before_considering_an_error 2
livedata_module_sla_provider__database__wait_X_seconds_before_reconnect 10
[...]
} |
L'url de connexion et le nom de la base de données SLA du module livedata-module-sla-provider sont paramétrables via les options suivantes :
| Nom de la propriété | Type | Valeur par défaut | Commentaire | |
|---|---|---|---|---|
| Texte | mongodb://localhost/?w=1&fsync=false | URL mongo de connexion à la base de données cf. https://docs.mongodb.com/manual/reference/connection-string/ | |
| Texte | shinken | Base de données à utiliser pour lire les données SLA. | |
| Entier | 2 | Si le module rencontre un problème de connexion, cette valeur indique le nombre de fois où il essaye de se reconnecter avant de considérer qu'il y a une erreur de connexion. | |
| Entier | 10 | Une fois que le module a considéré qu'il y avait une erreur de connexion, il va essayer de refaire le processus de connexion après ces X secondes. |
Utilisation et définition du tunnel SSH
La connexion à la base de données peut se faire via un tunnel SSH, les options suivantes le définiront :
| Nom de la propriété | Type | Valeur par défaut | Commentaire | |
|---|---|---|---|---|
| Booléen ( 0 / 1 ) | 0 | Utiliser un tunnel SSH pour accéder au serveur de base de données | |
| Texte | shinken | Utilisateur distant à utiliser pour la connexion SSH | |
| Texte | ~shinken/.ssh/id_rsa | Clé SSH locale à utiliser pour se connecter au serveur distant | |
| Entier | 10 | Temps maximal en seconde pour établir le tunnel de connexion vers la base de donnée MongoDB |
Calcul du taux de SLA
Certains statuts peuvent avoir un impact
- positif ( UP ),
- négatif ( DOWN )
- où ne pas avoir d'impact sur les SLAs ( IGNORED ) n'est pas compté, ce qui signifie que la période n'est pas comptée.
Cette configuration vise à donner aux administrateurs de Shinken un moyen de configurer le mode de calcul des SLAs.
Voici les paramètres permettant de configurer les statuts SLAs
| Nom de la propriété | Type | Valeur par défaut | Commentaire | |
|---|---|---|---|---|
| Texte | include | Concerne les statuts "Données manquantes" et "Shinken Inactif". Valeurs possibles :
|