agent Java: instrumentation JMX personnalisée par YAML

La plateforme Java SE comprend Java Management Extensions (JMX). JMX est un moyen de monitorer et de gérer les applications, les appareils et les services. En général, les serveurs application disposent de métriques JMX intégrées que vous pouvez monitorer.

L'agent Java de New Relic offre la possibilité de monitorer des métriques spécifiques à partir de MBeans et d'attributs dans votre application sans modifier le code en utilisant un instrumentation fichier YAML personnalisée. L'agent Java lira le fichier YAML au démarrage et enregistrera les métriques spécifiques.

Exigences et accès

L'agent Java ne voit que les métriques des MBeans dans votre JVM actuelle. Si les MBeans sont accessibles à distance ou existent dans une JVM distincte, ils ne seront pas disponibles pour l'agent Java New Relic.

Les données JMX personnalisées ne seront pas affichées dans nos graphiques APM, mais vous pouvez interroger les données et créer des graphiques personnalisés avec elles.

Cette intégration ne rapporte que des valeurs numériques simples. Si vous souhaitez signaler d’autres types de valeurs, vous pouvez utiliser l’ intégration de l’infrastructure JMX.

Règles de structure de fichier

Le fichier instrumentation personnalisée doit être au format YAML. Utilisez un validateur YAML pour vous assurer que la syntaxe est exacte avant d'utiliser le fichier avec l'agent Java de New Relic et suivez ces règles :

• Les fichiers YAML sont sensibles à la casse.
• Toutes les indentations sont incrémentées de deux caractères. Les données dans les mêmes sections du fichier doivent utiliser le même niveau d'indentation. Mettez en retrait toutes les sous-sections avec deux espaces supplémentaires.
• Vous devez redémarrer votre processus hôte JVM pour que les modifications prennent effet.

Propriétés disponibles

Voici un résumé de chaque propriété du fichier JMX. Pour plus d'informations, consultez Exemples JMX YAML personnalisés.

Emplacement du fichier YAML

L'agent Java lit le fichier YAML au démarrage du processus. Il existe deux manières de spécifier l'emplacement du fichier YAML :

Vérifiez que le fichier a été lu

Pour vérifier que le fichier YAML a été lu par l'agent :

1. Ouvrez le fichier de configuration newrelic.yml .

2. Modifiez la propriété niveau de log sur log_level: finer.

3. Démarrez l'application.

4. Vérifiez que le fichier logs/newrelic_agent.log inclut une instruction indiquant que le fichier a été lu :

   Reading custom extension file /path/to/file/file.yml

   Copier

5. Si vous ne trouvez pas cette déclaration, vérifiez l’emplacement du fichier YAML. Assurez-vous également que le processus dispose d’un accès en lecture au fichier.

6. Vérifiez que le fichier inclut cette déclaration :

   Adding extension with name NAME_FROM_YAML and version VERSION_FROM_YAML

   Copier

7. Si vous ne trouvez pas cette déclaration, vérifiez que le document a été analysé correctement. Vérifiez également s'il existe un autre fichier d'extension portant le même nom et un numéro de version supérieur.

requête et graphique des données JMX

Vous pouvez exécuter une requête sur vos données JMX et les utiliser pour créer des graphiques personnalisés. Pour en savoir plus sur l'interrogation de ce type de données, consultez requête APM métriques.

Voici comment rechercher JMX ou le chemin direct vers le compteur tel que défini dans votre fichier YAML.

name: TomcatCustom
  version: 1.0
  enabled: true
  jmx:
    - object_name: java.nio:type=BufferPool,name=*
      metrics:
        - attributes: Count
          type: monotonically_increasing

JMX/java.nio/BufferPool/direct/Count
JMX/java.nio/BufferPool/mapped/Count

Pour plus d'informations sur la manière dont les métriques sont nommées et stockées, consultez Exemples JMX YAML personnalisés.