5 Découverte d'objets JMX

Aperçu

Il est possible de découvrir tous les attributs MBeans ou MBean JMX ou de spécifier un modèle pour la découverte de ces objets.

Il est indispensable de comprendre la différence entre Mbean et les attributs Mbean pour la configuration des règles de découverte. Un MBean est un objet pouvant représenter un périphérique, une application ou toute ressource devant être gérée.

Par exemple, il existe un Mbean qui représente un serveur Web. Ses attributs sont : nombre de connexions, nombre de threads, délai de requête, cache de fichier http, utilisation de la mémoire, etc. En exprimant cette pensée en langage humain compréhensif, nous pouvons définir une machine à café comme un Mbean dont les attributs à surveiller sont les suivants : quantité d'eau par tasse, consommation moyenne d'eau pendant une certaine période, nombre de grains de café requis par tasse, grains de café et temps de remplissage en eau, etc.

Clé d'élément

Dans la configuration de la règle de découverte, sélectionnez agent JMX dans le champ Type.

Deux clés d'élément sont prises en charge pour la découverte d'objets JMX - jmx.discovery[] et jmx.get[] :

Utilisation de jmx.discovery

Cet élément renvoie un objet JSON avec des macros de découverte de bas niveau décrivant des objets ou des attributs MBean. Par exemple, dans la découverte des attributs MBean (reformatés pour plus de clarté) :

[
           {
               "{#JMXVALUE}":"0",
               "{#JMXTYPE}":"java.lang.Long",
               "{#JMXOBJ}":"java.lang:type=GarbageCollector,name=PS Scavenge",
               "{#JMXDESC}":"java.lang:type=GarbageCollector,name=PS Scavenge,CollectionCount",
               "{#JMXATTR}":"CollectionCount"
           },
           {
               "{#JMXVALUE}":"0",
               "{#JMXTYPE}":"java.lang.Long",
               "{#JMXOBJ}":"java.lang:type=GarbageCollector,name=PS Scavenge",
               "{#JMXDESC}":"java.lang:type=GarbageCollector,name=PS Scavenge,CollectionTime",
               "{#JMXATTR}":"CollectionTime"
           },
           {
               "{#JMXVALUE}":"true",
               "{#JMXTYPE}":"java.lang.Boolean",
               "{#JMXOBJ}":"java.lang:type=GarbageCollector,name=PS Scavenge",
               "{#JMXDESC}":"java.lang:type=GarbageCollector,name=PS Scavenge,Valid",
               "{#JMXATTR}":"Valid"
           },
           {
               "{#JMXVALUE}":"PS Scavenge",
               "{#JMXTYPE}":"java.lang.String",
               "{#JMXOBJ}":"java.lang:type=GarbageCollector,name=PS Scavenge",
               "{#JMXDESC}":"java.lang:type=GarbageCollector,name=PS Scavenge,Name",
               "{#JMXATTR}":"Name"
           },
           {
               "{#JMXVALUE}":"java.lang:type=GarbageCollector,name=PS Scavenge",
               "{#JMXTYPE}":"javax.management.ObjectName",
               "{#JMXOBJ}":"java.lang:type=GarbageCollector,name=PS Scavenge",
               "{#JMXDESC}":"java.lang:type=GarbageCollector,name=PS Scavenge,ObjectName",
               "{#JMXATTR}":"ObjectName"
           }
       ]

Dans la découverte des MBeans (reformatés pour plus de clarté) :

[
           {
               "{#JMXDOMAIN}":"java.lang",
               "{#JMXTYPE}":"GarbageCollector",
               "{#JMXOBJ}":"java.lang:type=GarbageCollector,name=PS Scavenge",
               "{#JMXNAME}":"PS Scavenge"
           }
       ]

Macros prises en charge

Les macros suivantes sont prises en charge pour une utilisation dans le filter de la règle de découverte et les prototypes d'éléments, de déclencheurs et de graphiques :

Limitations

Certaines limitations sont associées à l'algorithme de création de noms de macros LLD à partir de noms de propriétés MBean :

