Exemples JMX YAML personnalisés

Il s'agit d'un exemple de fichier JMX YAML personnalisé pour l'agent Java de New Relic, comprenant la valeur et la définition, le MBean, l'attribut, le type et les noms des métriques, des objets et des attributs. Pour plus d'informations, y compris une vidéo, consultez Monitoring JMX personnalisée par YAML.

Exemple YAML

Voici un exemple de fichier JMX YAML personnalisé. Les fichiers YAML sont sensibles à l'espace.

name: TomcatCustom
version: 1.0
enabled: true
jmx:
  - object_name: Catalina:type=Cache,host=localhost,path=/examples
    metrics:
      - attributes: accessCount, cacheSize, hitsCount
        type: simple
  - object_name: Catalina:type=Connector,port=8009
    metrics:
      - attributes: bufferSize, maxHeaderCount
  - object_name: java.nio:type=BufferPool,name=*
    metrics:
      - attributes: Count
        type: monotonically_increasing

Exemple d'explication

Value	Definition
`name`	Un nom descriptif identifiant votre fichier instrumentation personnalisé YAML, en utilisant un espace avant le nom de la propriété. Dans l'exemple ci-dessus, le nom est `TomcatCustom`.
`version`	La version du fichier d'extension. Utilisez un double. Si deux extensions ont le même nom, seule l'extension avec la version la plus élevée sera utilisée. Utilisez un espace avant la version de la propriété. Dans l'exemple ci-dessus, la version est `1.0`.
`enabled`	Si `true`, l'agent Java lira l'extension. Si `false`, l’agent Java ignorera l’extension. Utilisez un espace avant la propriété activée. L'exemple ci-dessus est activé.

Chaque ligne du YAML commençant par - object_name représente un MBean. Par exemple, les lignes suivantes décrivent les informations à extraire du premier MBean :

- object_name: Catalina:type=Cache,host=localhost,path=/examples
  metrics:
    - attributes: accessCount, cacheSize, hitsCount
      type: simple

La propriété object_name elle-même peut correspondre à un ou plusieurs MBeans. Par exemple, la ligne ci-dessous ne correspond qu’à un seul MBean :

- object_name: Catalina:type=Cache,host=localhost,path=/examples

La ligne suivante peut correspondre à plusieurs MBeans :

- object_name: java.nio:type=BufferPool,name=*

Le caractère générique astérisque (*) ne peut être utilisé qu'avec JDK 1.6 et versions ultérieures.

Les trois MBeans répertoriés dans l'exemple ci-dessus ont les noms d'objet suivants :

Catalina:type=Cache,host=localhost,path=/examples
Catalina:type=Connector,port=8009
java.nio:type=BufferPool,name=*

Pour type, utilisez simple ou monotonically_increasing. Lorsque type n'est pas spécifié dans le fichier JMX YAML, la valeur par défaut est monotonically_increasing.

Valeur	Définition
`simple`	La valeur exacte de l'attribut sera signalée à New Relic chaque minute.
`monotonically_increasing`	La différence positive sera signalée à New Relic chaque minute.

Dans l'exemple ci-dessus, les attributs accessCount, cacheSize et hitsCount seront signalés comme simple. Les attributs bufferSize, maxHeaderCount et Count seront signalés comme monotonically_increasing.

Si la valeur de l'attribut hitsCount est toujours 5, New Relic signalera un 5 chaque minute.
Si la valeur de l'attribut Count est toujours 5, New Relic signalera un 0 pour la valeur chaque minute.
Si la valeur de l'attribut Count passe de 5 à 7, New Relic signalera un 2 pour cette minute.

Lorsque vous sélectionnez des métriques personnalisées dashboard et que vous n'utilisez pas la propriété root_metric_name, utilisez le format suivant pour toutes les métriques JMX personnalisées :

JMX/beginning_of_object_name/type/any_properties_in_object_name/attribute_name

Conseil

Certains noms d’objet n’incluent pas de type. Dans ce cas, un null sera présent dans le nom de la métrique.

Le fichier de configuration n'utilise pas root_metric_name, donc les métriques suivantes seront créées :

JMX/Catalina/Cache/localhost/examples/accessCount
JMX/Catalina/Cache/localhost/examples/cacheSize
JMX/Catalina/Cache/localhost/examples/hitsCount
JMX/Catalina/Connector/8009/bufferSize
JMX/Catalina/Connector/8009/maxHeaderCount
JMX/java.nio/BufferPool/direct/Count
JMX/java.nio/BufferPool/mapped/Count

Si vous utilisez la propriété root_metric_name, la métrique sera le nom de votre métrique racine préfixé par JMX et suivi du nom de l'attribut. Vous pouvez utiliser des valeurs de nom d'objet en spécifiant la clé de nom d'objet dans root_metric_name entre crochets {}. Par exemple:

Partie d'un fichier de configuration :

- object_name: Catalina:type=Cache,host=localhost,path=/examples
  root_metric_name: Tomcat/{host}
  metrics:
    - attributes: accessCount, cacheSize, hitsCount
      type: simple
- object_name: mbean:type=Sample,host=localhost,path=*
  root_metric_name: SampleMBean
  metrics:
    - attributes: attOne, attTwo
      type: simple

noms métriques :

JMX/Tomcat/localhost/accessCount
JMX/Tomcat/localhost/cacheSize
JMX/Tomcat/localhost/hitsCount
JMX/SampleMBean/attOne
JMX/SampleMBean/attTwo

Si un attribut n’existe pas réellement sur le MBean, la métrique n’apparaîtra jamais dans New Relic.

Recherche de noms d'objets et d'attributs

Le moyen le plus simple de trouver les MBeans disponibles et leurs attributs associés est d'utiliser les instructions JConsole pour JDK 1.6.

Cette traduction automatique est fournie pour votre commodité.

Exemple YAML

Exemple d'explication

Propriétés

Les MBeans

attribut

Type

noms métriques

Conseil

Recherche de noms d'objets et d'attributs

Cette traduction automatique est fournie pour votre commodité.

Exemples JMX YAML personnalisés

Exemple YAML.css-21sua1{background:none;border:none;width:0;padding:0;}

Exemple d'explication

Les MBeans

attribut

Type

noms métriques

Recherche de noms d'objets et d'attributs

Exemple YAML