Aller au contenu principal

Gorgone Restapi

Vue d'ensemble​

Le démon Gorgone est un gestionnaire de tâche en mode distribué (https://github.com/centreon/centreon-gorgone).

connecteur de supervision assets​

Objets supervisés​

  • Instances gorgoned

Métriques collectées​

Metric nameDescription
path.events.total.countBy instances. e.g. internal external. Number of events on a path
event.total.countBy instances. e.g. internal~pong, internal~command, ... Number of a specific event

Prérequis​

Configuration de Gorgone​

Assurer vous que le module Gorgone httpserver est correctement configuré. Au besoin, ajouter le avec la directive suivante

modules:
- name: httpserver
package: "gorgone::modules::core::httpserver::hooks"
enable: true
address: "0.0.0.0"
port: "8085"
ssl: false
auth:
enabled: false
allowed_hosts:
enabled: true
subnets:
- 127.0.0.1/32

Setup​

  1. Installer le Plugin sur les Poller supervisant des instances de Gorgone:
yum install centreon-plugin-Applications-Gorgone-Restapi
  1. Dans l'interface Centreon, rendez-vous dans le menu Configuration > Gestionnaire de connecteurs de supervision et installer le connecteur de supervision 'Gorgone Rest API'

Configuration​

  • Rendez-vous dans le menu "Configuration > Hôtes" et ajouter un nouvel Hôte
  • Appliquer le modèle App-Gorgone-Restapi-custom et configurer les macros obligatoires mentionnées ci-dessous:
MandatoryNomDescription
XGORGONEAPIPORTPort used. Default is 8085
XGORGONEAPIPROTOProtocol used. Default is http
GORGONEAPIUSERNAMEUsername to access to the API.
GORGONEAPIPASSWORDPassword to access to the API.
GORGONEAPIEXTRAOPTIONSAny extra option you may want to add to the command (eg. a --verbose flag)

FAQ​

Comment tester le Plugin et quelle est la signification des options principales​

Une fois le Plugin installé, vous pouvez l'exécuter avec l'utilisateur centreon-engine:

/usr/lib/centreon/plugins/centreon_gorgone_restapi.pl \
--plugin=apps::gorgone::restapi::plugin \
--mode=events \
--hostname='127.0.0.1' \
--port='8085' \
--proto='http' \
--verbose

Cette commande superviser le nombre d'événements traités par Gorgone. Lorsqu'une authentification basique est configurée, il est nécessaire de spécifier le nom d'utilisateur et le mot de passe dans la commande comme ceci (--api-username='John.doe' --api-password='6fbadZEJbsLG').

Le résultat attendu est similaire à:

OK: All paths are ok | 'external#path.events.total.count'=0;;;0; 'internal#path.events.total.count'=12;;;0; 'internal~actionready#event.total.count'=0;;;0; 'internal~bcastlogger#event.total.count'=0;;;0; 'internal~centreonnodesready#event.total.count'=0;;;0; 'internal~command#event.total.count'=0;;;0; 'internal~constatus#event.total.count'=1;;;0; 'internal~dbcleanerready#event.total.count'=0;;;0; 'internal~enginecommand#event.total.count'=0;;;0; 'internal~engineready#event.total.count'=0;;;0; 'internal~httpserverready#event.total.count'=0;;;0; 'internal~information#event.total.count'=1;;;0; 'internal~judgeready#event.total.count'=0;;;0; 'internal~legacycmdready#event.total.count'=0;;;0; 'internal~pipelineready#event.total.count'=0;;;0; 'internal~pong#event.total.count'=6;;;0; 'internal~proxyready#event.total.count'=0;;;0; 'internal~putlog#event.total.count'=0;;;0; 'internal~registernodes#event.total.count'=0;;;0; 'internal~setcoreid#event.total.count'=0;;;0; 'internal~setlogs#event.total.count'=4;;;0; 'internal~unregisternodes#event.total.count'=0;;;0;
checking path 'external'
total events: 0
checking path 'internal'
total events: 12
event 'actionready' total: 0
...

Les options permettant au Plugin de déclencher des alertes peuvent être affiché via l'aide de la sonde. (--help):

/usr/lib/centreon/plugins/centreon_gorgone_restapi.pl \
--plugin=apps::gorgone::restapi::plugin \
--mode=events \
--help

Il est possible d'afficher l'ensemble des modes disponibles avec la commande ci-dessous:

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