• les noms d'attributs sont mis en majuscules
• les noms d'attributs sont ignorés (aucune macro LLD n'est générée) s'ils contiennent des caractères non pris en charge pour les noms de macro LLD. Les caractères pris en charge peuvent être décrits par l'expression régulière suivante : A-Z0-9_\.
• si un attribut est appelé "obj" ou "domaine", il sera ignoré en raison du chevauchement avec les valeurs des propriétés Zabbix réservées {#JMXOBJ} et {#JMXDOMAIN} (prises en charge depuis Zabbix 3.4.3.)

Veuillez considérer cet exemple jmx.discovery (avec le mode "beans"). MBean a les propriétés suivantes définies :

name=test
       тип=Type
       attributes []=1,2,3
       Name=NameOfTheTest
       domAin=some

À la suite de la découverte JMX, les macros LLD suivantes seront générées :

• {#JMXDOMAIN} - Zabbix interne, décrivant le domaine de MBean
• {#JMXOBJ} - Zabbix interne, décrivant l'objet MBean
• {#JMXNAME} - créé à partir de la propriété "name"

Les propriétés ignorées sont :

• тип : son nom contient des caractères non pris en charge (non-ASCII)
• attributes[] : son nom contient des caractères non pris en charge (les crochets ne sont pas pris en charge)
• Name : est déjà défini (name=test)
• domAin : est un nom réservé Zabbix

Exemples

Passons en revue deux autres exemples pratiques de création de règles LLD avec l'utilisation de Mbean. Pour mieux comprendre la différence entre une règle LLD collectant des Mbeans et une règle LLD collectant des attributs Mbean, veuillez consulter le tableau suivant :

Exemple 1 : Découvrir les MBeans

Cette règle renverra 3 objets : la ligne du haut de la colonne : MBean1, MBean2, MBean3.

Pour plus d'informations sur les objets, reportez-vous au tableau des macros prises en charge, section Découverte des MBeans.

La configuration de la règle de découverte collectant les MBeans (sans les attributs) ressemble à ceci :

La clé utilisée ici :

jmx.discovery[beans,"*:type=GarbageCollector,name=*"]

Tous les garbage collectors sans attributs seront découverts. Comme les Garbage collectors ont le même ensemble d'attributs, nous pouvons utiliser les attributs souhaités dans les prototypes d'éléments de la manière suivante :

Les clés utilisées ici :

jmx[{#JMXOBJ},CollectionCount] 
       jmx[{#JMXOBJ},CollectionTime] 
       jmx[{#JMXOBJ},Valid] 

La règle de découverte LLD se traduira par quelque chose de proche de cela (les éléments sont découverts pour deux garbage collectors) :

Exemple 2 : Découverte des attributs Mbean

Cette règle renverra 9 objets avec les champs suivants : MBean1Attribute1, MBean2Attribute1, MBean3Attribute1, MBean1Attribute2, MBean2Attribute2, Mbean3Attribute2, MBean1Attribute3, MBean2Attribute3, Mbean3Attribute3.

Pour plus d'informations sur les objets, reportez-vous au tableau des macros prises en charge, section Découverte des attributs MBean.

La configuration de la règle de découverte collectant les attributs Mbean ressemble à ceci :

La clé utilisée ici :

jmx.discovery[attributes,"*:type=GarbageCollector,name=*"]

Tous les garbage collectors avec un seul attribut d'élément seront découverts.

Dans ce cas particulier, un élément sera créé à partir du prototype pour chaque attribut MBean. Le principal inconvénient de cette configuration est que la création de déclencheurs à partir de prototypes de déclencheurs est impossible car il n'y a qu'un seul prototype d'élément pour tous les attributs. Cette configuration peut donc être utilisée pour la collecte de données, mais n'est pas recommandée pour la surveillance automatique.

Utilisation de jmx.get

jmx.get[] est similaire à l'élément jmx.discovery[], mais il ne transforme pas les propriétés d'objet Java en noms de macro de découverte de bas niveau et peut donc renvoyer des valeurs sans limitations qui sont associés à la génération de noms de macros LLD tels que des traits d'union ou des caractères non ASCII.

Lors de l'utilisation de jmx.get[] pour la découverte, les macros de découverte de bas niveau peuvent être définies séparément dans l'onglet personnalisé Macros LLD de la configuration de la règle de découverte, en utilisant JSONPath pour pointer vers les valeurs requises.

Découvrir les MBeans

Elément de découverte : jmx.get[beans,"com.example:type=*,*"]

Réponse :

[
           {
               "object": "com.example:type=Hello,data-src=data-base,ключ=значение",
               "domain": "com.example",
               "properties": {
                   "data-src": "data-base",
                   "ключ": "значение",
                   "type": "Hello"
               }
           },
           {
               "object": "com.example:type=Atomic",
               "domain": "com.example",
               "properties": {
                   "type": "Atomic"
               }
           }
       ]

Découvrir les attributs MBean

Elément de découverte : jmx.get[attributes,"com.example:type=*,*"]

Réponse :

[
           {
               "object": "com.example:type=*",
               "domain": "com.example",
               "properties": {
                   "type": "Simple"
               }
           },
           {
               "object": "com.zabbix:type=yes,domain=zabbix.com,data-source=/dev/rand,ключ=значение,obj=true",
               "domain": "com.zabbix",
               "properties": {
                   "type": "Hello",
                   "domain": "com.example",
                   "data-source": "/dev/rand",
                   "ключ": "значение",
                   "obj": true
               }
           }
       ]