Aller au contenu principal

Eclipse Mosquitto MQTT

Contenu du pack​

Modèles​

Le connecteur de supervision Eclipse Mosquitto MQTT apporte un modèle d'hôte :

  • App-Eclipse-Mosquitto-Mqtt-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 serviceDescription
ClientsApp-Eclipse-Mosquitto-Mqtt-Clients-customContrôle le nombre de clients connectés
MessagesApp-Eclipse-Mosquitto-Mqtt-Messages-customContrôle le nombre de messages
UptimeApp-Eclipse-Mosquitto-Mqtt-Uptime-customDurée depuis laquelle le serveur tourne sans interruption

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

Métriques & statuts collectés​

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

MétriqueUnité
client.connectedcount
client.maximumcount
client.activecount
client.inactivecount

Prérequis​

Le connecteur de supervision Eclipse Mosquitto MQTT a besoin d'un accès réseau à l'instance Eclipse Mosquitto MQTT. Si le serveur Eclipse Mosquitto MQTT est configuré pour utiliser SSL, assurez-vous que le certificat du serveur est bien reconnu par le collecteur ou a minima que le certificat de l'autorité de certification est bien accessible par le plugin. Dans le cas contraire, la supervision devra se faire sans contrôle du certificat. Si le serveur Eclipse Mosquitto MQTT est configuré pour utiliser l'authentification, vous devrez disposer d'un compte en lecture seule.

Installer le connecteur de supervision​

Pack​

  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 > Gestionnaire de 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-eclipse-mosquitto-mqtt
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur Eclipse Mosquitto MQTT depuis l'interface web et le menu Configuration > Gestionnaire de 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-Eclipse-Mosquitto-MQTT

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-Eclipse-Mosquitto-Mqtt-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.
MacroDescriptionValeur par défautObligatoire
MQTTUSERNAMEMQTT username
MQTTPASSWORDMQTT password
MQTTPORTPort used by MQTT (default: 8883)8883
MQTTCACERTIFICATECA certificate file
MQTTSSLUse SSL for MQTT connection (default: 1)1
MQTTSSLCERTIFICATEClient SSL certificate file
MQTTSSLKEYClient SSL key file
MQTTEXTRAOPTIONSAny 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
WARNINGCLIENTSACTIVEThreshold
CRITICALCLIENTSACTIVEThreshold
WARNINGCLIENTSCONNECTEDThreshold
CRITICALCLIENTSCONNECTEDThreshold
WARNINGCLIENTSINACTIVEThreshold
CRITICALCLIENTSINACTIVEThreshold
WARNINGCLIENTSMAXIMUMThreshold
CRITICALCLIENTSMAXIMUMThreshold
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_eclipse_mosquitto_mqtt.pl \
    --plugin=apps::eclipse::mosquitto::mqtt::plugin \
    --mode=messages \
    --hostname='test.mosquitto.org' \
    --mqtt-port='1883' \
    --mqtt-ca-certificate='' \
    --mqtt-ssl-certificate='' \
    --mqtt-ssl-key='' \
    --mqtt-username='' \
    --mqtt-password='' \
    --mqtt-ssl='0'  \
    --warning-messages-stored='' \
    --critical-messages-stored='' \
    --warning-messages-received='' \
    --critical-messages-received='' \
    --warning-messages-sent='' \
    --critical-messages-sent=''

La commande devrait retourner un message de sortie similaire à :

OK: Stored messages: 73830, Received messages: 3281515467, Sent messages: 27697734205 | 'stored_messages'=73830;;;0; 'received_messages'=3281515467;;;0; 'sent_messages'=27697734205;;;0;

Diagnostic des erreurs communes​

Rendez-vous sur la documentation dédiée pour le diagnostic des erreurs communes des plugins Centreon.

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_eclipse_mosquitto_mqtt.pl \
    --plugin=apps::eclipse::mosquitto::mqtt::plugin \
    --list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
clients [code]App-Eclipse-Mosquitto-Mqtt-Clients-custom
messages [code]App-Eclipse-Mosquitto-Mqtt-Messages-custom
numeric-value [code]App-Eclipse-Mosquitto-Mqtt-Numeric-Value-custom
string-value [code]App-Eclipse-Mosquitto-Mqtt-String-Value-custom
uptime [code]App-Eclipse-Mosquitto-Mqtt-Uptime-custom

Options disponibles​

Options génériques​

Les options génériques sont listées ci-dessous :

