JMX インテグレーションのトラブルシューティング

JMX にアクセスできることを確認するために、可能であれば JConsole または同等のものを使用してテストしてください。JConsole を使って接続できない場合、この記事が解決するのに役立つかもしれません。また、YAML に記載されているメトリクスと JConsole に記載されているメトリクスが 1:1 でない場合、これを修正する必要があります。

JConsole で接続できた場合は、以下を実行します。

java -jar /opt/datadog-agent/agent/checks/libs/jmxterm-1.0-DATADOG-uber.jar -l localhost:<PORT> -u <USER> -p <PASSWORD>

上記のコマンドで接続できた場合は、beans を実行し、上記の結果のコピーと以下の情報を Datadog サポートチームに送信してください。

注: いくつかのメトリクス (jvm.heap_memory、jvm.non_heap_memory など) を見ることができれば、それは JMXFetch が適切に動作している証拠です。他のアプリケーションをターゲットにしていて、関連するメトリクスが表示されない場合は、YAML の構成に誤りがある可能性があります。

Agent のトラブルシューティング

/usr/bin/java -Xmx200m -Xms50m -classpath /usr/lib/jvm/java-8-oracle/lib/tools.jar:/opt/datadog-agent/bin/agent/dist/jmx/jmxfetch-0.18.2-jar-with-dependencies.jar org.datadog.jmxfetch.App --check <CHECK_LIST> --conf_directory /etc/datadog-agent/conf.d --log_level INFO --log_location /var/log/datadog/jmxfetch.log --reporter console <COMMAND>

/usr/bin/java -Xmx200m -Xms50m -classpath /usr/lib/jvm/java-8-oracle/lib/tools.jar:/opt/datadog-agent/bin/agent/dist/jmx/jmxfetch-0.18.2-jar-with-dependencies.jar org.datadog.jmxfetch.App --check cassandra.d/conf.yaml jmx.d/conf.yaml --conf_directory /etc/datadog-agent/conf.d --log_level INFO --log_location /var/log/datadog/jmxfetch.log --reporter console list_everything

$ docker exec -it <AGENT_CONTAINER_NAME> agent configcheck

$ docker exec -it <AGENT_CONTAINER_NAME> agent status

よくあるご質問

350 のメトリクス上限

Datadog は最大 350 のメトリクスを受け取ることができます。 ベストプラクティスは、収集したメトリクスを絞り込むフィルターを作成することによって、メトリクスを 350 未満に制限することです。

この上限を増やしたい場合は、Datadog サポートにご連絡ください。

Java パス

デフォルトの Agent インストールには、バンドルされている JVM はなく、システムにインストールされているものを使用します。したがって、Agent を実行しているユーザーのパスに Java ホームディレクトリが存在することを確認する必要があります。

注:

• gcr.io/datadoghq/agent:latest-jmx Docker イメージは、Agent が jmxfetch を実行するために必要とする JVM を含んでいます。あるいは、インテグレーションの構成ファイルで、java_bin_path パラメーターを使って、JVM のパスを指定することもできます。
• JMXFetch には、有効な Java パスを 1 つだけ指定する必要があります。

JVM メトリクス

Datadog の Java APM ライブラリは、JMX インテグレーションなしで JVM メトリクスを収集することが可能です。詳細については、ランタイムメトリクスを参照してください。

JBoss または WildFly アプリケーションの監視

Agent v5.6.0 以上では、次の手順を使用します。

JBoss/WildFly アプリケーションは、JMXFetch にデフォルトでバンドルされていない特定のプロトコル (Remoting JMX) を介して JMX を公開します。JMXFetch がこれらのアプリケーションに接続できるようにするには、以下のように構成します。

• JBoss/WildFly サーバー上の jboss-cli-client.jar ファイルを探します (デフォルトでは、そのパスは $JBOSS_HOME/bin/client/jboss-cli-client.jar になっています)。
• JMXFetch が JBoss/WildFly アプリケーション以外のホストで実行されている場合は、jboss-cli-client.jar をホスト JMXFetch が実行されている場所にコピーします。
• jar のパスを構成の init_config セクションに追加します。

  # Datadog Agent >= 5.6.0

  init_config:
    custom_jar_paths:
      - /path/to/jboss-cli-client.jar

• 構成の instances セクションで、JMXFetch が接続するカスタム URL を指定します。

  # Datadog Agent >= 5.6.0

  # jmx_url は、使用している JBoss/WildFly のバージョンと、
  # サーバーでの JMX の設定方法によって異なる場合があります
  # 詳細は、JBoss/WildFly の関連ドキュメントを参照してください
  instances:
    - jmx_url: "service:jmx:remote://localhost:4447"
      name: jboss-application  # 必須ですが、任意の値を設定できます
                               # そのインスタンスから取得したメトリクスにタグ付けするために使用されます

• Agent を再起動します。

注: Unable to instantiate or initialize instance <instance_name> for an unknown reason.Parameter 'name' may not be null のような警告メッセージが表示された場合、$WILDFLY_HOME/bin/add-user.sh -a -u <user> -p <password> で wildfly ユーザーを設定し、構成の instances セクションで user と password を指定する必要があるかもしれません。

instances:
  - jmx_url: <jmx_url>
    name: <instance_name>
    user: <username>
    password: <password>

JMX リモートライフサイクルリスナーを有効にした Tomcat の監視

Agent v5.6.0 以上では、次の手順を使用します。

JMX リモートライフサイクルリスナーを有効にして Tomcat を使用している場合は (詳細については Tomcat マニュアルを参照)、JMXFetch が Tomcat アプリケーションに接続するために追加のセットアップが必要です。

• Tomcat サーバーで catalina-jmx-remote.jar ファイルを探します (デフォルトでは、パスは $CATALINA_HOME/lib です)。
• JMXFetch が Tomcat アプリケーション以外のホストで実行されている場合は、catalina-jmx-remote.jar をホスト JMXFetch が実行されている場所にコピーします。
• jar のパスを構成の init_config セクションに追加します。

# Datadog Agent >= 5.6.0

init_config:
  custom_jar_paths:
    - /path/to/catalina-jmx-remote.jar

• 構成の instances セクションで、JMXFetch が接続するカスタム URL を指定します。

# Datadog Agent >= 5.6.0

# jmx_url は、Tomcat サーバーの JMX のセットアップ方法によって異なります
instances:
  - jmx_url: "service:jmx:rmi://:10002/jndi/rmi://:10001/jmxrmi"
    name: tomcat-application  # 必須ですが任意の値に設定できます。
                              # これは、インスタンスから取得されたメトリクスのタグ付けに使用されます

• Agent を再起動します。

SSL のトラブルシューティング

JMX が有効化され、Agent チェックが Datadog にメトリクスを正常に送信できるようになると、SSL ソケットを介したリモート接続を保護することができます。

注: JMX リモートユーザー/パスワード認証ファイルを使用せずに、JMX over SSL を保護することはできません。アプリケーションの実行にシステムレベルの権限を使用している場合、これらのファイルを追加し、起動時に実行してください。

この例では、Tomcat インテグレーションの Datadog の構成を示します。

• Java アプリのキーストアに適用する証明書とキーを設定します。
• conf.d/tomcat.d にある Datadog Tomcat の conf.yaml ファイルを更新します。

instances:
  - host: localhost
    port: 9000
    user: tomcat
    password: tomcat
    name: tomcat_webapp
    trust_store_path: <KEYSTORE_PATH>
    trust_store_password: <KEY_PASSWORD>

• Agent を再起動します。

その他の参考資料

お役に立つドキュメント、リンクや記事:

Java インテグレーションドキュメント