ARMS SDK for Java - Application Real-Time Monitoring Service - Alibaba Cloud ドキュメントセンター

ARMS SDK を使用すると、コードからトレース ID と関連するトレースプロパティを取得できます。

注意事項

v4.x 以降のエージェントでは、OpenTelemetry Java SDK を使用して、カスタムイベントトラッキングを行い、トレースコンテキストを取得します。

4.x エージェントにアップグレードできない場合にのみ ARMS SDK を使用してください。その他のすべてのシナリオでは、OpenTelemetry Java SDK を使用して、カスタムイベントトラッキングを行い、トレースコンテキストを取得します。

前提条件

ARMS コンソールで、ご利用のアプリケーションに対して Application Monitoring を有効にし、Java アプリケーションにエージェントをインストールして起動します。詳細については、「エージェントの手動インストール」をご参照ください。
アプリケーションに arms-sdk-1.7.3.jar の依存関係を追加します。
```
<dependency>
    <groupId>com.alibaba.arms.apm</groupId>
    <artifactId>arms-sdk</artifactId>
    <version>1.7.3</version>
</dependency>
```
説明
pom.xml から依存関係を取得できない場合は、arms-sdk-1.7.3.jar をダウンロードしてください。

トレース ID と RPC ID の取得

次のコードを使用して、トレース ID と RPC ID を取得します。

Span span = Tracer.builder().getSpan();   // これは新しい Span を作成しません。
String traceId = span.getTraceId();
String rpcId = span.getRpcId();

カスタム baggage の伝播

説明

Spring Cloud Gateway のシナリオでは、v4.2.x 以降のエージェントを使用し、かつカスタム構成で spring-bean プラグインを有効化している場合、バゲージの伝播に失敗します。この問題を解決するには、プラグインを無効にするか、エージェントを v4.1.x 以前のバージョンにダウングレードしてください。

カスタムバゲージを伝播するには、次の手順に示すように、バゲージを設定および取得するコードを追加します。

カスタム baggage を設定します。

Map<String, String> baggage = new HashMap<String, String>();
baggage.put("key-01", "value-01");
baggage.put("key-02", "value-02");
baggage.put("key-03", "value-03");
Span span = Tracer.builder().getSpan();
span.withBaggage(baggage);

カスタム baggage を取得します。

Span span = Tracer.builder().getSpan();
Map<String, String> baggage = span.baggageItems();

バージョン 4.x 以降のエージェントでは、バゲージは伝播にのみ使用されます。その内容は各 Span のタグに自動的に追加されません。必要な場合は、手動でSpan のカスタムタグを設定する必要があります。

カスタムスパン tags の設定

カスタムタグは、設定された Span 内でのみ有効であり、伝播されません。次のようにカスタムタグを追加および取得します。

アプリケーションコードで、1 つ以上のカスタム tags を Span に追加します。

Span span = Tracer.builder().getSpan();
// Span にタグを追加します。
span.setTag("tag-key1", "tag-value1");
span.setTag("tag-key2", "tag-value2");

アプリケーションコードで、Span のカスタム tags を取得します。

Span span = Tracer.builder().getSpan();
// Span のタグを検査します。
Map<String, String> tags = span.tags();

カスタム baggage と tags によるクエリ

Span に設定されたカスタム baggage と tags を使用してトレースをクエリできます。

Baggage はダウンストリームサービスに伝播され、通常はビジネスコンテキストの伝播に使用されます。バゲージ項目を過度に追加することは避けてください。
tag は現在の Span 内でのみ有効です。ビジネス関連の複数の項目をタグとして追加できます。

ARMS コンソールにログインします。ARMS コンソール。左側のナビゲーションウィンドウで、[アプリケーションモニタリング] > [トレースクエリ] を選択します。
[トレースクエリ] ページで、ページ上部でリージョンを選択します。次に、 [パラメータータイプ] を選択し、 [パラメーター値] フィールドにカスタムタグを入力して、 [クエリ条件に追加] をクリックします。
トレースのリストで、目的のトレースの [トレース ID] をクリックします。
[トレース] 詳細ページで、 [サービス名] にカーソルを合わせると、その Span のタグが表示されます。
v4.x 以降のエージェントで、バゲージを Span に含めるには、バゲージを取得してからカスタムタグとして設定します。詳細については、「カスタム baggage の伝播」および「Span のカスタムタグの設定」をご参照ください。