Skip to main content

Eclipse Mosquitto MQTT

Pack assets​

Templates​

The Monitoring Connector Eclipse Mosquitto MQTT brings a host template:

  • App-Eclipse-Mosquitto-Mqtt-custom

The connector brings the following service templates (sorted by the host template they are attached to):

Service AliasService TemplateService Description
ClientsApp-Eclipse-Mosquitto-Mqtt-Clients-customCheck the number of connected clients
MessagesApp-Eclipse-Mosquitto-Mqtt-Messages-customCheck messages statistics
UptimeApp-Eclipse-Mosquitto-Mqtt-Uptime-customTime since the server has been working and available

The services listed above are created automatically when the App-Eclipse-Mosquitto-Mqtt-custom host template is used.

Collected metrics & status​

Here is the list of services for this connector, detailing all metrics linked to each service.

Metric nameUnit
client.connectedcount
client.maximumcount
client.activecount
client.inactivecount

Prerequisites​

The Eclipse Mosquitto MQTT monitoring connector needs network access to the Eclipse Mosquitto MQTT instance. If the Eclipse Mosquitto MQTT server is configured to use SSL, make sure the server's certificate is recognized by the poller, or that the certification authority's certificate is present on it. Otherwise, the host will have to monitor without controlling the certificate's legitimacy. If the Eclipse Mosquitto MQTT server is configured to use authentication, make your have a read-only account.

Installing the monitoring connector​

Pack​

  1. If the platform uses an online license, you can skip the package installation instruction below as it is not required to have the connector displayed within the Configuration > Monitoring Connector Manager menu. If the platform uses an offline license, install the package on the central server with the command corresponding to the operating system's package manager:
dnf install centreon-pack-applications-eclipse-mosquitto-mqtt
  1. Whatever the license type (online or offline), install the Eclipse Mosquitto MQTT connector through the Configuration > Monitoring Connector Manager menu.

Plugin​

Since Centreon 22.04, you can benefit from the 'Automatic plugin installation' feature. When this feature is enabled, you can skip the installation part below.

You still have to manually install the plugin on the poller(s) when:

  • Automatic plugin installation is turned off
  • You want to run a discovery job from a poller that doesn't monitor any resource of this kind yet

More information in the Installing the plugin section.

Use the commands below according to your operating system's package manager:

dnf install centreon-plugin-Applications-Eclipse-Mosquitto-MQTT

Using the monitoring connector​

Using a host template provided by the connector​

  1. Log into Centreon and add a new host through Configuration > Hosts.
  2. Fill in the Name, Alias & IP Address/DNS fields according to your resource's settings.
  3. Apply the App-Eclipse-Mosquitto-Mqtt-custom template to the host. A list of macros appears. Macros allow you to define how the connector will connect to the resource, and to customize the connector's behavior.
  4. Fill in the macros you want. Some macros are mandatory.
MacroDescriptionDefault valueMandatory
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). All options are listed here.
  1. Deploy the configuration. The host appears in the list of hosts, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the host: it shows the values of the macros.

Using a service template provided by the connector​

  1. If you have used a host template and checked Create Services linked to the Template too, the services linked to the template have been created automatically, using the corresponding service templates. Otherwise, create manually the services you want and apply a service template to them.
  2. Fill in the macros you want (e.g. to change the thresholds for the alerts). Some macros are mandatory (see the table below).
MacroDescriptionDefault valueMandatory
WARNINGCLIENTSACTIVEThreshold
CRITICALCLIENTSACTIVEThreshold
WARNINGCLIENTSCONNECTEDThreshold
CRITICALCLIENTSCONNECTEDThreshold
WARNINGCLIENTSINACTIVEThreshold
CRITICALCLIENTSINACTIVEThreshold
WARNINGCLIENTSMAXIMUMThreshold
CRITICALCLIENTSMAXIMUMThreshold
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). All options are listed here.
  1. Deploy the configuration. The service appears in the list of services, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the service: it shows the values of the macros.

How to check in the CLI that the configuration is OK and what are the main options for?​

Once the plugin is installed, log into your Centreon poller's CLI using the centreon-engine user account (su - centreon-engine). Test that the connector is able to monitor a resource using a command like this one (replace the sample values by yours):

/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=''

The expected command output is shown below:

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

Troubleshooting​

Please find the troubleshooting documentation for Centreon Plugins typical issues.

Available modes​

In most cases, a mode corresponds to a service template. The mode appears in the execution command for the connector. In the Centreon interface, you don't need to specify a mode explicitly: its use is implied when you apply a service template. However, you will need to specify the correct mode for the template if you want to test the execution command for the connector in your terminal.

All available modes can be displayed by adding the --list-mode parameter to the command:

/usr/lib/centreon/plugins/centreon_eclipse_mosquitto_mqtt.pl \
	--plugin=apps::eclipse::mosquitto::mqtt::plugin \
	--list-mode

The plugin brings the following modes:

ModeLinked service template
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

Available options​

Generic options​

All generic options are listed here:

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=patternreplacementmodifierMost commonly used modifiers are i (case insensitive) and g (replace all occurrences).Example: adding --change-short-output='OKUpgi' 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=patternreplacementmodifierMost commonly used modifiers are i (case insensitive) and g (replace all occurrences).Example: adding --change-short-output='OKUpgi' 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=patternreplacementmodifierMost commonly used modifiers are i (case insensitive) and g (replace all occurrences).Example: adding --change-short-output='OKUpgi' 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$'

Modes options​

All available options for each service template are listed below:

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'.

All available options for a given mode can be displayed by adding the --help parameter to the command:

/usr/lib/centreon/plugins/centreon_eclipse_mosquitto_mqtt.pl \
	--plugin=apps::eclipse::mosquitto::mqtt::plugin \
	--mode=uptime \
	--help