Configuration
Configuration
La configuration du module se trouve par défaut dans le fichier suivant: /etc/shinken/modules/broker-module-livedata.cfg
Configuration de l'interface et du port d'écoute
Par défaut, le port de l'API rendue disponible par le module "broker-module-livedata" est 50100. Ce port peut être changé via le paramètre "port" dans le fichier de configuration du module: /etc/shinken/modules/broker-module-livedata.cfg.
En plus du port, il est également possible de configurer l'interface réseau sur laquelle est mise à disposition l'API. Si par exemple l'API ne doit être accessible seulement via un réseau local, il est possible de n'écouter les requêtes que sur cette interface réseau.
Cette modification de configuration se fait via le paramètre "host" du fichier de configuration du module: /etc/shinken/modules/broker-module-livedata.cfg. Dans l'exemple suivant, l'API ne sera disponible que sur l'interface avec l'adresse 192.168.1.27:
| Code Block | ||||
|---|---|---|---|---|
| ||||
define module {
[...]
host |
Voici le fichier CFG de configuration présent dans : /etc/shinken/modules/broker-module-livedata.cfg
| Code Block | ||
|---|---|---|
| ||
#=============================================================================== # broker module livedata #=============================================================================== # Daemons that can load this module: # - broker # This module is an api getting information from the broker #=============================================================================== define module { #======== Module identity ========= # Module name. Must be unique module_name broker-module-livedata # Module type (to load module code). Do not edit. module_type broker_module_livedata #======== Listening address ========= # host: IP address to listen to. # note: 0.0.0.0 = all interfaces. host 0.0.0.0 # port to listen 192.168.1.27 port 8000 # HTTPs part, enable if you want to set the visualisation interface listen in HTTPs mode[...] } |
L'API du module est par défaut mise à disposition sur toutes les interfaces: le paramètre "host" est à 0.0.0.0
Pour prendre en compte le changement de configuration, il faut ensuite rédémarrer l'Arbiter:
| Code Block |
|---|
service shinken-arbiter restart |
Activation du SSL
L'API du module est accessible via HTTP. Si pour des raisons de sécurité, cette API doit être accessible via HTTPS, il faut passer le paramètre "use_ssl" à 1 dans le fichier de configuration du module:
| Code Block | ||||
|---|---|---|---|---|
| ||||
define module { [...] # disabledHTTPs bypart, default.enable Setif your you want to set the visualisation interface listen in HTTPs mode # disabled by default. Set your own certificates. Set your own token, it is usefull to get access to the API use_ssl 01 ssl_cert /etc/shinken/certs/server.cert ssl_key /etc/shinken/certs/server.key token ak5zv6t5s25r6g4 } |
Mise en marche du module
[...]
}
|
Les paramètres "ssl_cert" et "ssl_key" permettent de spécifier la clé et le certificat SSL à utiliser pour la connexion.
Pour prendre en compte le changement de configuration, il faut ensuite rédémarrer l'Arbiter:
| Code Block |
|---|
service shinken-arbiter restart |
Authentification
L'API du module broker-module-livedata est accessible à l'adresse suivante:
| Code Block |
|---|
http://<ip-broker>:<port-module>/ |
Les appels effectués à l'API demandent l'utilisation d'un token d'identification. Ce token est spécifié dans le fichier de configuration du module (/etc/shinken/modules/broker-module-livedata.cfg).
Il est fortement recommandé de changer ce token.
Ce token doit être ajouté en paramètre à chaque requête sous peine de recevoir une erreur 401 de la part de l'API.
Par exemple:
| Code Block |
|---|
http://192.168.1.59:50100/api/v1/host/408cd29ad37611e8810e0800277b7e16?token=ak5zv6t5s25r6g4 |
Chaque appel à l'API renvoie une réponse au format JSON.
| Info | ||
|---|---|---|
| ||
Avec le module configuré en HTTP, une simple écoute du réseau permet de trouver le token. Il est fortement recommandé de passer en HTTPS afin d'éviter une interception du token. |
Utilisation
Les routes suivantes sont mise à disposition par l'API. Chaque appel doit contenir dans ses paramètres le token d'identification décrit dans la section précédente.
GET /api/v1/all-monitored-elements
Cet appel permet de recevoir la liste des uuids de tous les hôtes et clusters ainsi que de leurs checks.
Réponse
Codes de retour
| Codes de retour | Explications |
|---|---|
| 200 | OK |
| 401 | Permission refusée (Mauvais token) |
Retour du code 200
- hosts :
- host_uuid : text
- checks :
- check_uuid : text
- clusters :
- cluster_uuid : text
- checks :
- check_uuid : text
Exemple
| Code Block | ||
|---|---|---|
| ||
{
"clusters":[
{
"cluster_uuid":"ac169cd1fb5744999eaadc5da595f88b",
"checks":[
]
},
{
"cluster_uuid":"0dcad2b1667642d28c933de70915331e",
"checks":[
"0dcad2b1667642d28c933de70915331e-905374c0f6ed11e78cd83cf862f4613a",
"0dcad2b1667642d28c933de70915331e-714f6a1b90b318bbcfffb1a71d6258af",
"0dcad2b1667642d28c933de70915331e-8537fb11f6ed11e7bf9f3cf862f4613a",
"0dcad2b1667642d28c933de70915331e-8700ea097f3eb219b0e61d871936bfe4"
]
}
],
"hosts":[
{
"host_uuid":"ac169cd1fb5744999eaadc5da595f88b",
"checks":[
]
},
{
"host_uuid":"0dcad2b1667642d28c933de70915331e",
|
Pour mettre en marche votre module il vous faut l'ajouter à la listes des modules actifs sur le broker souhaité.
Pour se faire, rendez vous dans le fichier de configuration de votre broker à l'emplacement /etc/shinken/brokers/nom_de_votre_broker.cfg :
| Code Block | ||
|---|---|---|
| ||
#=============================================================================== # BROKER #=============================================================================== # Description: The broker is responsible for: # - Exporting centralized logs of all Shinken daemon processes # - Exporting status data # - Exporting performance data # - Exposing Shinken APIs: # - Status data # - Performance data # - Command interface #=============================================================================== define broker { # 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-broker-060340145ade11e5b703080027f08538 _SE_UUID_HASH 8e00136f9e61061e07ca0f4a63509b68 # End of Shinken Enterprise part #======== Daemon name and address ========= # Daemon name. Must be unique broker_name broker-master # IP/fqdn of this daemon (note: you MUST change it by the real ip/fqdn of this server) address "checks":[ localhost # Port (HTTP/HTTPS) exposed by this daemon "0dcad2b1667642d28c933de70915331e-905374c0f6ed11e78cd83cf862f4613a", port "0dcad2b1667642d28c933de70915331e-714f6a1b90b318bbcfffb1a71d6258af", 7772 "0dcad2b1667642d28c933de70915331e-8537fb11f6ed11e7bf9f3cf862f4613a", # 0 = use HTTP, 1 = use HTTPS"0dcad2b1667642d28c933de70915331e-8700ea097f3eb219b0e61d871936bfe4" use_ssl ] } 0 #======== Master or spare selection ========= # 1 = is a spare, 0 = is not a spare spare ] } |
GET /api/v1/host
Cet appel permet de recevoir la liste des uuids de tous les hôtes ainsi que de leurs checks.
Réponse
Codes de retour
| Codes de retour | Explications |
|---|---|
| 200 | OK |
| 401 | Permission refusée (Mauvais token) |
Retour du code 200
- hosts :
- host_uuid : text
- checks :
- check_uuid : text
Exemple
| Code Block | ||
|---|---|---|
| ||
{ "hosts":[ { "host_uuid":"ac169cd1fb5744999eaadc5da595f88b", 0 #======== Daemon connection timeout and down state limit ========="checks":[ ] # timeout: how}, many seconds to consider a node{ don't answer timeout "host_uuid":"0dcad2b1667642d28c933de70915331e", "checks":[ 3 # data_timeout: how many second to consider a configuration transfert to be failed"0dcad2b1667642d28c933de70915331e-905374c0f6ed11e78cd83cf862f4613a", "0dcad2b1667642d28c933de70915331e-714f6a1b90b318bbcfffb1a71d6258af", # because the network brandwith is too small. "0dcad2b1667642d28c933de70915331e-8537fb11f6ed11e7bf9f3cf862f4613a", data_timeout "0dcad2b1667642d28c933de70915331e-8700ea097f3eb219b0e61d871936bfe4" 120] # max_check_attempts: how many fail check to consider this daemon as DEAD } max_check_attempts 3 # Check this daemon every X seconds check_interval 10 #======== Modules to enable for this daemon ========= # Available: # - Simple-log : save all logs into a common file # - WebUI : visualisation interface # - Graphite-Perfdata : save all metrics into a graphite database # - sla : save sla into a database # - Livestatus : TCP API to query element state, used by nagios external tools like NagVis or Thruk # - Broker-module-liveData: JSON API to query element data. modules Simple-log, WebUI, Graphite-Perfdata, sla, Livestatus, broker-module-livedata #======== Realm and architecture settings ========= # Realm to set this daemon into realm All # 1 = take data from the daemon realm and its sub realms # 0 = take data only from the daemon realm manage_sub_realms 1 # In NATted environments, you declare each satellite ip[:port] as seen by # *this* broker (if port not set, the port declared by satellite itself # is used) #satellitemap scheduler-1=1.2.3.4:7768, poller-1=1.2.3.5:7771 #======== Enable or not this daemon ========= # 1 = is enabled, 0 = is disabled enabled 1 } |
Rendez vous alors à la ligne des modules et ajoutez-y broker-module-livedata :
| Code Block | ||
|---|---|---|
| ||
modules Simple-log, WebUI, Graphite-Perfdata, sla, Livestatus, broker-module-livedata |
Redémarrez ensuite votre Arbiter pour que la configuration du Broker soit active, puis redémarrez votre Broker qui s'occupera de mettre en marche le module livedata.
Fonctionnement
L'accès à cette API est restreinte aux détenteurs d'un token généré dans la configuration (modifiable par l'utilisateur) du module.
Appeler l'API
URL = http://{ip_broker}:{port_module}/api/V1/host/408cd29ad37611e8810e0800277b7e16?token={token}
ou https://IP_DU_BROKER:PORT_DU_MODULE/api/V1/TYPE/UUID?token=TOKEN_DU_MODULE
Exemple pour un hôte avec le module sur le port 8000 du broker en localhost et "adt" comme token :
http://localhost:8000/api/V1/host/408cd29ad37611e8810e0800277b7e16?token=adt
DIRE QUE CA RENVOIE DU JSON
]
}
|
GET /api/v1/host/{uuid}
Cet appel permet de recevoir des informations sur un hôte.
Paramètres
| Paramètre | Description |
|---|---|
| uuid | UUID de l'hôte |
Réponse
Codes de retour
| Codes de retour | Explications |
|---|---|
| 200 | OK |
| 401 | Permission refusée (Mauvais token) |
| 404 | Hôte introuvable |
Retour du code 200
- host_uuid : text
- host_name : text
- host_display_name : text
- status : text
- OK
- WARNING
- CRITICAL
- UNKNOWN
- MISSING-DATA
- SHINKEN-INACTIVE
- status_since : epoch (en secondes)
- context : text
- NOTHING
- ACKNOWLEDGED
- PARTIAL-ACKNOWLEDGED
- INHERITED-ACKNOWLEDGED
- DOWNTIME
- PARTIAL-DOWNTIME
- INHERITED-DOWNTIME
- FLAPPING
- PARTIAL-FLAPPING
- DISABLED
business_impact : 0, 1, 2, 3, 4, 5
output : text
long_output : text
Exemple
| Code Block | ||
|---|---|---|
| ||
{
"status": "OK",
"host_display_name": "localhost",
"long_output": "",
"host_name": "localhost",
"context": "NOTHING",
"status_since": 1540457802,
"business_impact": 2,
"output": "PING OK - Packet loss = 0%, RTA = 0.02 ms",
"host_uuid": "408cd29ad37611e8810e0800277b7e16"
}
|
GET /api/v1/check-on-host/{uuid}
Cet appel permet de recevoir des informations sur un check attaché à un hôte.
Paramètres
| Paramètre | Description |
|---|---|
| uuid | UUID du check, sachant qu'il correspond à {uuid_de_l'hôte}-{uuid_du_check} |
Réponse
Codes de retour
| Codes de retour | Explications |
|---|---|
| 200 | OK |
| 401 | Permission refusée (Mauvais token) |
| 404 | Check introuvable |
Retour du code 200
- check_uuid : text
- check_name : text
- check_display_name : text
- status :
Routes de l'API (titre a changer)
GET /api/V1/host/{uuid}
Description incroyable de mon appel
Paramètres
uuid ca fait des trucs (dans un tableau c'est plus joli)
Réponse
Codes de retour
Explication codes de retour
200 OK
4XX Token de merde
404 Host not found
Tete de la réponse (titre a changer)
- host_uuid : text
- host_name : text
- host_display_name : text
- status : text
- OK
- WARNING
- CRITICAL
- UNKNOWN
- MISSING-DATA
- SHINKEN-INACTIVE
- status_sincesince : : epoch (en secondes)
- contextcontext : : text
- NOTHING
- ACKNOWLEDGED
- PARTIAL-ACKNOWLEDGED
- INHERITED-ACKNOWLEDGED
- DOWNTIME
- PARTIAL-DOWNTIME
- INHERITED-DOWNTIME
- FLAPPING
- PARTIAL-FLAPPING
- DISABLED
- output : text
- business_impact impact : 0, 1, 2, 3, 4, 5
output : text
- , 4, 5
- long_output : text
- host_uuid : text
- host_name : text
- host_display_name : long_output : text
Exemple
| Code Block | ||
|---|---|---|
| ||
{
"status": "OK",
"host_display_name": "localhost",
"check_name": "Broker Daemon Livedata - broker-master",
"host_uuid": "localhost408cd29ad37611e8810e0800277b7e16",
"long_output": "",
"host_name": "localhost",
"context": "NOTHING",
"status_sinceoutput": 1540457802,
"business_impact": 2"<span style=\"color:#2A9A3D;font-weight:bold;\">[OK]</span> The example works fine.<br/>",
"outputbusiness_impact": "PING OK - Packet loss = 0%, RTA = 0.02 ms" 2,
"status_since": 1540457781.797493,
"hostcheck_uuid": "408cd29ad37611e8810e0800277b7e16022a505c849f840e110f2aba5e27597f"
}
|
Check attaché à un hôte
GET /api/V1/check-on-host/UUID
,
"check_display_name": "Broker Daemon Livedata - broker-master"
}
|
GET /api/v1/cluster
Cet appel permet de recevoir la liste des uuids de tous les clusters ainsi que de leurs checks.
Réponse
Codes de retour
| Codes de retour | Explications |
|---|---|
| 200 | OK |
| 401 | Permission refusée (Mauvais token) |
Retour du code 200
clusters :
- cluster_uuid : text
- checks :
- check_uuid : text
Exemple
| Code Block | ||
|---|---|---|
| ||
{
"clusters":[
{
"cluster_uuid":"ac169cd1fb5744999eaadc5da595f88b",
"checks":[
]
},
{
"cluster_uuid":"0dcad2b1667642d28c933de70915331e",
"checks":[
"0dcad2b1667642d28c933de70915331e-905374c0f6ed11e78cd83cf862f4613a",
"0dcad2b1667642d28c933de70915331e-714f6a1b90b318bbcfffb1a71d6258af",
"0dcad2b1667642d28c933de70915331e-8537fb11f6ed11e7bf9f3cf862f4613a",
"0dcad2b1667642d28c933de70915331e-8700ea097f3eb219b0e61d871936bfe4"
]
}
]
}
|
GET /api/v1/cluster/{uuid}
Cet appel permet de recevoir des informations sur un cluster.
Paramètres
| Paramètre | Description |
|---|---|
| uuid | UUID du cluster |
Réponse
Codes de retour
| Codes de retour | Explications |
|---|---|
| 200 | OK |
| 401 | Permission refusée (Mauvais token) |
| 404 | Cluster introuvable |
Retour du code 200
- OK
- WARNING
- CRITICAL
- UNKNOWN
- MISSING-DATA
- SHINKEN-INACTIVE
- NOTHING
- ACKNOWLEDGED
- PARTIAL-ACKNOWLEDGED
- INHERITED-ACKNOWLEDGED
- DOWNTIME
- PARTIAL-DOWNTIME
- INHERITED-DOWNTIME
- FLAPPING
- PARTIAL-FLAPPING
- DISABLED
Exemple
| Code Block | ||
|---|---|---|
| ||
{
"status": "OK",
"host_display_name": "localhost",
"check_name": "Broker Daemon Livedata - broker-master",
"host_uuid": "408cd29ad37611e8810e0800277b7e16",
"long_output": "",
"host_name": "localhost",
"context": "NOTHING",
"output": "<span style=\"color:#2A9A3D;font-weight:bold;\">[OK]</span> The example works fine.<br/>",
"business_impact": 2,
"status_since": 1540457781.797493,
"check_uuid": "022a505c849f840e110f2aba5e27597f",
"check_display_name": "Broker Daemon Livedata - broker-master"
}
|
Cluster
GET /api/V1/cluster/UUID- cluster_uuid : text
- cluster_name : text
- cluster_display_name : text
- status : text
- OK
- WARNING
- CRITICAL
- UNKNOWN
- MISSING-DATA
- SHINKEN-INACTIVE
- status_since : epoch (en secondes)
- context : text
- NOTHING
- ACKNOWLEDGED
- PARTIAL-ACKNOWLEDGED
- INHERITED-ACKNOWLEDGED
- DOWNTIME
- PARTIAL-DOWNTIME
- INHERITED-DOWNTIME
- FLAPPING
- PARTIAL-FLAPPING
- DISABLED
- business_impact : 0, 1, 2, 3, 4, 5
- output : text
- long_output : text
Exemple
| Code Block | ||
|---|---|---|
| ||
{
"status": "OK",
"cluster_display_name": "localhost",
"long_output": "",
"cluster_name": "localhost",
"context": "NOTHING",
"status_since": 1540457802,
"business_impact": 2,
"output": "PING OK - Packet loss = 0%, RTA = 0.02 ms",
"cluster_uuid": "408gfhfr7611e8810e0800277b7e16"
}
|
Check attaché à un cluster
GET /api/V1/check-on-cluster/UUID"cluster_uuid": "408gfhfr7611e8810e0800277b7e16"
}
|
GET /api/v1/check-on-cluster/UUID
Cet appel permet de recevoir des informations sur un check attaché à un cluster.
Paramètres
| Paramètre | Description |
|---|---|
| uuid | UUID du check, sachant qu'il correspond à {uuid_du_cluster}-{uuid_du_check} |
Réponse
Codes de retour
| Codes de retour | Explications |
|---|---|
| 200 | OK |
| 401 | Permission refusée (Mauvais token) |
| 404 | Check introuvable |
Retour du code 200
- check_uuid : text
- check_name : text
- check_display_name : text
- status : text
- OK
- WARNING
- CRITICAL
- UNKNOWN
- MISSING-DATA
- SHINKEN-INACTIVE
- status_since : epoch (en secondes)
- context : text
- NOTHING
- ACKNOWLEDGED
- PARTIAL-ACKNOWLEDGED
- INHERITED-ACKNOWLEDGED
- DOWNTIME
- PARTIAL-DOWNTIME
- INHERITED-DOWNTIME
- FLAPPING
- PARTIAL-FLAPPING
- DISABLED
- output : text
- business_impact : 0, 1, 2, 3, 4, 5
- long_output : text
- cluster_uuid : text
- cluster_name : text
- cluster_display_name : text
Exemple
| Code Block | ||
|---|---|---|
| ||
{
"status": "OK",
"cluster_display_name": "localhost",
"check_name": "Broker Daemon Livedata - broker-master",
"cluster_uuid": "408gfhfr7611e8810e0800277b7e16",
"long_output": "",
"cluster_name": "localhost",
"context": "NOTHING",
"output": "<span style=\"color:#2A9A3D;font-weight:bold;\">[OK]</span> The example works fine.<br/>",
"business_impact": 2,
"status_since": 1540457781.797493,
"check_uuid": "044a505c849f840e110f2aba5e27597f",
"check_display_name": "Example cluster check"
}
|
Obtenir un UUID
Hôtes et Clusters
:bold;\">[OK]</span> The example works fine.<br/>",
"business_impact": 2,
"status_since": 1540457781.797493,
"check_uuid": "044a505c849f840e110f2aba5e27597f",
"check_display_name": "Example cluster check"
}
|
Obtenir un UUID
Hôtes et Clusters
Pour récupérer l'UUID d'un hôte ou d'un cluster il suffit de se rendre dans sa page de configuration sur l'UI de Configuration, ou de le sélectionner dans l'UI de Visualisation. Il se trouve alors dans l'URL de la page comme sur les screens suivants:
| Panel |
|---|
| Panel |
|---|
Il est aussi possible de récupérer les uuid directement par le biais des requêtes apis : all-monitored-elements, host et cluster.
Checks attachés
Pour récupérer l'UUID d'un check attaché à un hôte ou à un cluster, Pour récupérer l'uuid d'un hôte ou d'un cluster il suffit de se rendre dans sa page de configuration sur l'UI de Configuration , ou de le sélectionner dans l'UI de Visualisation. Il se trouve alors dans l'url tel que :
| Panel |
|---|
| Panel |
|---|
Checks attachés
en y rajoutant l'UUID de l'hôte ou du cluster sur lequel il est attaché, suivi d'un tiret. Dans l'interface de Visualisation, il peut être trouvé directement dans l'URL en ouvrant le détail du check:
| Panel |
|---|
Des macros sont également disponibles sur Shinken pour utiliser l'UUID d'un hôte/cluster/check.
| Macro | Description |
|---|---|
| $HOSTUUID$ | Renvoie l'UUID de l'hôte ou du cluster |
| $SERVICEUUID$ | Renvoie l'UUID du check |
Exemple d'utilisation
Ces macros peuvent être utilisées par exemple dans les URL externes. Par exemple:
| Panel |
|---|
L'URL externe de cet hôte amène directement sur le volet Graphiques de l'hôte en question.
Pour récupérer l'uuid d'un check attaché à un hôte ou à un cluster, il suffit de se rendre dans sa page de configuration sur l'UI de Configuration en y rajoutant l'uuid de l'hôte ou du cluster sur lequel il est attaché, suivit d'un tiret. Ou plus simplement dans l'UI de Visualisation.
| Panel |
|---|
AJOUTER UN TRUC SUR LES MACROS (commandes notifs)



