Application Real-Time Monitoring Service:Java アプリケーションのカスタム設定

前提条件

アプリケーションに ARMS エージェントがインストールされていること。

手順

1. ARMS コンソールにログインします。左側のナビゲーションウィンドウで、アプリケーション監視 > アプリケーションリスト を選択します。

2. [アプリケーション] ページで、上部のナビゲーションバーでリージョンを選択し、アプリケーションの名前をクリックします。

説明

[言語] 列に表示されるアイコンは、アプリケーションが記述されている言語を示します。

: Java アプリケーション

: Go アプリケーション

: Python アプリケーション

ハイフン (-): Managed Service for OpenTelemetry で監視されるアプリケーション。

3. 上部のナビゲーションバーで、設定 > カスタム設定 を選択します。

4. パラメーターを設定し、 [保存] をクリックします。

サンプリング設定

[サンプリング設定] セクションでは、サンプリングポリシーと 1 つ以上のインターフェイス名を設定できます。詳細については、「ARMS エージェント V3.2.8 以降のトレースサンプリングモードを選択する」をご参照ください。

エージェントスイッチ設定

[プローブスイッチ設定] セクションでは、アプリケーション監視を有効または無効にし、使用するプラグインを選択できます。

スレッドプロファイリング設定

[スレッド分析設定] セクションでは、スレッド分析マスターコントロールスイッチをオンまたはオフにすることができます。

アプリケーションログの関連付け設定

[アプリケーションログ関連付け構成] セクションでは、アプリケーションに関連付けるログソースを構成し、ログに TraceId と SpanId を自動的に入力するかどうかを指定できます。詳細については、「ログ分析」をご参照ください。

• TraceID の自動入力およびSpanId の自動入力: ログ設定ファイルを変更することなく、TraceId と SpanId をログに自動的に挿入します。

  設定の効果:

  次の図に示すように、log4j、log4j2、および logback は、ログ設定ファイルを変更することなく、ログに TraceId と SpanId を自動的に出力します。

  

• ログ MDC に traceId を追加：org.slf4j.MDC.get(“EagleEye-TraceID”) を介して TraceId を取得するかどうかを指定します。この機能は、デフォルトでは ARMS エージェント V4.x でサポートされていません。

URL 収束設定

[URL 収束設定] セクションでは、収束を有効または無効にし、収束しきい値と収束ルールを指定できます。URL 収束は、類似の URL を単一のオブジェクトとして表示します。たとえば、/service/demo/ で始まる URL はオブジェクトとして表示されます。収束しきい値は、URL 収束をトリガーできる URL の最小数です。たとえば、しきい値が 100 に設定されている場合、URL は 100 個の URL がルールの正規表現に一致する場合にのみ収束されます。詳細については、「ARMS 収束ポリシー」をご参照ください。

Arthas 監視

[Arthas 監視] セクションでは、Arthas 診断機能を有効または無効にできます。また、Arthas 診断を実行する IP アドレスを指定することもできます。詳細については、「Arthas 診断」をご参照ください。

継続的プロファイリング設定

[継続的なプロファイリング設定] セクションでは、[メインスイッチ]、[CPU ホットスポット]、[メモリホットスポット]、および [コードホットスポット] スイッチをオンまたはオフに切り替え、有効な IP アドレスまたは有効な CIDR ブロックを指定できます。詳細については、「Java アプリケーションの継続的なプロファイリング」をご参照ください。

情報非識別化設定

[情報非識別化] セクションでは、非識別化ルールを設定して、データ収集中に JVM システムパラメーター、Kubernetes YAML 設定、メソッド入力パラメーター、Arthas 環境変数、およびシステム変数を非識別化できます。ルール内の各要素は、大文字と小文字を区別しない正規表現を表します。たとえば、password は正規表現 .*password.* を示します。複数の要素はカンマ (,) で区切ります。

ARMS エージェントがデータを収集すると、エージェントはキーに基づいてデータを非識別化します。キーが正規表現に一致する場合、対応する値は非識別化されます。次の図に示すように、ルールで licenseKey を指定すると、-Darms.licenseKey キーの値が非識別化されます。

