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) :
- App-Eclipse-Mosquitto-Mqtt-custom
- Non rattachés à un modèle d'hôte
Alias | Modèle de service | Description |
---|---|---|
Clients | App-Eclipse-Mosquitto-Mqtt-Clients-custom | Contrôle le nombre de clients connectés |
Messages | App-Eclipse-Mosquitto-Mqtt-Messages-custom | Contrôle le nombre de messages |
Uptime | App-Eclipse-Mosquitto-Mqtt-Uptime-custom | Duré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é.
Alias | Modèle de service | Description |
---|---|---|
Numeric-Value | App-Eclipse-Mosquitto-Mqtt-Numeric-Value-custom | Contrôle permettant de récupérer une valeur numérique d'un topic |
String-Value | App-Eclipse-Mosquitto-Mqtt-String-Value-custom | Contrôle permettant de récupérer une chaîne de caractères d'un topic |
Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, créez un service manuellement et appliquez le modèle de service souhaité.
Métriques & statuts collectés​
Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service.
- Clients
- Messages
- Numeric-Value
- String-Value
- Uptime
Métrique | Unité |
---|---|
client.connected | count |
client.maximum | count |
client.active | count |
client.inactive | count |
Métrique | Unité |
---|---|
messages.stored | count |
messages.received | count |
messages.sent | count |
Les métriques obtenues dépendent entièrement de la configuration.
Pour obtenir ce nouveau format de métrique, incluez la valeur --use-new-perfdata dans la macro de service EXTRAOPTIONS.
Pas de métrique pour ce service.
Pour obtenir ce nouveau format de métrique, incluez la valeur --use-new-perfdata dans la macro de service EXTRAOPTIONS.
Métrique | Unité |
---|---|
system.uptime.seconds | s |
Pour obtenir ce nouveau format de métrique, incluez la valeur --use-new-perfdata dans la macro de service EXTRAOPTIONS.
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​
- 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 :
- Alma / RHEL / Oracle Linux 8
- Alma / RHEL / Oracle Linux 9
- Debian 11 & 12
- CentOS 7
dnf install centreon-pack-applications-eclipse-mosquitto-mqtt
dnf install centreon-pack-applications-eclipse-mosquitto-mqtt
apt install centreon-pack-applications-eclipse-mosquitto-mqtt
yum install centreon-pack-applications-eclipse-mosquitto-mqtt
- 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 :
- Alma / RHEL / Oracle Linux 8
- Alma / RHEL / Oracle Linux 9
- Debian 11 & 12
- CentOS 7
dnf install centreon-plugin-Applications-Eclipse-Mosquitto-MQTT
dnf install centreon-plugin-Applications-Eclipse-Mosquitto-MQTT
apt install centreon-plugin-applications-eclipse-mosquitto-mqtt
yum install centreon-plugin-Applications-Eclipse-Mosquitto-MQTT
Utiliser le connecteur de supervision​
Utiliser un modèle d'hôte issu du connecteur​
- Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
- Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre ressource.
- 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.
- Renseignez les macros désirées. Attention, certaines macros sont obligatoires.
Macro | Description | Valeur par défaut | Obligatoire |
---|---|---|---|
MQTTUSERNAME | MQTT username | ||
MQTTPASSWORD | MQTT password | ||
MQTTPORT | Port used by MQTT (default: 8883) | 8883 | |
MQTTCACERTIFICATE | CA certificate file | ||
MQTTSSL | Use SSL for MQTT connection (default: 1) | 1 | |
MQTTSSLCERTIFICATE | Client SSL certificate file | ||
MQTTSSLKEY | Client SSL key file | ||
MQTTEXTRAOPTIONS | Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées ici. |
- 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​
- 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.
- 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.
- Clients
- Messages
- Numeric-Value
- String-Value
- Uptime
Macro | Description | Valeur par défaut | Obligatoire |
---|---|---|---|
WARNINGCLIENTSACTIVE | Threshold | ||
CRITICALCLIENTSACTIVE | Threshold | ||
WARNINGCLIENTSCONNECTED | Threshold | ||
CRITICALCLIENTSCONNECTED | Threshold | ||
WARNINGCLIENTSINACTIVE | Threshold | ||
CRITICALCLIENTSINACTIVE | Threshold | ||
WARNINGCLIENTSMAXIMUM | Threshold | ||
CRITICALCLIENTSMAXIMUM | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici. |
Macro | Description | Valeur par défaut | Obligatoire |
---|---|---|---|
WARNINGMESSAGESRECEIVED | Threshold | ||
CRITICALMESSAGESRECEIVED | Threshold | ||
WARNINGMESSAGESSENT | Threshold | ||
CRITICALMESSAGESSENT | Threshold | ||
WARNINGMESSAGESSTORED | Threshold | ||
CRITICALMESSAGESSTORED | Threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici. |
Macro | Description | Valeur par défaut | Obligatoire |
---|---|---|---|
PERFDATANAME | Perfdata name in perfdata output (default: 'value') | value | |
TOPIC | Topic value to check | X | |
EXTRACTEDPATTERN | Define a pattern to extract a number from the returned string | ||
FORMAT | Output format (default: 'current value is %s') | ||
FORMATCUSTOM | Apply a custom change on the value(example to multiply the value: --format-custom='* 8') | ||
PERFDATAUNIT | Perfdata unit in perfdata output (default: '') | ||
PERFDATAMIN | Minimum value to add in perfdata output (default: '') | ||
PERFDATAMAX | Maximum value to add in perfdata output (default: '') | ||
WARNING | Warning threshold | ||
CRITICAL | Critical threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici. |
Macro | Description | Valeur par défaut | Obligatoire |
---|---|---|---|
FORMATOK | Threshold | value: %{value} | |
FORMATUNKNOWN | Threshold | value: %{value} | |
TOPIC | Topic value to check | X | |
FORMATCUSTOM | Apply a custom change on the value | ||
UNKNOWNREGEXP | |||
FORMATWARNING | Threshold | value: %{value} | |
FORMATCRITICAL | Threshold | value: %{value} | |
WARNINGREGEXP | Return Warning if the topic value match the regexp | ||
CRITICALREGEXP | Return Critical if the topic value match the regexp | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici. |
Macro | Description | Valeur par défaut | Obligatoire |
---|---|---|---|
WARNINGUPTIME | Warning threshold | ||
CRITICALUPTIME | Critical threshold | ||
EXTRAOPTIONS | Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici. |
- 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 :
Mode | Modè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 :
Option | Description |
---|---|
--mode | Define the mode in which you want the plugin to be executed (see --list-mode). |
--dyn-mode | Specify a mode with the module's path (advanced). |
--list-mode | List all available modes. |
--mode-version | Check minimal version of mode. If not, unknown error. |
--version | Return the version of the plugin. |
--pass-manager | Define the password manager you want to use.Supported managers are: environment, file, keepass, hashicorpvault and teampass. |
--verbose | Display extended status information (long output). |
--debug | Display debug messages. |
--filter-perfdata | Filter perfdata that match the regexp.Example: adding --filter-perfdata='avg' will remove all metrics that do not contain'avg' from performance data. |
--filter-perfdata-adv | Filter 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-max | Create 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-perfdata | Change 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-perfdata | Change 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 | Change 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-group | Add 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-output | Modify the short/long output that is returned by the plugin.Syntax: --change-short-output=pattern |
--change-short-output | Modify the short/long output that is returned by the plugin.Syntax: --change-short-output=pattern |
--change-long-output | Modify the short/long output that is returned by the plugin.Syntax: --change-short-output=pattern |
--change-exit | Replace 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-perfdata | Rewrite 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-uom | Mask the units when they don't match the given regular expression. |
--opt-exit | Replace the exit code in case of an execution error (i.e. wrong option provided,SSH connection refused, timeout, etc). Default: unknown. |
--output-ignore-perfdata | Remove all the metrics from the service. The service will still have a statusand an output. |
--output-ignore-label | Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from thebeginning of the output.Example: 'OK: Ram Total:...' will become 'Ram Total:...' |
--output-xml | Return the output in XML format (to send to an XML API). |
--output-json | Return the output in JSON format (to send to a JSON API). |
--output-openmetrics | Return the output in OpenMetrics format (to send to a tool expecting thisformat). |
--output-file | Write 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-format | Applies only to modes beginning with 'list-'.Returns the list of available macros to configure a service discovery rule(formatted in XML). |
--disco-show | Applies only to modes beginning with 'list-'.Returns the list of discovered objects (formatted in XML) for service discovery. |
--float-precision | Define the float precision for thresholds (default: 8). |
--source-encoding | Define the character encoding of the response sent by the monitored resourceDefault: 'UTF-8'.=head1 DESCRIPTIONB<output>.=cut |
--hostname | Name or address of the host to monitor (mandatory). |
--mqtt-port | Port used by MQTT (default: 8883). |
--mqtt-ssl | Use SSL for MQTT connection (default: 1). |
--mqtt-ca-certificate | CA certificate file. |
--mqtt-ssl-certificate | Client SSL certificate file. |
--mqtt-ssl-key | Client SSL key file. |
--mqtt-username | MQTT username. |
--mqtt-password | MQTT password. |
--mqtt-allow-insecure | Allow unsecure login (default: 0). |
--mqtt-timeout | MQTT timeout (default: 5). |
--modes-exec | Modes to use, separated by commas.Example for linux: --modes-exec=cpu,memory,storage,interfaces |
--option-mode | Define 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-counters | Only 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 :
- Clients
- Messages
- Numeric-Value
- String-Value
- Uptime
Option | Description |
---|---|
--memcached | Memcached server to use (only one server). |
--redis-server | Redis server to use (only one server). Syntax: address[:port] |
--redis-attribute | Set Redis Options (--redis-attribute="cnx_timeout=5"). |
--redis-db | Set Redis database index. |
--failback-file | Failback on a local file if Redis connection fails. |
--memexpiration | Time to keep data in seconds (default: 86400). |
--statefile-dir | Define the cache directory (default: '/var/lib/centreon/centplugins'). |
--statefile-suffix | Define a suffix to customize the statefile name (default: ''). |
--statefile-concat-cwd | If 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-format | Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default). |
--statefile-key | Define the key to encrypt/decrypt the cache. |
--statefile-cipher | Define the cipher algorithm to encrypt the cache (default: 'AES'). |
--warning-* --critical-* | Thresholds.Can be: 'clients-connected', 'clients-maximum', 'clients-active', 'clients-inactive'. |
Option | Description |
---|---|
--warning-* --critical-* | Thresholds.Can be: 'messages-stored', 'messages-received', 'messages-sent'. |
Option | Description |
---|---|
--topic | Topic value to check. |
--warning | Warning threshold. |
--critical | Critical threshold. |
--extracted-pattern | Define a pattern to extract a number from the returned string. |
--format | Output format (default: 'current value is %s') |
--format-custom | Apply a custom change on the value(example to multiply the value: --format-custom='* 8'). |
--perfdata-unit | Perfdata unit in perfdata output (default: '') |
--perfdata-name | Perfdata name in perfdata output (default: 'value') |
--perfdata-min | Minimum value to add in perfdata output (default: '') |
--perfdata-max | Maximum value to add in perfdata output (default: '') |
Option | Description |
---|---|
--topic | Topic value to check. |
--format-custom | Apply a custom change on the value. |
--warning-regexp | Return Warning if the topic value match the regexp. |
--critical-regexp | Return Critical if the topic value match the regexp. |
--regexp-insensitive | Allows to use case-insensitive regexp. |
--format-* | Output format according to the threshold.Can be:'ok' (default: 'value: %{value}'),'warning' (default: 'value: %{value}'),'critical' (default: 'value: %{value}'),'unknown' (default: 'value: %{value}'). |
Option | Description |
---|---|
--warning-uptime | Warning threshold. |
--critical-uptime | Critical threshold. |
--unit | Select the time unit for thresholds. May be 's' for seconds, 'm' for minutes, 'h' for hours, 'd' for days, 'w' for weeks. Default is seconds. |
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