Page History

Introduction

Shinken Enterprise relies on external programs (called check plugins) to monitor a very wide variety of devices, applications and networked services.

What Are Plugins?

Plugins are compiled executables or scripts (Perl scripts, shell scripts, etc.) that can be run from a command line to check the status of a host or check. Shinken Enterprise uses the results from plugins to determine the current status of hosts and checks on your network and obtain performance data about the monitored service.

s’appuie sur des programmes externes appelés "plugin de check ou sonde" pour pouvoir superviser une large variété d'éléments 

Que'est ce qu'un plugin?

Les sondes sont des exécutables compilés ou des scripts (scripts Perl , scripts shell scripts, etc.) qu peuvent être lancés par une ligne de commande afin de vérifier le statut d'un hôte ou d'un check. Shinken Enterprise utilise les retours de ces sondes pour déterminer le statut des éléments 

Shinken Enterprise lancera une sonde à chaque fois que ce sera nécessaire pour vérifier un statut. La sonde fait quelque chose (terme volontairement générique) pour procéder à la vérification en simplement retourner le résultat vers Shinken Enterprise  qui prendra alors les actions nécessaires en fonction de ce retour (lancement d'événement, envoi de Shinken Enterprise will execute a plugin whenever there is a need to check the status of a service or host. The plugin does something (notice the very general term) to perform the check and then simply returns the results to Shinken Enterprise . It will process the results that it receives from the plugin and take any necessary actions (running event handlers, sending out notifications, etc).

...

Les sondes à un niveau d'abstraction 

Plugins act as an abstraction layer between the monitoring logic present in the Shinken Enterprise daemon and the actual services and hosts that are being monitored.

The value of this type of plugin architecture is that you can monitor just about anything you can think of.
If you can automate the process of checking something, you can monitor it with Shinken Enterprise .
There are already literally thousands of plugins that have been created in order to monitor basic resources such as processor load, disk usage, ping rates, etc.
If you want to monitor something else, take a look at the documentation on Copie de Plugins and roll your own. It's simple!

...

Les sondes agissent à un niveau d'abstraction entre la logique de supervision présente dans les démons de Shinken Enterprise et les hôtes supervisés. 

Le gros intérêt de l'approche "sonde" est que l'on peut à peur près tout type d'élément. 
Si vous pouvez automatiser le process de vérification d'un élément, alors vous pouvez le faire avec Shinken Enterprise .
Il y a plusieurs milliers de sondes (ou plugin) créées pour superviser des ressources du type charge du processeur, utilisation disque, taux de ping, etc..
Si vous souhaitez superviser quelque chose d'autre, référez vous au paragraphe Plugins API et créez le votre, c'est aussi simple !

Quels sondes sont disponibles ?

Il y a des sondes pour surveiller tout type d'éléments et services .

Ils utilisent des protocoles classiques

What Plugins Are Available?

There are plugins to monitor many different kinds of devices and services.

They use basic monitoring protocols including:  WMI, SNMP, SSH, TCP, UDP, ICMP, LDAP and moreThey can monitor pretty much anythinget plus encore

Cela permet de surveiller à peu près tout:

• Unix/Linux, Windows

• RoutersRouteurs, Switches

• Network services réseau: "HTTP", "POP3", "IMAP", "FTP", "SSH", "DHCP"

• Charge CPU Load , Disk Usage, Memory Usage, Current Usersutilisation disque, utilisation mémoire..

• Applications, databases, logs and moreet plus.

...

Récupérer des sondes

Shinken Enterprise are delivered with numerous plugins.est livré en standard avec un pack de sondes.

Vous pouvez en trouver beaucoup d'autres dans la communauté Nagios, et plus particulièrement dans les espaces suivantsYou can obtain new one from various website in the Nagios community world, and especially theses ones:

• Monitoring Plugins Project: https://www.monitoring-plugins.org
• Nagios plugin exchange: https://exchange.nagios.org/
  

How Do I Use Plugin X?

Comment utiliser la sonde X?

La plupart des sondes présente des informations de type utilisation en les exécutant avec l'extension Most plugins will display basic usage information when you execute them using "-h" or ou "--help" on the command linedans la ligne de commande.

For example, if you want to know how the check¨Par exemple, si vous voulez savoir comment fonctionne la sonde _http plugin works or what options it accepts, you should try executing the following command:ou quelles options dont possibles, vous devez lancer la commande suivante : 

./check_http --help

...

...

API de sonde

Plugin Overview

Scripts and executables must do two things (at least) in order to work as Shinken Enterprise plugins:

• Exit with one of several possible return values

• Return at least one line of text output to "STDOUT"

The inner workings of your plugin are not important to Shinken Enterprise , interface between them is important.

...

Concept de sonde

Les scripts et les exécutables doivent faire au moins 2 choses :

• sortir avec l'un des nombreuses valeurs possibles en retour 

• retourner au moins une ligne de texte vers "STDOUT"

Le fonctionnement interne de la sonde importe peu à Shinken Enterprise , c'est l'interface entre eux qui compte.

Votre sonde peut vérifier le statut d'un port TCP port,lancer une requête sur une base de données, ou faire tout ce qui est nécessaire pour vérifier un élément. 
Les détails dépendront ce qui doit être vérifié. 

Code retour :

Shinken Enterprise détermine le statut d'un hôte ou d'un check en évaluant le code retour de la sonde .
La table suivante montre la liste des valeurs possibles, avec leur correspondance possible .

Return Code

Shinken Enterprise determines the status of a host or service by evaluating the return code from plugins.
The following tables shows a list of valid return codes, along with their corresponding service or host states.

Plugin Output Spec

At least, plugins should return one of text output. Plugins may also return optional performance data that can be processed by the metrology modules.

Spécification des données en sortie de sonde

Au minimum, la sonde doit retourner une ligne de texte. La sonde peut également retourner en option des données de performance pour la métrologie.  

Le format standard de sortie d'une sonde est le suivant The basic format for plugin output is shown below :

TEXT OUTPUT | OPTIONAL PERFDATA

The performance data is optional.

Les données de performance sont optionnelles.

Si un sonde retourne des données de performance, elles doivent être séparées du reste du texte par le symbole If a plugin returns performance data in its output, it must separate the performance data from the other text output using a pipe (|) symbol .

...

Let's see some examples of possible plugin output...

Case 1: One line of output (text only)

Exemples de retour de sonde 

Voyons quelques exemples possibles

Cas 1: une ligne de retour (texte seulement)

Imaginons une sonde qui retourne une ligne telle que décrite en dessous Assume we have a plugin that returns one line of output that looks like this :

DISK OK - free space: /var 3326 MB (56%);

...

Si cette sonde est utilisée pour réaliser une verification de service, la totalité de al ligne retour sera stockée dans $SERVICEOUTPUT$ .

Cas 2: une ligne de retour (texte et données de performance)

La sonde peut retourner en option des données de performance utilisable par une application tierce. Dans ce cas, les données de performance doivent être séparées par le symbole pipe (|)

Case 2: One line of output (text and perfdata)

A plugin can return optional performance data for use by external applications. To do this, the performance data must be separated from the text output with a pipe (|) symbol like such :

DISK OK - used space: /var 3326 MB (56%); | /var=3326

...

Si cette sonde est utilisée pour vérifier un service, la partie à gauche du symbole sera stockée dans  <$SERVICEOUTPUT$>  et la partie à droite du séparateur seront stockées dans  $SERVICEPERFDATA$

Une donnée de performance est composée au minimum de

A perfdata is composed at a minimum of :

key=value

For examplePar exemple:

/var=3326

Then in option you can have more informationVous pouvez alors avoir en option plus d'informations :

 key=valueUNIT;warning;critical;minimumvalue;maximalvalue

...

/var=3326MB;5948;5958;0;5968

You can have as mush perfdata as you want, just by separating values with spaceVous pouvez avoir une série de données de performance séparées par un espace :

HTTP OK: HTTP/1.1 200 OK - 20156 bytes in 0.271 second response time |time=0.270634s;;;0.000000 size=20156B;;;0

...

Durée de rétention des données retour 

Shinken Enterprise will only read the first 64 KB of data that a plugin returns. This is done in order to prevent runaway plugins from dumping megs or gigs of data back to Shinken Enterprise va seulement lires les premiers 64 KB de données qu'une sonde retourne. Cela évite de surcharger une base de données.