インターフェイス呼び出し設定

[インターフェイス呼び出し構成] セクションでは、低速な呼び出しのしきい値を指定し、例外ホワイトリスト、HTTP ステータスコードホワイトリスト、および無効なインターフェイスフィルタリングポリシーを調整できます。

• 低速コールのしきい値: 単位: ms。デフォルト値: 500。リクエストの応答時間がしきい値を超えると、そのリクエストは低速としてマークされます。

• HTTP ステータスコードホワイトリスト:

  デフォルトでは、400 以上の HTTP ステータスコードはエラー呼び出しとして分類されます。特定のステータスコードをエラーとして分類したくない場合は、ホワイトリストを設定してこれらのエラーを無視できます。

  これは、現在アプリケーション監視でサポートされている HTTP フレームワークにのみ影響します。

  影響を受けるデータ: HTTP サーバー/クライアントのエラー数メトリック (arms_http_requests_error_count、arms_http_client_requests_error_count、arms_app_requests_error_count) およびスパンステータス。

  影響を受ける機能: [概要]、[提供されるサービス]、および [依存関係] タブのエラー数、ならびに [トレースエクスプローラー] タブのスパンステータス、エラー数、およびアラート。

  内容のフォーマット: 単一のステータスコードを入力し、複数のステータスコードはカンマ (,) で区切ります。あいまい一致はサポートされていません。

  例: 403,502

  デフォルト値: なし

• 無効なインターフェイス呼び出しフィルタリング：

  [提供されるサービス] タブで一部の呼び出しを表示したくない場合は、呼び出しの詳細を表示する必要のないインターフェイスの名前を入力して、それらを非表示にすることができます。ARMS エージェントは、それらの可観測性データを報告しません。

  説明

  • v4.2.0 より前の Java 用 ARMS エージェントの場合、この機能は [提供されるサービス] タブに表示されるインターフェイスにのみ適用されます。

  • Java 用 ARMS エージェント v4.2.0 以降の場合、この機能は任意の LocalRootSpan に適用されます。

  影響を受けるデータ: インターフェイスに対応するすべてのメトリックとスパンは無視されます。

  影響を受ける機能: [概要]、[提供サービス]、および [依存関係] の各タブにおけるインターフェイス関連のすべてのメトリック、ならびに [Trace Explorer] タブにおけるスパン数、インターフェイス呼び出し数、エラー数、およびアラート。

  内容のフォーマット: 文字列または AntPath 式を使用して、無効なインターフェイスの完全な名前を照合します。複数のルールはカンマ (,) で区切ります。(デフォルトの AntPath 式は既存のデータとの互換性のために提供されており、削除することは推奨されません。新しい設定は既存のルールに追加する必要があります。)

  例: /api/test/*,/api/playground/create

  デフォルト値: //*.jpg,//.png,/**/.js,//*.jpeg,//.pdf,/**/.xlsx,//*.txt,//.docs,/**/.gif,/**/*.csv

• インターフェイス呼び出しインジケーターに上流インターフェイス名を記録するかどうか、およびインターフェイス呼び出しインジケーターに上流アプリケーション名を記録するかどうか:

  設定の目的: このインターフェイスを呼び出すアップストリームアプリケーションとアップストリームインターフェイスをインターフェイスメトリックに記録するかどうかを制御します。これは主に、提供されるサービス内のアップストリームおよびダウンストリームトレースにデータが存在するかどうかに影響します。アプリケーションに多くのアップストリームアプリケーションがある場合、この情報を記録するとメトリックレポートの量が大幅に増加し、コストが増加する可能性があります。

  設定の効果: 図に示すように、インターフェイスメトリックでのアップストリームアプリケーションとインターフェイスの記録を無効にすると、対応するデータは 0 になります。

  

• インターフェイス呼び出し指標が元の状態コードを記録するかどうか：

  設定の目的: HTTP インターフェイス関連のメトリックに元の応答コードを記録します。

  設定の効果:

  

• インターフェイスの HTTP メソッド名を記録: このスイッチを有効にすると、インターフェイス呼び出しページの API 操作名に HTTP メソッドが含まれます。たとえば、名前が /api/v1/use/{userId} から GET /api/v1/use/{userId} に変更されます。

