Aller au contenu principal

NtopNG Rest API

Contenu du Pack​

Modèles​

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

  • App-Monitoring-Ntopng-Restapi-custom

Il apporte les Modèles de Service suivants :

Service AliasService TemplateDefaultDiscovery
AlertsApp-Monitoring-Ntopng-Restapi-AlertsX
Host-FlowsApp-Monitoring-Ntopng-Restapi-Host-Flows
Netflow-HealthApp-Monitoring-Ntopng-Restapi-Netflow-HealthX
Probe-HealthApp-Monitoring-Ntopng-Restapi-Probe-HealthX

Métriques & statuts collectés​

Metric nameDescriptionUnit
alerts.severity.error.countNumber of alerts with error severity
alerts.severity.warning.countNumber of alerts with warning severity
alerts.severity.info.countNumber of alerts with informational severity
alert statusCurrent alert status
type#alerts.type.detected.countNumber of alerts detected by type

Prérequis​

Afin de superviser votre NtopNG, l'API Rest doit être configurée. cf: https://www.ntop.org/guides/ntopng/api/

Installation​

  1. Installer le Plugin Centreon sur tous les collecteurs Centreon devant superviser des ressources NtopNG RestAPI :
yum install centreon-plugin-Applications-Monitoring-Ntopng-Restapi
  1. Sur l'interface Web de Centreon, installer le Pack NtopNG RestAPI 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 NtopNG RestAPI.
  • Appliquez le modèle d'hôte App-Monitoring-Ntopng-Restapi-custom.
  • Une fois le modèle appliqué, les macros ci-dessous indiquées comme requises (Obligatoire) doivent être renseignées.

Une fois celui-ci configuré, certaines macros doivent être renseignées:

MandatoryNameDescription
XNTOPNGAPIPORTPort used (Default: 3000)
XNTOPNGAPIPROTOSpecify https if needed (default: 'http')
XNTOPNGAPIUSERNAMEApi username
XNTOPNGAPIPASSWORDApi password
NTOPNGAPIEXTRAOPTIONSAny extra option you may want to add to the command (eg. a --verbose flag)

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_ntopng_restapi.pl \
--plugin=apps::monitoring::ntopng::restapi::plugin \
--mode=probe-health \
--hostname='10.0.0.1' \
--port='443' \
--proto='https' \
--api-username='my-username' \
--api-password='my-password' \
--verbose

La commande devrait retourner un message de sortie similaire à :

OK: cpu utilization: 2.10%, cpu load: 0.06, memory used: 11.83 %, dropped alerts: 0.00/s | 'cpu.utilization.percentage'=2.10%;;;0;100 'cpu.load.percentage'=0.06;;;0; 'memory.usage.percentage'=11.83%;;;0;100 'alerts.dropped.persecond'=0.00/s;;;0;

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_ntopng_restapi.pl \
--plugin=apps::monitoring::ntopng::restapi::plugin \
--mode=probe-health \
--help

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

/usr/lib/centreon/plugins/centreon_monitoring_ntopng_restapi.pl \
--plugin=apps::monitoring::ntopng::restapi::plugin \
--list-mode

Diagnostic des erreurs communes​

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