ActiveMQ JMX

Dépendances du connecteur de supervision

Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur ActiveMQ JMX depuis la page Configuration > Connecteurs > Connecteurs de supervision :

Base Pack

Contenu du pack

Modèles

Le connecteur de supervision Activemq JMX apporte un modèle d'hôte :

App-Activemq-JMX-custom

Le connecteur apporte le modèle de service suivant (classé selon le modèle d'hôte auquel il est rattaché) :

App-Activemq-JMX-custom

Alias	Modèle de service	Description	Découverte
Brokers	App-Activemq-JMX-Brokers-custom	Contrôle l'état du broker ActiveMQ avec l'agent Jolokia	X

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

Si la case Découverte est cochée, cela signifie qu'une règle de découverte de service existe pour ce service.

Règles de découverte

Découverte de services

Nom de la règle	Description
App-Activemq-Jmx-Brokers-Name	Découvre les Brokers ActiveMQ

Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique de services et sa planification.

Métriques & statuts collectés

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

Brokers

Nom	Unité
status	N/A
brokers~broker.store.usage.percentage	%
brokers~broker.temporary.usage.percentage	%
brokers~broker.memory.usage.percentage	%
brokers~queue.average.enqueue.time.milliseconds	ms
brokers~queue.consumers.connected.count	count
brokers~queue.producers.connected.count	count
brokers~queue.memory.usage.percentage	%
brokers~queue.size.count	count
brokers~queue.messages.enqueued.count	count
brokers~queue.messages.dequeue.count	count
brokers~queue.messages.expired.count	count
brokers~queue.messages.inflighted.count	count
brokers~queue.messages.size.average.bytes	count
brokers~topic.average.enqueue.time.milliseconds	ms
brokers~topic.consumers.connected.count	count
brokers~topic.producers.connected.count	count
brokers~topic.memory.usage.percentage	%
brokers~topic.size.count	count
brokers~topic.messages.enqueued.count	count
brokers~topic.messages.dequeue.count	count
brokers~topic.messages.expired.count	count
brokers~topic.messages.inflighted.count	count
brokers~topic.messages.size.average.bytes	count

Prérequis

Configuration ActiveMQ

ActiveMQ embarque un agent Jolokia par défaut à l'adresse : http://localhost:8161/api/jolokia. Vous trouverez plus d'informations sur la documentation officielle d'ActiveMQ : https://activemq.apache.org/rest

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 > Connecteurs > 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-activemq-jmx

dnf install centreon-pack-applications-activemq-jmx

apt install centreon-pack-applications-activemq-jmx

yum install centreon-pack-applications-activemq-jmx

Quel que soit le type de la licence (online ou offline), installez le connecteur ActiveMQ JMX depuis l'interface web et le menu Configuration > Connecteurs > 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-ActiveMQ-Jmx

dnf install centreon-plugin-Applications-ActiveMQ-Jmx

apt install centreon-plugin-applications-activemq-jmx

yum install centreon-plugin-Applications-ActiveMQ-Jmx

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-Activemq-JMX-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	Obligatoire
JOLOKIAUSERNAME	Credentials to use for the HTTP request
JOLOKIAPASSWORD	Credentials to use for the HTTP request
JOLOKIAURL	Url where the jolokia agent is deployed. Example: http://localhost:8080/jolokia	X
JOLOKIAEXTRAOPTIONS	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.

Brokers

Macro	Description	Valeur par défaut
FILTERBROKERNAME	Filter broker name (can be a regexp)	.*
FILTERDESTINATIONNAME	Filter destination name (can be a regexp)	.*
FILTERDESTINATIONTYPE	Filter destination type (can be a regexp)	.*
WARNINGMEMORYUSAGE	Threshold
CRITICALMEMORYUSAGE	Threshold
WARNINGQUEUEAVERAGEENQUEUETIME	Threshold
CRITICALQUEUEAVERAGEENQUEUETIME	Threshold
WARNINGQUEUECONSUMERSCONNECTED	Threshold
CRITICALQUEUECONSUMERSCONNECTED	Threshold
WARNINGQUEUEMEMORYUSAGE	Threshold
CRITICALQUEUEMEMORYUSAGE	Threshold
WARNINGQUEUEMESSAGESDEQUEUED	Threshold
CRITICALQUEUEMESSAGESDEQUEUED	Threshold
WARNINGQUEUEMESSAGESENQUEUED	Threshold
CRITICALQUEUEMESSAGESENQUEUED	Threshold
WARNINGQUEUEMESSAGESEXPIRED	Threshold
CRITICALQUEUEMESSAGESEXPIRED	Threshold
WARNINGQUEUEMESSAGESINFLIGHTED	Threshold
CRITICALQUEUEMESSAGESINFLIGHTED	Threshold
WARNINGQUEUEMESSAGESSIZEAVERAGE	Threshold
CRITICALQUEUEMESSAGESSIZEAVERAGE	Threshold
WARNINGQUEUEPRODUCERSCONNECTED	Threshold
CRITICALQUEUEPRODUCERSCONNECTED	Threshold
WARNINGQUEUESIZE	Threshold
CRITICALQUEUESIZE	Threshold
WARNINGSTOREUSAGE	Threshold
CRITICALSTOREUSAGE	Threshold
WARNINGTEMPORARYUSAGE	Threshold
CRITICALTEMPORARYUSAGE	Threshold
WARNINGTOPICAVERAGEENQUEUETIME	Threshold
CRITICALTOPICAVERAGEENQUEUETIME	Threshold
WARNINGTOPICCONSUMERSCONNECTED	Threshold
CRITICALTOPICCONSUMERSCONNECTED	Threshold
WARNINGTOPICMEMORYUSAGE	Threshold
CRITICALTOPICMEMORYUSAGE	Threshold
WARNINGTOPICMESSAGESDEQUEUED	Threshold
CRITICALTOPICMESSAGESDEQUEUED	Threshold
WARNINGTOPICMESSAGESENQUEUED	Threshold
CRITICALTOPICMESSAGESENQUEUED	Threshold
WARNINGTOPICMESSAGESEXPIRED	Threshold
CRITICALTOPICMESSAGESEXPIRED	Threshold
WARNINGTOPICMESSAGESINFLIGHTED	Threshold
CRITICALTOPICMESSAGESINFLIGHTED	Threshold
WARNINGTOPICMESSAGESSIZEAVERAGE	Threshold
CRITICALTOPICMESSAGESSIZEAVERAGE	Threshold
WARNINGTOPICPRODUCERSCONNECTED	Threshold
CRITICALTOPICPRODUCERSCONNECTED	Threshold
WARNINGTOPICSIZE	Threshold
CRITICALTOPICSIZE	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_activemq_jmx.pl \
	--plugin=apps::mq::activemq::jmx::plugin \
	--mode=brokers \
	--url='XXXX' \
	--username='' \
	--password=''  \
	--filter-broker-name='.*' \
	--filter-destination-name='.*' \
	--filter-destination-type='.*' \
	--warning-topic-average-enqueue-time='' \
	--critical-topic-average-enqueue-time='' \
	--warning-topic-consumers-connected='' \
	--critical-topic-consumers-connected='' \
	--warning-topic-producers-connected='' \
	--critical-topic-producers-connected='' \
	--warning-topic-memory-usage='' \
	--critical-topic-memory-usage='' \
	--warning-topic-size='' \
	--critical-topic-size='' \
	--warning-topic-messages-enqueued='' \
	--critical-topic-messages-enqueued='' \
	--warning-topic-messages-dequeued='' \
	--critical-topic-messages-dequeued='' \
	--warning-topic-messages-expired='' \
	--critical-topic-messages-expired='' \
	--warning-topic-messages-inflighted='' \
	--critical-topic-messages-inflighted='' \
	--warning-topic-messages-size-average='' \
	--critical-topic-messages-size-average='' \
	--warning-store-usage='' \
	--critical-store-usage='' \
	--warning-temporary-usage='' \
	--critical-temporary-usage='' \
	--warning-memory-usage='' \
	--critical-memory-usage='' \
	--warning-queue-average-enqueue-time='' \
	--critical-queue-average-enqueue-time='' \
	--warning-queue-consumers-connected='' \
	--critical-queue-consumers-connected='' \
	--warning-queue-producers-connected='' \
	--critical-queue-producers-connected='' \
	--warning-queue-memory-usage='' \
	--critical-queue-memory-usage='' \
	--warning-queue-size='' \
	--critical-queue-size='' \
	--warning-queue-messages-enqueued='' \
	--critical-queue-messages-enqueued='' \
	--warning-queue-messages-dequeued='' \
	--critical-queue-messages-dequeued='' \
	--warning-queue-messages-expired='' \
	--critical-queue-messages-expired='' \
	--warning-queue-messages-inflighted='' \
	--critical-queue-messages-inflighted='' \
	--warning-queue-messages-size-average='' \
	--critical-queue-messages-size-average='' 

La commande devrait retourner un message de sortie similaire à :

OK: store usage: 29 % temporary usage: 31 % memory usage: 23 % | 'brokers~broker.store.usage.percentage'=29%;;;0;100 'brokers~broker.temporary.usage.percentage'=31%;;;0;100 'brokers~broker.memory.usage.percentage'=23%;;;0;100 

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_activemq_jmx.pl \
	--plugin=apps::mq::activemq::jmx::plugin \
	--list-mode

Le plugin apporte les modes suivants :

Mode	Modèle de service associé
brokers [code]	App-Activemq-JMX-Brokers-custom
list-brokers [code]	Used for service discovery

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.
--custommode	When a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option.
--list-custommode	List all available custom modes.
--multiple	Multiple custom mode objects. This may be required by some specific modes (advanced).
--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 "")' will remove 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 new metric will be named identically with a '_max' suffix. Example: it will split 'used_prct'=26.93%;0:80;0:90;0;100 into '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[,[<new-unit-of-mesure>],[min],[max]] Common examples: =over 4 Convert 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,<names-of-new-metrics>,calculation[,[<new-unit-of-mesure>],[min],[max]] regex: regular expression <names-of-new-metrics>: 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 calculated <new-unit-of-mesure> (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: =over 4 Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard\
--change-short-output --change-long-output	Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~~replacement~~modifier Most 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-exit	Replace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state.
--change-output-adv	Replace short output and exit code based on a "if" condition using the following variables: short_output, exit_code. Variables must be written either %{variable} or %(variable). Example: adding --change-output-adv='%(short_ouput) =~ /UNKNOWN: No daemon/,OK: No daemon,OK' will change the following specific UNKNOWN result to an OK result.
--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 status and an output.
--output-ignore-label	Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning 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 this format).
--output-file	Write output in file (can be combined with JSON, XML and OpenMetrics options). Example: --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 resource Default: 'UTF-8'. =head1 DESCRIPTION B<output>. =cut
--url	Url where the jolokia agent is deployed (required). Example: http://localhost:8080/jolokia
--timeout	Timeout in seconds for HTTP requests (default: 30 seconds)
--username	Credentials to use for the HTTP request
--password	Credentials to use for the HTTP request
--proxy-url	Optional HTTP proxy to use.
--proxy-username	Credentials to use for the proxy
--proxy-password	Credentials to use for the proxy
--target-url	Target to use (if you use jolokia agent as a proxy in --url option).
--target-username	Credentials to use for the target
--target-password	Credentials to use for the target