データベース呼び出し設定

[データベース呼び出し設定] セクションでは、低速 SQL クエリのしきい値と収集された SQL 文の最大保持期間を指定できます。また、SQL 文の変数と定数の値を表示するかどうか、および MySQL クエリの戻り値を記録するかどうかを設定できます。

• SQL の変数バインディング値を表示: PrepareStatement パラメーターにバインドされた変数の値を取得します。この構成は、アプリケーションを再起動することなく有効になります。

  PreparedStatement パラメーターにバインドされた変数値は、対応するデータベースアクセススパンに属性として記録および保存されます。これらの属性では、キーは db.bindvalue で、値はカンマ区切りの変数値のリストです。

  • この設定は、現在 ARMS でサポートされているすべての JDBC ベースのフレームワークに適用されます。

  • 次のデータベース変数タイプがサポートされています: Boolean、Byte、Short、Int、Long、Float、Double、BigDecimal、Date。

  • この設定を有効にすると、SQL 文の変数数に正比例する追加のオーバーヘッドが発生します。公式のストレステストシナリオ (変数が 1 つの場合) では、この機能を有効にすると、追加の CPU オーバーヘッドは 0.5% 未満で、メモリオーバーヘッドはごくわずかです。

  有効にした場合の実際の効果:

  

• SQL の定数値を表示: SQL 文は追加の処理なしで切り捨てられます。この構成は、アプリケーションを再起動しなくても有効になります。異なる SQL 文にさまざまな定数値が含まれている場合、SQL 文がより多様になり、最終的に {ARMS_OTHERS} に集約される可能性があります。このオプションを有効にすることはお勧めしません。

トレースコンテキスト伝播プロトコル設定

[トレースコンテキスト伝播設定] セクションでは、ビジネス要件に基づいてトレースコンテキスト伝播プロトコルを選択できます。

デフォルトでは、ARMS エージェントは、リクエストヘッダーに指定されたプロトコルヘッダーが含まれているかどうかに基づいてトレースコンテキスト伝播プロトコルを選択します。

このセクションでは、任意のプロトコルを優先プロトコルとして選択できます。プリファレンスを選択して保存すると、ARMS は選択したプロトコルで指定されたリクエストヘッダーの存在を優先的にチェックします。たとえば、次の設定では、ARMS エージェントは Jaeger、EagleEye、W3C、SkyWalking、Zipkin の順にプロトコルヘッダーをチェックします。

特定のプロトコルの使用を強制することもできます。たとえば、次の設定では、呼び出しが到着すると、ARMS エージェントは Jaeger プロトコルで定義されたリクエストヘッダーの存在のみをチェックします。これらのヘッダーが検出されない場合、他のプロトコルのチェックには進まず、代わりに新しいトレースコンテキストを生成します。

設定の目的:

次のシナリオでは、優先または強制のトレースコンテキスト伝播プロトコルを選択できます。

• リクエストが複数の形式のトレースコンテキストを伝送し、デフォルトの解析順序が要件を満たさない場合。解析のために優先プロトコルを指定したい場合。たとえば、リクエストが W3C と Zipkin の両方のトレースコンテキストを伝送する場合、デフォルトではシステムは W3C トレースコンテキストの解析を優先します。この動作は、伝播プロトコルを Zipkin に設定することで変更でき、代わりに Zipkin プロトコルを優先させることができます。

• リクエストが特定のプロトコルのトレースヘッダーを伝送するが、それらのヘッダーを再利用したくなく、別のプロトコルを使用して新しいトレースコンテキストを生成したい場合。たとえば、リクエストが Zipkin トレースコンテキストを伝送する場合、デフォルトではシステムは Zipkin トレースコンテキストを解析します。伝播プロトコルを W3C に設定し、伝播モードを強制に変更すると、システムは Zipkin トレースコンテキストを無視し、W3C プロトコル仕様に従って新しいコンテキストを生成します。伝播モードを強制に変更しない場合、システムは W3C コンテキストの解析に失敗した後でも Zipkin トレースコンテキストの解析を試みることに注意してください。

