Aller au contenu principal

Skylight PVX

Vue d'ensemble​

Chaque instance PVX-Skylight fournit un endpoint API XML permettant à Centreon d'interroger ces dernières.

architecture

Contenu du Pack​

Modèles​

Le Plugin Pack Centreon PVX apporte 1 modèle d'hôte :

  • App-Pvx-Application-Restapi-custom

Il apporte les Modèles de Service suivants :

AliasModèle de serviceDescriptionDéfaut
Http-Hits-ApplicationApp-Pvx-Http-Hits-Application-RestapiContrôle le nombre d'erreur HTTPX
Http-HitsApp-Pvx-Http-Hits-RestapiContrôle le nombre d'erreur HTTP
Http-Hits-Server-IpApp-Pvx-Http-Hits-Server-Ip-RestapiContrôle le nombre d'erreur HTTP
Network-Connection-ApplicationApp-Pvx-Network-Connection-Application-RestapiContrôle le ratio connections tentéesX
Network-ConnectionApp-Pvx-Network-Connection-RestapiContrôle le ratio connections tentées
Network-Connection-Server-IpApp-Pvx-Network-Connection-Server-Ip-RestapiContrôle le ratio connections tentées
Network-Traffic-ApplicationApp-Pvx-Network-Traffic-Application-RestapiContrôle le traffic par application.X
Network-Traffic-LayerApp-Pvx-Network-Traffic-Layer-RestapiContrôle le traffic par ""layer"".
Network-TrafficApp-Pvx-Network-Traffic-RestapiContrôle le traffic par instance
Network-Traffic-Server-IpApp-Pvx-Network-Traffic-Server-Ip-RestapiContrôle le traffic par IP
Network-User-Experience-ApplicationApp-Pvx-Network-User-Experience-Application-RestapiContrôle l'expérience utilisateur par application.X
Network-User-ExperienceApp-Pvx-Network-User-Experience-RestapiContrôle l'expérience utilisateur par instance
Network-User-Experience-Server-IpApp-Pvx-Network-User-Experience-Server-Ip-RestapiContrôle l'expérience utilisateur par IP

Métriques & statuts collectés​

MétriqueUnité
instances#http.hits.persecondhits/s
instances#http.hits.error.persecondhits/s
instances#http.hits.percentage

Prerequisites​

Compatibilité​

Le connecteur a été testé avec la version suivante : * PVX version 5.1.1.

PVX API​

Pour interroger les instances via l'API, une clé d'accès est nécessaire. Cette clé n'a pas de date d'expiration. La procédure suivante, extrait de la documentation officielle, permet de la générer. A chaque étape, remplacez les valeurs des macro '< >' avec les vôtres.

curl -k 'https://**<pvxapihost>**/api/login?user=**<user>**&password=**<password>**'`

Résultat :

{
    "type": "result",
    "result": "**session:91554086-842b-4b73-9028-c51d20d91b94**"
}

Grâce à l'ID de session obtenu, exécutez la commande suivante pour obtenir une clé secrète.

curl -k 'https://**<pvxapihost>**/api/create-api-key?name=**<keyname>**&_session=session:91554086-842b-4b73-9028-c51d20d91b94'`

Résultat :

{
    "type": "result",
    "result": "**secret:e40b1cc6-f629-43a4-8be6-14a9c9f036e0**"
}

Dans cet exemple, la clé API est "secret:e40b1cc6-f629-43a4-8be6-14a9c9f036e0".

Installation​

  1. Installer le Plugin Centreon sur tous les collecteurs Centreon devant superviser des ressources PVX :
yum install centreon-plugin-Applications-Pvx-Restapi
  1. Sur l'interface Web de Centreon, installer le Plugin Pack PVX depuis la page Configuration > Packs de plugins.

Configuration​

Hôte​

  • Ajoutez un Hôte à Centreon depuis la page Configuration > Hôtes.
  • Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre serveur PVX.
  • Appliquez le Modèle d'Hôte App-Pvx-Application-Restapi-custom.
  • Une fois le modèle appliqué, les Macros ci-dessous indiquées comme requises (Obligatoire) doivent être renseignées.
ObligatoireMacroDescription
PVXAPIEXTRAOPTIONSAny extra option you may want to add to every command_line (eg. a --verbose flag)
XPVXAPIHOSTNAMEPVX hostname
XPVXAPIKEYPVX API key
PVXAPIPORT(Default: '443')
PVXAPIPROTO(Default: 'https')
PVXAPIURLPATH(Default: '/api')
PVXCUSTOMMODE(Default: 'api')

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_pvx_restapi.pl \
    --plugin=apps::pvx::restapi::plugin \
    --mode=http-hits \
    --custommode='api' \
    --hostname='10.0.0.1' \
    --url-path='/api' \
    --api-key='' \
    --port='443' \
    --proto='https' \
    --timeframe='3600' \
    --instance='' \
    --warning-ratio='' \
    --critical-ratio='' \
    --warning-hits-error='' \
    --critical-hits-error='' \
    --warning-hits='40' \
    --critical-hits='60' \
    --use-new-perfdata

La commande devrait retourner un message de sortie similaire à :

OK: ratio: 18 hits error: 2 hits/s hits: 39 hits/s | 'http.hits.percentage'=18;;;0; 'http.hits.error.persecond'=2hits/s;;;0; 'http.hits.persecond'=39hits/s;0:40;0:60;0;

Dans cet exemple, une alarme de type WARNING sera déclenchée si le nombre de requêtes HTTP est supérieur à 40 (--warning-hits='40') durant la dernière heure (--timeframe='3600'); l'alarme sera de type CRITICAL au-delà de 60 requête (--warning-hits='60').

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_pvx_restapi.pl \
    --plugin=apps::pvx::restapi::plugin \
    --mode=http-hits \
    --help

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

/usr/lib/centreon/plugins//centreon_pvx_restapi.pl \
    --plugin=apps::pvx::restapi::plugin \
    --list-mode

Diagnostic des erreurs communes​

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