Aller au contenu principal

Kadiska Rest API

Contenu du Pack

Modèles

Le Plugin Pack Centreon Kadiska Rest API apporte 2 modèles d'hôte différents :

  • App-Monitoring-Kadiska-Station-Restapi-custom
  • App-Monitoring-Kadiska-Watcher-Restapi-custom

Il apporte les modèles de service suivants :

AliasModèle de serviceDescriptionDéfautDécouverte
Target-StatisticsApp-Monitoring-Kadiska-Restapi-Target-StatisticsContrôle les données de performances des targets Kadiska via Rest APIXX
Watcher-StatisticsApp-Monitoring-Kadiska-Restapi-Watcher-StatisticsContrôle les données de performances des watchers Kadiska via Rest APIX

Règles de découverte

Nom de la règleDescription
StationsDécouverte de stations Kadiska
WatchersDécouverte de watchers Kadiska

Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique d'hôtes.

Métriques & statuts collectés

MétriqueUnité
targets#tracer.packets.loss.percentage%
targets#tracer.path.length
targets#tracer.round.trip.persecondms

Prérequis

Un client ID et client secret pour joindre l'API de Kadiska sont nécessaires.

Pour créer cette paire, rendez-vous sur https://app.kadiska.com/, dans Configuration > API Clients et créez un client avec le rôle Data Analyst. Sauvegardez en lieu sûr le client secret, il ne sera pas possible ensuite de le retrouver depuis l'interface.

Installation

  1. Installez le plugin sur tous les collecteurs Centreon devant superviser des ressources Kadiska Rest API :
yum install centreon-plugin-Applications-Monitoring-Kadiska-Restapi
  1. Sur l'interface Web de Centreon, installez le Plugin Pack Kadiska Rest API depuis la page Configuration > Packs de plugins.

Configuration

Hôte

Station Kadiska

  • Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
  • Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre serveur Kadiska Rest API.
  • Appliquez le modèle d'hôte App-Monitoring-Kadiska-Station-Restapi-custom.
  • Une fois le modèle appliqué, les macros ci-dessous indiquées comme requises (Obligatoire) doivent être renseignées.
ObligatoireMacroDescription
EXTRAOPTIONSAny extra option you may want to add to every command_line (eg. a --verbose flag)
XKADISKAAPICLIENTIDKadiska Client ID
XKADISKAAPICLIENTSECRETKadiska Client Secret
KADISKAAPIPORT(Défaut : '443')
KADISKAAPIPROTO(Défaut : 'https')
XSTATIONNAMESpécifiez le nom de la station Kadiska
TIMEOUT

Watcher Kadiska

  • Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
  • Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre serveur Kadiska Rest API.
  • Appliquez le modèle d'hôte App-Monitoring-Kadiska-Watcher-Restapi-custom.
  • Une fois le modèle appliqué, les macros ci-dessous indiquées comme requises (Obligatoire) doivent être renseignées.
ObligatoireMacroDescription
EXTRAOPTIONSAny extra option you may want to add to every command_line (eg. a --verbose flag)
XKADISKAAPICLIENTIDKadiska Client ID
XKADISKAAPICLIENTSECRETKadiska Client Secret
KADISKAAPIPORT(Défaut : '443')
KADISKAAPIPROTO(Défaut : 'https')
XWATCHERNAMESpécifiez le nom du watcher Kadiska
TIMEOUT

Comment puis-je tester le plugin et que signifient les options des commandes ?

Une fois le plugin installé, vous pouvez tester celui-ci directement en ligne de commande depuis votre collecteur Centreon en vous connectant avec l'utilisateur centreon-engine (su - centreon-engine) :

/usr/lib/centreon/plugins//centreon_monitoring_kadiska_restapi.pl \
--plugin=apps::monitoring::kadiska::plugin \
--mode=nettracer-statistics \
--client-id='client:xxx' \
--client-secret='my-secret' \
--filter-station-name='Paris-RT' \
--filter-tracer='tracer_name' \
--period=15 \
--port='443' \
--proto='https' \
--timeout='' \
--verbose \

La commande devrait retourner un message de sortie similaire à :

OK: Round trip: 2 ms Path length: 9 Packets Loss: 3 % | 'tracer.round.trip.persecond'=2ms;;;0; 'tracer.path.length'=9;;;0; 'tracer.packets.loss.percentage'=3%;;;0;100 

La liste de toutes les options complémentaires et leur signification peut être affichée en ajoutant le paramètre --help à la commande :

/usr/lib/centreon/plugins//centreon_monitoring_kadiska_restapi.pl \
--plugin=apps::monitoring::kadiska::plugin \
--mode=nettracer-statistics \
--help

Tous les modes disponibles peuvent être affichés en ajoutant le paramètre --list-mode à la commande :

/usr/lib/centreon/plugins//centreon_monitoring_kadiska_restapi.pl \
--plugin=apps::monitoring::kadiska::plugin \
--list-mode

Diagnostic des erreurs communes

Rendez-vous sur la documentation dédiée des plugins basés sur HTTP/API.