設定の効果:

設定後、トレース内の各 LocalRootSpan には、キーが trace.protocol.type で、値がトレースで使用されている現在のトレースプロトコルである属性が含まれます。

メッセージキュー設定

[メッセージキューイング設定] セクションでは、コンシューマー情報をカスタマイズできます。

• カスタム RabbitMQ コンシューマー: コンシューマーのトレースを表示するには、カスタムコンシューマーのクラス名または匿名内部コンシューマーのクラス名を指定できます。 複数のコンシューマーはコンマ (,) で区切ります。

• カスタム Kafka 消費メソッド：カスタム消費メソッドを指定すると、ネイティブ Kafka SDK を使用してメッセージを消費する際のトレースとメトリックを表示できます。

• Kafka によるメッセージコンテキストの自動パススルー: 配信トレースと消費トレースを関連付けるために、複数のヘッダーが Kafka メッセージに自動的に追加されます。

エージェント収集設定

[プローブ取得設定] セクションでは、エージェントが毎秒収集するトレースの最大数、エージェントが処理できる最大 QPS しきい値、およびエージェントのログレベルを設定できます。

• 呼び出しチェーンの収集: トレースデータを報告するかどうかを制御します。デフォルトで有効になっています。無効にした場合、トレースデータは報告されなくなります。

• 1 秒あたりの最大プローブリンク取得数: エージェントが 1 秒あたりにレポートできるスパンの数を指定します (パフォーマンス上の理由から、実際の実効しきい値は、ユーザーが設定したしきい値から最大 5% の乖離が生じる場合があります)。この上限を超えるスパンはレポートされません。

• プローブが処理可能な最大 QPS しきい値: エージェントが 1 秒あたりに処理できるリクエスト数を指定します (パフォーマンス上の理由から、実際に有効なしきい値は、ユーザーが設定したしきい値と最大 5% の誤差が生じる場合があります)。このしきい値を超えるリクエストはモニターされません。これにより、これらのリクエストに対してスパンやメトリックは生成されず、TraceId とのログの関連付けも機能しなくなります。

• エントリのない内部呼び出しデータの収集: ARMS では、アプリケーションが提供する HTTP サービス、RPC サービス、アプリケーションによってトリガーされるスケジュールされたタスク、およびメッセージ消費がエントリポイントと見なされます。これらのエントリポイントのビジネスロジック内で送信されるデータベース呼び出し、HTTP リクエストは、エントリポイントを持つ内部呼び出しと見なされます。これに対し、JDK スレッドプール経由で開始される HTTP 呼び出し、データベース呼び出し、NoSQL 呼び出し、メッセージ送信、および RPC 呼び出しは、エントリポイントのない内部呼び出しと見なされます。ARMS エージェント V4.2.2 以降では、1 回のクリックでこのようなデータをフィルタリングできます。下図に示すように、Lettuce フレームワークでは、Redis サーバーとの正常な接続を確保するために、コマンドが定期的に自動実行されます。このような呼び出しは、エントリポイントのない内部呼び出しに分類されます。図に示されている時点でこのようなデータの収集を無効にすると、関連データは表示されなくなります。

  

• プローブのログレベル: エージェントのログレベルを調整します。問題のトラブルシューティングに役立ちます。

• カスタムメトリック収集設定： OpenTelemetry SDK によって収集および定義されるメトリックを構成します。

例外の詳細フィルタリング設定

[例外の高度なフィルタリング設定] セクションでは、例外収集ルールを設定できます。

• プラグイン例外の収集: プラグインの例外を収集するかどうかを指定します。

• 類似例外スタックの識別深度: このスタック深度は、類似した種類の例外を識別するために使用されます。デフォルト値: 2。この構成を変更すると、予期しない統計的動作が発生する可能性があるため、注意してください。

