| Scroll Ignore |
|---|
| scroll-viewport | true |
|---|
| scroll-pdf | true |
|---|
| scroll-office | true |
|---|
| scroll-chm | true |
|---|
| scroll-docbook | true |
|---|
| scroll-eclipsehelp | true |
|---|
| scroll-epub | true |
|---|
| scroll-html | false |
|---|
|
|
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/v2/sla
- Il récupère les données 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 ( voir la page V2 V1 - ( READ ) /api/v2v1/sla/ -- OPTIONNEL -- )
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 "livedata_module_sla_provider" appelé "livedata-module-sla-provider-example".
| 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. |
Pour pouvoir définir ce module selon vos les besoins, il vous sera possible de définir votre le module grâce au module d'exemple fourni par défaut.
Pour configurer votre le module de type livedata_module_sla_provider, commencez par choisir un nom à lui donner.
- Pour l'exemple, nous allons on l'appeler appele "
Mon-Module-Livedata-Sla-Provider". - Remplacer dans l'exemple le mot "
Mon-Module-Livedata-Sla-Provider" par le nom que vous aurez qui a été choisi.
Pour définir votre le module à partir du module fourni par défaut, vous devez il faut :
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 |
|---|
| language | bashtext |
|---|
| theme | Emacs |
|---|
|
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 que vous utilisez qui est utilisé pour définir les options de votre du broker-module-livedata ).
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
|
definedefine 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 |
|---|
| language | bashtext |
|---|
| theme | Emacs |
|---|
|
service shinken-arbiter restart |
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 que vous venez de créer 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 |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
|
# 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 ] [ MANDATORY ] ───
# ─── ───
module_name livedata-module-sla-provider
# ─── Module type [ Do not edit ] [ MANDATORY ] ───
# ─── ───
module_type livedata_module_sla_provider
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ──────────────────────────────────── DATABASE CONNECTION ──────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ───────────────── 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
# ─── Which database contains sla data ───
# ───
# Default : shinken ───
# ─── ───
# broker__module_livedata__module_sla_provider__database__name shinken
# ─── shinken
# ─── SSH tunnel activation to secure your mongodb connectionusername/password to authenticate to MongoDB. ───
# ─── That will allow all mongodbBoth parameters must be provided for authentication to befunction encryptedcorrectly. & authenticated with SSH ───
# ─── ───
# ───
# broker__module_livedata__module_sla_provider__database__username
# ─── ───
# Default : 0 => Disable ( disable ssh tunnel ) ───
# ... ───
: 1 => Enable ( enable ssh tunnel ) # broker__module_livedata__module_sla_provider__database__password
# ─── SSH tunnel activation to secure your mongodb connection ───
# ─── That will allow all mongodb to be encrypted & authenticated with SSH ───
# ───
# broker__module_livedata__module_sla_provider__use_ssh_tunnel 0
# ─── SSH user to connect to the mongodb server. ───
# Default : 0 => Disable ( disable ssh tunnel ) ───
# ───
# ... : 1 => Enable ( enable ssh tunnel ) ───
# ───
# ─── Default : shinken ───
# ───
# broker__module_livedata__module_sla_provider__use_ssh_tunnel 0
# ─── SSH user to connect to the mongodb server. ───
# ───
# broker__module_livedata__module_sla_provider__ssh_user shinken
# ─── SSH keyfile to connect to the mongodb server. ───
# Default : shinken ───
# ─── ───
# Default : ~shinken/.ssh/id_rsa ───
# broker__module_livedata__module_sla_provider__ssh_user shinken
# ─── SSH keyfile to connect to the mongodb server. ───
# ───
# 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 : ~shinken/.ssh/id_rsa ───
# ─── ───
# Default : 10 ( seconds ) ───
# 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. ───
# ───
# broker__module_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. Default : 10 ( seconds ) ───
# ─── How many try to reconnect before module go in error ───
# ───
# ───
# broker__module_livedata__module_sla_provider__ssh_tunnel_timeout 10
─── # ────────────── AutoReconnect Management ───────────────────────────────────────────────────────────── #
# ─── When MongoDB require you to reconnect ( For example, It can occur when Defaulta :new 4PRIMARY (is numberelected of try )───
# ─── in a MongoDB cluster ), it will raised the MongoDB AutoReconnect exception. ───
# ─── How many try to reconnect before module go in error ───
# ───
# ───
# broker__module_livedata__module_sla_provider__database__retry_connection_X_times_before_considering_an_error 4
# ─── Time between each try ───
# Default : 4 ( number of try ) ───
# ───
# ─── ───
# Default : 3 ( seconds ) ───
# broker__module_livedata__module_sla_provider__database__retry_connection_X_times_before_considering_an_error 4
# ─── Time between each try ───
# ───
# ───
# 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 Default : 3 ( seconds ) ───
# ─── heartbeatTimeoutSecs of your MongoDB replica set ───
# ─── The value of ───
# ─── ───
retry_connection_X_times_before_considering_an_error * # broker__module_livedata__module_sla_provider__database__wait_X_seconds_before_reconnect ───3
# ─── NOTE: Change these values only if mustyou behave higher than heartbeatTimeoutSecs in the rs.conf(); of your MongoDB replica set. ───
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
a MongoDB cluster and you change the # │ ────────────────────────────────────── SLA CALCULATION ────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
───
# ─── No_data periods ( "Missing data" and "ShinkenheartbeatTimeoutSecs inactive"of statusyour )MongoDB replica set ───
# ───
# ─── The value of ───
# ─── Default : include => Only status is considered. "Missing data" and "Shinken inactive"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 status are────────────────────────────────────── counted│ negatively#
in the SLA. # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── No_data periods ( "Missing data" and "Shinken inactive" status ) ───
# ... ───
# : exclude => No_data are not counted from SLA considered period. ───
# ... : ok => No_data are considered as UP periods. ───
# Default : include => Only status is considered. "Missing data" and "Shinken inactive" ───
# status are counted negatively in the SLA. ───
# broker__module_livedata__module_sla_provider__no_data_period include
}
|
Détails des sections composant le fichier de configuration
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.
... : 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
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 |
|---|
| anchor | parameter_cfg |
|---|
| title | |
|---|
|
| Nom | Type | Unité | Défaut | Description |
|---|
| 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. | | Texte | --- | livedata_module_sla_provider | Ne dois pas être modifié. | |
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 |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
|
# ───────────────── 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 ───
# ─── |
| 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é. |
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 |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
|
# ───────────────── MongoDB parameters ──────────────────────────────────────────────────────────────────
# ─── MongoDB uri definition . You can find the mongodb uri syntax at ───
# ─── https://docs.mongodb.com/manual/reference/connection-string/ ───
# broker__module_livedata__module_sla_provider__database__uri mongodb://localhost/?w=1&fsync=false
# ─── Which database contains sla data ───
# ───
# ───
# 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 ───
# 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. ───
# ─── ───
# Default : shinken ───
───# broker__module_livedata__module_sla_provider__database__username
# ─── ───
───
# # broker__module_livedata__module_sla_provider__database__password |
| Scroll Title |
|---|
| anchor | parameter_cfg |
|---|
| title | |
|---|
|
| Nom | Type | Unité | Défaut | Description |
|---|
| No Format |
|---|
broker__module_livedata__module_sla_provider__database_uri |
| Texte | URL | 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 |
|
|
| Nom | Type | Unité | Défaut | Commentaire |
|---|
code | Texte | --- | shinken | Nom de la base de données où sont stockées les données SLA. | | No Format |
|---|
broker__module_livedata__module_sla_provider__database_ |
|
|
uriURL | mongodb://localhost/?w=1&fsync=false | URL mongo de connexion à la base de données cf. https://docs.mongodb.com/manual/reference/connection-string/ | code |
|---|
broker__module_livedata__module_sla_provider__database__ |
|
|
name shinken | Nom de la base de données où sont stockés les données SLAConnexion 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.
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 La sécurisation de la base MongoDB est bien sûr toujours possible ( voir la pageSé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éaux bases MongoDB ).
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
|
# ─── 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 |
|---|
| anchor | parameter_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:
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 :Commentairecode| 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 |
| Texte | Utilisateur unix | shinken | L'utilisateur avec lequel le tunnel sera établi. |
|
code| No Format |
|---|
broker__module_livedata__module_sla_provider__ssh_keyfile |
| Texte | Chemin 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| No Format |
|---|
broker__module_livedata__module_sla_provider__ssh_tunnel_timeout |
| Entier |
|
Secondes| Seconde | 10 | Spécifie le timeout en secondes de la vérification du tunnel SSH avant que la connexion |
|
vers MongoDB soit effectuée Pour configurer les clés SSH à utiliser, voir la page Création automatique et gestion de la clé SSH de l'utilisateur shinkenversMongoDB soit effectuée. |
|
Gestion de la reconnexion automatique avec un cluster MongoDB
| Code Block |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
|
# ────────────── 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 |
|---|
|
- 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 |
|---|
| anchor | parameter_cfg |
|---|
| title | |
|---|
|
|
Commentairecode| 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. | |
|
code| No Format |
|---|
broker__module_livedata__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 |
|---|
| language | js |
|---|
| theme | Confluence |
|---|
|
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ────────────────────────────────────── 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 |
|---|
| anchor | parameter_cfg |
|---|
| title | |
|---|
|
|
Commentairecode| 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.
|
|