Options des modes

Les options disponibles pour chaque modèle de services sont listées ci-dessous :

Brokers

Option	Description
--filter-counters	Only display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx\
--filter-broker-name	Filter broker name (can be a regexp).
--filter-destination-name	Filter destination name (can be a regexp).
--filter-destination-type	Filter destination type (can be a regexp).
--request	EXPERIMENTAL Option : Community-supported only (no support from Centreon at this time) Set the MBean and attributes to request (will replace defaults) in a JSON-formatted fashion. This is useful to reduce the size of returned data by providing destination type and name or broker name instead of filtering afterwards, and grabbing exactly the wanted attributes. This can be set multiple times. Example: --request='{"mbean":"org.apache.activemq:brokerName=,destinationName=MyQueue,destinationType=Queue,type=Broker","attributes":[{"name":"QueueSize"}]}' --request='{"mbean":"org.apache.activemq:brokerName=,type=Broker,service=Health","attributes":[{"name":"CurrentStatus"}]}'
--warning-status	Define the conditions to match for the status to be WARNING. You can use the following variables: %{status}, %{name}
--critical-status	Define the conditions to match for the status to be CRITICAL (default: '%{status} !~ /Good/i'). You can use the following variables: %{status}, %{name}
--warning-* --critical-*	Thresholds. Can be: 'store-usage' (%), 'temporary-usage' (%), 'memory-usage' (%), 'queue-average-enqueue-time' (ms), 'queue-consumers-connected', 'queue-producers-connected', 'queue-memory-usage' (%), 'queue-size', 'queue-messages-enqueued', 'queue-messages-dequeued', 'queue-messages-expired', 'queue-messages-inflighted', 'topic-average-enqueue-time' (ms), 'topic-consumers-connected', 'topic-producers-connected', 'topic-memory-usage' (%), 'topic-size', 'topic-messages-enqueued', 'topic-messages-dequeued', 'topic-messages-expired', 'topic-messages-inflighted'.

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_activemq_jmx.pl \
	--plugin=apps::mq::activemq::jmx::plugin \
	--mode=brokers \
	--help

Dépendances du connecteur de supervision​

Contenu du pack​

Modèles​

Règles de découverte​

Découverte de services​

Métriques & statuts collectés​

Prérequis​

Configuration ActiveMQ​

Installer le connecteur de supervision​

Pack​

Plugin​

Utiliser le connecteur de supervision​

Utiliser un modèle d'hôte issu du connecteur​

Utiliser un modèle de service issu du connecteur​

Comment puis-je tester le plugin et que signifient les options des commandes ?​

Diagnostic des erreurs communes​

Modes disponibles​

Options disponibles​

Options génériques​

Options des modes​