• 例外フィルタリングホワイトリスト: [シナリオベースの分析 > 例外] タブで特定の例外を表示したくない場合は、例外としてカウントすべきではない例外の完全修飾クラス名を入力して非表示にすることができます。

  影響を受けるデータ: 例外数メトリック (arms_exception_requests_count_raw、arms_exception_requests_seconds_raw)

  およびスパン内の例外情報。

  影響を受ける機能: [シナリオベースの分析] > [例外] タブの対応する例外のメトリック、ならびに [トレースエクスプローラー] タブの対応する例外のスパン内の例外情報および例外数アラート。

  内容のフォーマット: 完全修飾クラス名を使用して、フィルタリングする必要がある例外を識別します。複数の例外はカンマ (,) で区切ります。

  例: java.lang.InterruptedException,java.lang.IndexOutOfBoundsException

  デフォルト値: なし

• 例外フィルタリングの親クラス継承: 有効にすると、現在収集された例外が、例外フィルタリングのホワイトリストに設定されている例外クラスのサブクラスである場合、その例外もフィルタリングされます。

  設定効果: フィルタリング基準を満たす例外は ARMS コンソールに表示されません。

• 例外メッセージのフィルタリング: 構成後、メッセージフィールドが構成された条件を満たす、指定されたタイプの例外もフィルタリングされます。

  • 例外名: フィルターが適用される例外を指定します。

  • メッセージ条件: 例外メッセージの条件。startsWith、endsWith、または contains を指定できます。

  • メッセージキーワード: キーワード文字列。

  設定の効果: フィルタリング基準を満たす例外は ARMS コンソールに表示されません。

プール監視設定

[プールされたモニタリング設定] セクションでは、スレッドプールと接続プールの収集ルールを設定できます。

• スレッドプールと接続プールのモニタリング: Apache Tomcat、Apache Dubbo、High-speed Service Framework (HSF) などのフレームワークでスレッドプールのメトリックをモニターするかどうかを指定します。この機能を有効にするには、ARMS エージェントを最新バージョンに更新する必要があります。

• スレッドプールのスレッド名パターン抽出ポリシー: この機能は、デフォルトで、スレッドプール内で実行中のスレッドのスレッド名に含まれるすべての数字を * に置き換えます。また、スレッド名の末尾の文字のみを * に置き換えるように調整することもできます。複数の Dubbo プロバイダーが開始され、それぞれが異なるリッスンポートを持つアプリケーションでデフォルトの戦略を適用した場合、抽出されたスレッド名のテンプレートが同一になるため、2 つの Dubbo プロバイダーのスレッドプールが 1 つに集約されてしまう可能性があります。この場合、この戦略を調整することで、2 つのスレッドプールを区別できるようになります。

  設定の効果: 一般的な Tomcat スレッドプールを例にとると、表示されるスレッドプールのスレッド名はデフォルトで http-nio-*-exec-* になります。調整後、スレッド名は http-nio-9099-exec-* になります。

  

• スレッドプールのシナリオフィルタリングおよびスレッドプールのスレッド名パターンフィルタリング: 使用シナリオとスレッド名のパターンに基づいて、特定のスレッドプールのメトリクスを除外できます。

  説明

  この設定は、Java 用 ARMS エージェント v4.2.0 以降でのみ有効です。

  • スレッドプールの使用シナリオとは、スレッドが使用されるコンテキストを指し、現在、Tomcat、Vert.x、Undertow、Dubbo、Jetty、AliyunJavaAgent、default などのいくつかのタイプをサポートしています。これらのうち、AliyunJavaAgent はエージェントが使用するスレッドプールを表し、「default」は他の未分類のスレッドプールを表します。

  • スレッドプールのスレッド名パターンは、スレッドプール内のスレッド名を処理した後に得られるパターンを示します。たとえば、数字を含むスレッド名の一部を * に変換して http-nio-*-exec-* のようなパターンを取得します。

  影響を受けるデータ: スレッドプールメトリック

  影響を受ける機能: [インスタンス監視] > [スレッドプール監視] タブおよびスレッドプール関連のメトリックに基づいてトリガーされるアラート。

  内容のフォーマット:

  • スレッドプールの使用シナリオフィルタリング: [インスタンス監視] > [スレッドプール監視] タブに表示される使用シナリオ。複数の使用シナリオはカンマ (,) で区切ります。

  • スレッドプールのスレッド名パターンフィルタリング: スレッドプール監視タブに表示されるスレッド名パターン。複数の使用シナリオはカンマ (,) で区切ります。照合方法は完全に一致であり、ルールベースの照合はサポートされていません。

  例:

  スレッドプールの使用シナリオフィルタリング: AliyunJavaAgent,Jetty

  スレッドプールのスレッド名パターンフィルタリング: Catalina-utility-*,DubboServerHandler-*-thread-*

  これは、「AliyunJavaAgent」シナリオのすべてのスレッドプールデータが報告されないことを意味します。他のシナリオでは、スレッドプールパターンが Catalina-utility-* のような名前に一致する場合、それらも報告されません。

  デフォルト値: なし