OptionDescription
--modeDefine the mode in which you want the plugin to be executed (see --list-mode).
--dyn-modeSpecify a mode with the module's path (advanced).
--list-modeList all available modes.
--mode-versionCheck minimal version of mode. If not, unknown error.
--versionReturn the version of the plugin.
--pass-managerDefine the password manager you want to use.Supported managers are: environment, file, keepass, hashicorpvault and teampass.
--verboseDisplay extended status information (long output).
--debugDisplay debug messages.
--filter-perfdataFilter perfdata that match the regexp.Example: adding --filter-perfdata='avg' will remove all metrics that do not contain'avg' from performance data.
--filter-perfdata-advFilter perfdata based on a "if" condition using the following variables:label, value, unit, warning, critical, min, max.Variables must be written either %{variable} or %(variable).Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' willremove all metrics whose value equals 0 and that don't have a maximum value.
--explode-perfdata-maxCreate a new metric for each metric that comes with a maximum limit. The newmetric will be named identically with a '_max' suffix).Example: it will split 'used_prct'=26.93%;0:80;0:90;0;100into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;;
--change-perfdata --extend-perfdataChange or extend perfdata.Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[max]]Common examples:=over 4Convert storage free perfdata into used: --change-perfdata='free,used,invert()'Convert storage free perfdata into used: --change-perfdata='used,free,invert()'Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)'Scale traffic values in Mbps: --change-perfdata='traffic_in,,scale(Mbps),mbps'Change traffic values in percent: --change-perfdata='traffic_in,,percent()'=back
--change-perfdataChange or extend perfdata.Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[max]]Common examples:=over 4Convert storage free perfdata into used: --change-perfdata='free,used,invert()'Convert storage free perfdata into used: --change-perfdata='used,free,invert()'Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)'Scale traffic values in Mbps: --change-perfdata='traffic_in,,scale(Mbps),mbps'Change traffic values in percent: --change-perfdata='traffic_in,,percent()'=back
--extend-perfdataChange or extend perfdata.Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[max]]Common examples:=over 4Convert storage free perfdata into used: --change-perfdata='free,used,invert()'Convert storage free perfdata into used: --change-perfdata='used,free,invert()'Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)'Scale traffic values in Mbps: --change-perfdata='traffic_in,,scale(Mbps),mbps'Change traffic values in percent: --change-perfdata='traffic_in,,percent()'=back
--extend-perfdata-groupAdd new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names.Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation[,[newuom],[min],[max]]regex: regular expressionnamesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex).calculation: how the values of the new metrics should be calculatednewuom (optional): unit of measure for the new metricsmin (optional): lowest value the metrics can reachmax (optional): highest value the metrics can reachCommon examples:=over 4Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard|error)_(in|out))'Sum traffic by interface: --extend-perfdata-group='traffic_in_(.*),traffic_$1,sum(traffic_(in|out)_$1)'=back
--change-short-output --change-long-outputModify the short/long output that is returned by the plugin.Syntax: --change-short-output=pattern~replacement~modifierMost commonly used modifiers are i (case insensitive) and g (replace all occurrences).Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-short-outputModify the short/long output that is returned by the plugin.Syntax: --change-short-output=pattern~replacement~modifierMost commonly used modifiers are i (case insensitive) and g (replace all occurrences).Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-long-outputModify the short/long output that is returned by the plugin.Syntax: --change-short-output=pattern~replacement~modifierMost commonly used modifiers are i (case insensitive) and g (replace all occurrences).Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-exitReplace an exit code with one of your choice.Example: adding --change-exit=unknown=critical will result in a CRITICAL stateinstead of an UNKNOWN state.
--range-perfdataRewrite the ranges displayed in the perfdata. Accepted values:0: nothing is changed.1: if the lower value of the range is equal to 0, it is removed.2: remove the thresholds from the perfdata.
--filter-uomMask the units when they don't match the given regular expression.
--opt-exitReplace the exit code in case of an execution error (i.e. wrong option provided,SSH connection refused, timeout, etc). Default: unknown.
--output-ignore-perfdataRemove all the metrics from the service. The service will still have a statusand an output.
--output-ignore-labelRemove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from thebeginning of the output.Example: 'OK: Ram Total:...' will become 'Ram Total:...'
--output-xmlReturn the output in XML format (to send to an XML API).
--output-jsonReturn the output in JSON format (to send to a JSON API).
--output-openmetricsReturn the output in OpenMetrics format (to send to a tool expecting thisformat).
--output-fileWrite output in file (can be combined with json, xml and openmetrics options).E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt.
--disco-formatApplies only to modes beginning with 'list-'.Returns the list of available macros to configure a service discovery rule(formatted in XML).
--disco-showApplies only to modes beginning with 'list-'.Returns the list of discovered objects (formatted in XML) for service discovery.
--float-precisionDefine the float precision for thresholds (default: 8).
--source-encodingDefine the character encoding of the response sent by the monitored resourceDefault: 'UTF-8'.=head1 DESCRIPTIONB\<output>.=cut
--hostnameName or address of the host to monitor (mandatory).
--mqtt-portPort used by MQTT (default: 8883).
--mqtt-sslUse SSL for MQTT connection (default: 1).
--mqtt-ca-certificateCA certificate file.
--mqtt-ssl-certificateClient SSL certificate file.
--mqtt-ssl-keyClient SSL key file.
--mqtt-usernameMQTT username.
--mqtt-passwordMQTT password.
--mqtt-allow-insecureAllow unsecure login (default: 0).
--mqtt-timeoutMQTT timeout (default: 5).
--modes-execModes to use, separated by commas.Example for linux: --modes-exec=cpu,memory,storage,interfaces
--option-modeDefine options for the modes selected in --modes-exec.The option can be used several times.E.g.: to define two options for the interfaces mode and one for the storage mode:--option-mode='interfaces,--statefile-dir=/tmp' --option-mode='interfaces,--add-traffic' --option-mode='storage,--statefile-dir=/tmp'
--filter-countersOnly display some counters (regexp can be used).Example to check SSL connections only : --filter-counters='^xxxx|yyyy$'

Options des modes​

Les options disponibles pour chaque modèle de services 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-fileFailback 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 asa 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').
--warning- --critical-Thresholds.Can be: 'clients-connected', 'clients-maximum', 'clients-active', 'clients-inactive'.

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_eclipse_mosquitto_mqtt.pl \
    --plugin=apps::eclipse::mosquitto::mqtt::plugin \
    --mode=uptime \
    --help