Aller au contenu principal

Absyss VTOM Rest API

Dépendances du connecteur de supervision​

Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur Absyss VTOM Rest API depuis la page Configuration > Connecteurs > Connecteurs de supervision :

Contenu du pack​

Modèles​

Le connecteur de supervision Absyss VTOM Rest API apporte un modèle d'hôte :

  • App-Vtom-Restapi-custom

Le connecteur apporte les modèles de service suivants (classés selon le modèle d'hôte auquel ils sont rattachés) :

AliasModèle de serviceDescriptionDécouverte
JobsApp-Vtom-Jobs-Restapi-customContrôle permettant de vérifier l'état des jobsX

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte App-Vtom-Restapi-custom est utilisé.

Si la case Découverte est cochée, cela signifie qu'une règle de découverte de service existe pour ce service.

Règles de découverte​

Découverte de services​

Nom de la règleDescription
App-Vtom-Restapi-Job-NameDécouvre les jobs

Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique de services et sa planification.

Métriques & statuts collectés​

Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service.

NomUnité
jobs.running.countcount
jobs.errors.countcount
jobs.waiting.countcount
jobs.finished.countcount
jobs.notscheduled.countcount
jobs.descheduled.countcount
statusN/A
longN/A
jobs#job.success.percentage%

Prérequis​

Afin de contrôler votre VTOM, l'API Rest doit être configurée.

Le connecteur supporte les méthodes d'authentification:

  • par utilisateur et mot de passe
  • par token directement

La version minimum VTOM 6.6.1a est nécessaire pour le bon fonctionnement du connecteur :

  • /auth/1.0/authorize
  • /monitoring/1.0/jobs/status

Pour les versions antérieures, il est nécessaire d'utiliser le mode legacy du plugin.

Installer le connecteur de supervision​

Pack​

La procédure d'installation des connecteurs de supervision diffère légèrement suivant que votre licence est offline ou online.

  1. Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le connecteur dans le menu Configuration > Connecteurs > Connecteurs de supervision. Au contraire, si la plateforme utilise une licence offline, installez le paquet sur le serveur central via la commande correspondant au gestionnaire de paquets associé à sa distribution :
dnf install centreon-pack-applications-vtom-restapi
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Absyss VTOM Rest API depuis l'interface web et le menu Configuration > Connecteurs > Connecteurs de supervision.

Plugin​

À partir de Centreon 22.04, il est possible de demander le déploiement automatique du plugin lors de l'utilisation d'un connecteur. Si cette fonctionnalité est activée, et que vous ne souhaitez pas découvrir des éléments pour la première fois, alors cette étape n'est pas requise.

Plus d'informations dans la section Installer le plugin.

Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation :

dnf install centreon-plugin-Applications-Vtom-Restapi

Utiliser le connecteur de supervision​

Utiliser un modèle d'hôte issu du connecteur​

  1. Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
  2. Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre ressource.
  3. Appliquez le modèle d'hôte App-Vtom-Restapi-custom. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur.
  4. Renseignez les macros désirées. Attention, certaines macros sont obligatoires, notamment la macro permettant de définir le custom mode, c'est-à-dire la méthode de connexion à la ressource.
MacroDescriptionValeur par défautObligatoire
VTOMAPIUSERNAMEAPI usernameX
VTOMAPIPASSWORDAPI passwordX
VTOMAPITOKENUse token authentication directly
VTOMAPIPROTOSpecify https if neededhttps
VTOMAPIPORTPort used30002
VTOMCUSTOMMODEWhen a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this optionapi
VTOMAPIEXTRAOPTIONSAny extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées ici.
  1. Déployez la configuration. L'hôte apparaît dans la liste des hôtes supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros.

Utiliser un modèle de service issu du connecteur​

  1. Si vous avez utilisé un modèle d'hôte et coché la case Créer aussi les services liés aux modèles, les services associés au modèle ont été créés automatiquement, avec les modèles de services correspondants. Sinon, créez les services désirés manuellement et appliquez-leur un modèle de service.
  2. Renseignez les macros désirées (par exemple, ajustez les seuils d'alerte). Les macros indiquées ci-dessous comme requises (Obligatoire) doivent être renseignées.
MacroDescriptionValeur par défautObligatoire
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.
  1. Déployez la configuration. Le service apparaît dans la liste des services supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails du service : celle-ci montre les valeurs des macros.

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). Vous pouvez tester que le connecteur arrive bien à superviser une ressource en utilisant une commande telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :

/usr/lib/centreon/plugins/centreon_vtom_restapi.pl \
    --plugin=apps::vtom::restapi::plugin \
    --mode=jobs \
    --hostname='10.0.0.1' \
    --api-username='my-username' \
    --api-password='my-password' \
    --filter-application='' \
    --filter-environment='' \
    --filter-name='' \
    --verbose

La commande devrait retourner un message de sortie similaire à :

CRITICAL: job 'env_1/app_6/job_1' status: error [message: Traitement en erreur (1)] - job 'env_1/app_7/job_2' status: error [message: Traitement en erreur (1)] - job 'env_2/app_6/job_1' status: error [message: Traitement en erreur (1)] - job 'env_2/app_7/job_2' status: error [message: Traitement en erreur (1)] | 'jobs.running.count'=4;;;0;18 'jobs.errors.count'=4;;;0;18 'jobs.waiting.count'=4;;;0;18 'jobs.finished.count'=2;;;0;18 'jobs.notscheduled.count'=2;;;0;18 'jobs.descheduled.count'=2;;;0;18 'env_1~app_5~job_1#job.success.percentage'=100%;;;0;100 'env_2~app_5~job_1#job.success.percentage'=100%;;;0;100
job 'env_1/app_1/job_1' status: notscheduled
job 'env_1/app_2/job_1' status: waiting
job 'env_1/app_3/job_1' status: descheduled
job 'env_1/app_4/job_1' status: running [message: Job en cours d\'execution, pid 29592 (ipid 210)], started since: 19h 37m 15s
job 'env_1/app_5/job_1' status: finished [message: Traitement termine (0)], success: 100.00 %
job 'env_1/app_6/job_1' status: error [message: Traitement en erreur (1)]
job 'env_1/app_7/job_1' status: running [message: L\'agent nohost (nohost:37714) est ignore car une erreur recente a ete detectee (attente 63s)], started since: 19h 22m 52s
job 'env_1/app_7/job_2' status: error [message: Traitement en erreur (1)]
job 'env_1/app_7/job_3' status: waiting [message: Heure de demarrage non atteinte]
job 'env_2/app_1/job_1' status: notscheduled
job 'env_2/app_2/job_1' status: waiting
job 'env_2/app_3/job_1' status: descheduled
job 'env_2/app_4/job_1' status: running [message: Job en cours d\'execution, pid 29651 (ipid 211)], started since: 19h 35m 58s
job 'env_2/app_5/job_1' status: finished [message: Traitement termine (0)], success: 100.00 %
job 'env_2/app_6/job_1' status: error [message: Traitement en erreur (1)]
job 'env_2/app_7/job_1' status: running [message: Impossible de se connecter a l\'agent 'nohost' (nohost:37714) tentative 2/2], started since: 19h 26m 52s
job 'env_2/app_7/job_2' status: error [message: Traitement en erreur (1)]
job 'env_2/app_7/job_3' status: waiting [message: Heure de demarrage non atteinte]

Diagnostic des erreurs communes​

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

Modes disponibles​

Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal.

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

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

Le plugin apporte les modes suivants :

ModeModèle de service associé
cache [code]App-Vtom-Cache-Restapi-custom
jobs [code]App-Vtom-Jobs-Restapi-custom
list-jobs [code]Utilisé pour la découverte de services

Options disponibles​

Options des custom modes​

Les options spécifiques aux custom modes sont listées ci-dessous :

OptionDescription
--memcachedMemcached server to use (only one server).
--redis-serverRedis server to use (only one server). Syntax: address[:port]
--redis-attributeSet Redis Options (--redis-attribute="cnx_timeout=5").
--redis-dbSet Redis database index.
--failback-fileFall back on a local file if Redis connection fails.
--memexpirationTime to keep data in seconds (default: 86400).
--statefile-dirDefine the cache directory (default: '/var/lib/centreon/centplugins').
--statefile-suffixDefine a suffix to customize the statefile name (default: '').
--statefile-concat-cwdIf used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux.
--statefile-formatDefine the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default).
--statefile-keyDefine the key to encrypt/decrypt the cache.
--statefile-cipherDefine the cipher algorithm to encrypt the cache (default: 'AES').
--http-peer-addrSet the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution.
--proxyurlProxy URL. Example: http://my.proxy:3128
--proxypacProxy PAC file (can be a URL or a local file).
--insecureAccept insecure SSL connections.
--http-backendPerl library to use for HTTP transactions. Possible values are: lwp (default) and curl.
--hostnameSet hostname.
--portPort used (default: 30002)
--protoSpecify https if needed (default: 'https')
--api-usernameAPI username.
--api-passwordAPI password.
--tokenUse token authentication directly.
--timeoutSet timeout in seconds (default: 30).

Options des modes​

Les options disponibles pour chaque modèle de services sont listées ci-dessous :

OptionDescription
--filter-countersOnly display some counters (regexp can be used). Example: --filter-counters='total-error'
--filter-environmentFilter environment name (cannot be a regexp).
--filter-applicationFilter application name (cannot be a regexp).
--filter-nameFilter name (can be a regexp).
--timezoneSet date timezone. Can use format: 'Europe/London' or '+0100'.
--warning-statusDefine the conditions to match for the status to be WARNING (default: -) You can use the following variables: %{name}, %{status}, %{exit_code}, %{message}, %{environment}, %{application}
--critical-statusDefine the conditions to match for the status to be CRITICAL (default: '%{exit_code} =~ /Error/i'). You can use the following variables: %{name}, %{status}, %{exit_code}, %{message}, %{environment}, %{application}
--warning-longSet warning threshold for long jobs (default: none) You can use the following variables: %{name}, %{status}, %{elapsed}, %{application}
--critical-longSet critical threshold for long jobs (default: none). You can use the following variables: %{name}, %{status}, %{elapsed}, %{application}
--warning-* --critical-*Thresholds. Can be: 'running', 'errors', 'waiting', 'finished', 'notscheduled', 'descheduled', 'success-prct'.

Pour un mode, la liste de toutes les options disponibles et leur signification peut être affichée en ajoutant le paramètre --help à la commande :

/usr/lib/centreon/plugins/centreon_vtom_restapi.pl \
	--plugin=apps::vtom::restapi::plugin \
	--mode=jobs \
	--help