スパン属性

• OTel Spec 規約属性の記録: OpenTelemetry 仕様では、各プラグインタイプによって生成されるスパンに含めるべき属性が規定されています。ただし、報告されるデータ量を考慮し、ARMS エージェントはデフォルトではこれらの属性をスパンに記録しません。必要に応じてこれを有効にできます。有効化後にさまざまなフレームワークによって追加される属性の詳細については、OpenTelemetry 仕様ドキュメントをご参照ください。

  次の例は、HTTP サーバーのスパンを示しています。赤いボックス内の属性は、スイッチを有効にした後に追加された新しい属性です。

  

• スパンとアプリケーションラベルの関連付け構成: [アプリケーション] ページで、どのスパンにアプリケーションのタグを関連付けるかを制御するための設定です。デフォルトでは、すべてのスパンにアプリケーションタグが含まれます。使用量を考慮して、HTTP サーバー、RPC サーバー、メッセージキュー、またはスケジュールされたタスクなどのエントリースパンにのみ、アプリケーションタグをアタッチできます。

  エントリスパンにアタッチするように設定した後の効果は、下の図に示されています。たとえば、アプリケーションには test1:value1 のようなタグのペアが含まれています。

  

  エントリスパンの場合、対応するタグ属性が表示されます。

  

  エントリ以外のスパンには、test1:value は含まれません。

  

詳細設定

［詳細設定］セクションでは、除外するインターフェイスやメソッドスタックの最大長などの詳細設定を構成できます。

• 分位数統計: 有効または無効にできます。

• メソッドスタックの最大長: デフォルト値は 128、最大値は 400 です。

• 呼び出しチェーンの圧縮: for ループなどの重複した呼び出しを簡略化するかどうかを指定します。

• リクエスト入力パラメーターの最大表示文字数: デフォルトは 512 文字、最大は 2,048 文字です。

• 非同期パススルースキャンパッケージ名: アプリケーションの構成に非同期伝播用のスキャンパッケージを追加することで、非同期タスクをモニターできます。Runnable オブジェクト、Callable オブジェクト、または Supplier オブジェクトが作成されると、非同期伝播用のスキャンパッケージ内の対応するメソッドが、現在のスレッドのトレースコンテキストを自動的にキャプチャします。その後、スレッドが非同期モードで使用されると、メソッドはキャプチャされたトレースコンテキストをスレッドに伝播します。

• HTTP 応答に TraceId を含める: HTTP リクエストの応答ヘッダーに eagleeye-traceid フィールドを返すかどうかを指定します。

• [JVM GC トリガーの根本原因]: JVM ガベージコレクション (GC) トリガーの根本原因を表示するかどうかを指定します。監視の詳細は [JVM 監視] ページで確認できます。GC トリガーの根本原因の詳細については、「GC メトリック」をご参照ください。

アプリケーション設定を他のアプリケーションにコピーする

アプリケーションの設定を他のアプリケーションにコピーできます。

アプリケーション設定をグローバルに適用する

現在のアプリケーション設定をグローバルに適用できます。新しいアプリケーションを作成すると、デフォルトでこの設定が使用されます。

1. ページの下部で、[現在のアプリケーション設定をグローバルデフォルト構成として保存] をクリックします。

2. [現在の設定が保存されていません] メッセージが表示された場合、[保存] をクリックして構成を保存し、次に [現在のアプリ設定をグローバルデフォルト構成として保存] をクリックします。

3. 表示されるメッセージで、[OK] をクリックします。

よくある質問