Javaエージェント：YAMLによるカスタムJMXインストゥルメンテーション

Java SE Platformには、Java Management Extensions (JMX)が含まれます。JMXはアプリケーション、デバイス、サービスをモニターし、管理する1つの方法です。通常の場合、アプリケーションサーバーには監視できるJMXメトリックスが組み込まれています。

New RelicのJavaエージェントには、カスタムインストゥルメンテーションYAMLファイルを使用して、コードを変更せずにMBeansおよびアプリケーションの属性から特定のメトリクスを監視する機能があります。Javaエージェントは、起動時にYAMLファイルを読み込み、特定のメトリックスを記録します。

要件およびアクセス

Javaエージェントは、現在のJVMのMBeansからのみメトリクスを表示します。リモートからMBeansにアクセスしている場合、またはMBeansが個別のJVMに存在している場合、New RelicのJavaエージェントはそれらを使用できません。

カスタム JMX データはAPMチャートには表示されませんが、データをクエリしてカスタム チャートを作成することができます。

このインテグレーションでは、単純な数値のみが報告されます。他のタイプの値をレポートする場合は、Infrastructure JMX インテグレーションを使用することをお勧めします。

ファイル構造の規則

カスタムインストゥルメンテーションファイルは、YAML形式にする必要があります。New RelicのJavaエージェントで使用する前に、YAMLバリデータを使用して構文が正しいことを確認し、以下の規則に従ってください。

• YAMLファイルには、大文字と小文字の区別があります。
• すべてのインデントは、2文字の空白にします。ファイルの同じセクションのデータは、同じレベルのインデントを使用する必要があります。サブセクションを、2つの余分なスペースでインデントします
• 変更を有効にするには、JVMホストプロセスを再起動する必要があります。

使用可能なプロパティ

以下に、JMXファイルの各プロパティをまとめます。詳細については、カスタムJMX YAMLの例をご覧ください。

YAMLファイルの場所

Javaエージェントは、プロセスの開始時にYAMLファイルを読み込みます。YAMLファイルの場所を指定するには、以下の2つの方法があります。

ファイルの読み込みを確認する

エージェントがYAMLファイルを読み込んでいることを確認するには：

1. newrelic.yml設定ファイル内で指定します。

2. ログレベルのプロパティをlog_level: finerに変更します。

3. アプリケーションを起動します。

4. logs/newrelic_agent.logファイルに、ファイルが読み込まれたことを示す以下のステートメントが含まれていることを確認します。

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

   コピー

5. このステートメントが見つからない場合は、YAMLファイルの場所を確認します。プロセスにファイルに対する読み取りアクセス権があることも確認します。

6. ファイルに以下のステートメントが含まれることを確認します。

   Adding extension with name NAME_FROM_YAML and version VERSION_FROM_YAML

   コピー

7. このステートメントが見つからない場合は、ドキュメントが正しく解析されていることを確認します。より高いバージョン番号で、同じ名前の別の拡張ファイルがあるかどうかも確認します。

JMX データのクエリとチャート作成

JMX データのクエリを実行し、結果を使用してカスタムチャートを作成できます。この種のデータのクエリの詳細については、クエリAPMメトリックを参照してください。

JMXを検索する方法、または 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

メトリックスに名前を付けて保存する方法の詳細については、カスタムJMX YAMLファイルの例をご覧ください。