:Web アプリケーションまたはミニプログラムのエンドツーエンドトレースを有効にする

ARMS エージェントを使用する

デフォルトでは、ARMS エージェントは OpenTelemetry プロトコルをサポートしています。したがって、追加の設定なしで Application Monitoring で監視されるアプリケーションのトレースが実装されます。ただし、次の条件が満たされていることを確認してください。

• ARMS エージェントのバージョンが V2.x、V3.x、または V4.x であること。より良いユーザーエクスペリエンスのために V4.x を使用することをお勧めします。

• Apache Tomcat、Jetty、WebLogic、Undertow などの主流の Web コンテナーと、Spring Boot や Spring Web MVC などのサポートされているフレームワークが使用されていること。ARMS でサポートされているコンポーネントとフレームワークの詳細については、ARMS でサポートされている Java コンポーネントとフレームワークを参照してください。

アプリケーションの ARMS エージェントをインストールする方法については、Java アプリケーションを監視するを参照してください。

OpenTelemetry を使用する

OpenTelemetry を介してアプリケーションを Managed Service for OpenTelemetry に統合し、アプリケーションを自動または手動でインストラメントできます。

• アプリケーションを自動的にインストラメントする場合、OpenTelemetry はほとんどの主流のフレームワークをサポートしているため、追加の設定なしでトレースを実装できます。

  説明

  OpenTelemetry でサポートされている Java フレームワークについては、OpenTelemetry を使用して Java アプリケーションのトレースデータを報告するを参照してください。

• アプリケーションを手動でインストラメントする場合、OpenTelemetry SDK を使用して、フロントエンドリクエストヘッダー traceparent および tracestate からトレースコンテキストを解析することにより、トレースを有効にする必要があります。次のサンプルコードは、Spring Boot アプリケーションを手動でインストラメントし、トレースを有効にする方法を示しています。

  1. OpenTelemetry 依存関係をインポートします。

     <dependency>
       <groupId>io.opentelemetry</groupId>
       <artifactId>opentelemetry-api</artifactId>
     </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>
       <artifactId>opentelemetry-sdk-trace</artifactId>
     </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>
       <artifactId>opentelemetry-extension-annotations</artifactId>
       <version>1.18.0</version>
     </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>
       <artifactId>opentelemetry-exporter-otlp</artifactId>
     </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>
       <artifactId>opentelemetry-sdk</artifactId>
     </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>
       <artifactId>opentelemetry-semconv</artifactId>
       <version>1.30.1-alpha</version>
     </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>
       <artifactId>opentelemetry-sdk-extension-autoconfigure</artifactId>
       <version>1.34.1</version>
     </dependency>
     <dependency>
       <groupId>io.opentelemetry</groupId>
       <artifactId>opentelemetry-extension-incubator</artifactId>
       <version>1.35.0-alpha</version>
     </dependency>

  2. OpenTelemetry の初期化中に W3C 伝播を設定します。

     Resource resource = Resource.getDefault()
             .merge(Resource.create(Attributes.of(
                     ResourceAttributes.SERVICE_NAME, "otel-demo",
                     ResourceAttributes.HOST_NAME, "xxxx"
     )));
     
     SdkTracerProvider sdkTracerProvider = SdkTracerProvider.builder()
             .addSpanProcessor(BatchSpanProcessor.builder(OtlpHttpSpanExporter.builder()
                     .setEndpoint("Your Endpoint") // エンドポイントを指定します
                     .addHeader("Authentication", "Your Token") // 認証トークンを指定します
                     .build()).build())
             .setResource(resource)
             .build();
     
     openTelemetry = OpenTelemetrySdk.builder()
             .setTracerProvider(sdkTracerProvider)
             // W3C 伝播設定を追加します。
             .setPropagators(ContextPropagators.create(
                     TextMapPropagator.composite(W3CTraceContextPropagator.getInstance(), W3CBaggagePropagator.getInstance()))
              ).buildAndRegisterGlobal();
     // トレーサーを設定します。
     tracer = ExtendedTracer.create(openTelemetry.getTracer("com.example.tracer", "1.0.0"));

  3. ヘッダー情報を取得し、トレースコンテキストを解析し、親スパンを設定します。

     // @Controller でヘッダー情報を取得して、トレースコンテキストを解析します。
     @RequestMapping("/test")
     public String test(@RequestHeader Map<String, String> headers) {
         Span span = OpenTelemetrySupport.getTracer()
                 .spanBuilder("/test")
                 // ヘッダーから親スパンを解析します。
                 .setParentFrom(OpenTelemetrySupport.getContextPropagators(), headers)
                 .setSpanKind(SpanKind.SERVER)
                 .startSpan();
         try (Scope scope = span.makeCurrent()) {
             // 何かを実行します
         } catch (Throwable t) {
             span.setStatus(StatusCode.ERROR, "handle parent span error"); // 親スパンのエラー処理
         } finally {
             span.end();
         }
         return "success";
     }

Jaeger を使用する

Jaeger を使用して、アプリケーションを Managed Service for OpenTelemetry に統合できます。 Jaeger は、Web アプリケーションのトレースを有効にするための 2 つの方法を提供します。手動インストラメントと Spring Cloud コンポーネントによるインストラメントです。詳細については、Jaeger を使用して Java アプリケーションデータを報告するを参照してください。

• Spring Cloud コンポーネントを介してアプリケーションをインストラメントする場合、追加の設定なしでトレースを実装できます。

• アプリケーションを手動でインストラメントする場合、フロントエンドリクエストヘッダーからトレースコンテキストを解析する必要があります。サンプルコード:

  1. 依存関係をインポートします。

     <dependency>
       <groupId>io.jaegertracing</groupId>
       <artifactId>jaeger-client</artifactId>
       <version>Latest version</version> <!-- 最新の Jaeger バージョンを使用していることを確認してください。 -->
     </dependency>

  2. トレーサーを初期化します。

     <endpoint> を、Managed Service for OpenTelemetry コンソールの クラスター設定 ページの アクセスポイント情報 タブに表示されているエンドポイントに置き換えます。

     // manualDemo をアプリケーション名に置き換えます。
     io.jaegertracing.Configuration config = new io.jaegertracing.Configuration("manualDemo");
     io.jaegertracing.Configuration.SenderConfiguration sender = new io.jaegertracing.Configuration.SenderConfiguration();
     // <endpoint> を、Managed Service for OpenTelemetry コンソールの [クラスター設定] ページの [アクセスポイント情報] タブに表示されているエンドポイントに置き換えます。
     sender.withEndpoint("<endpoint>");
     config.withSampler(new io.jaegertracing.Configuration.SamplerConfiguration().withType("const").withParam(1));
     config.withReporter(new io.jaegertracing.Configuration.ReporterConfiguration().withSender(sender).withMaxQueueSize(10000));
     GlobalTracer.register(config.getTracer());

  3. スパンを作成します。

     // @Controller でヘッダー情報を取得して、トレースコンテキストを解析します。
     @RequestMapping("/test")
     public String test(@RequestHeader Map<String, String> headers) {
         Tracer tracer = GlobalTracer.get();
         SpanContext parentCtx = tracer.extract(Format.Builtin.HTTP_HEADERS, new TextMapAdapter(headers));
         Span span;
         if (parentCtx != null) {
             span = tracer.buildSpan("/test").asChildOf(parentCtx).start();
         } else {
             span = tracer.buildSpan("/test").start();
         }
         try (Scope ignored = tracer.activateSpan(span)) {
             tracer.activeSpan().setTag("methodName", "test");
             // 何かを実行します
         } catch (Throwable t) {
             TracingHelper.onError(e, span); // エラー発生時の処理
             throw e; // 例外を再スロー
         } finally {
             span.finish();
         }
         return "success";
     }

Zipkin を使用する

Zipkin を使用して、アプリケーションを Managed Service for OpenTelemetry に統合できます。詳細については、Zipkin を使用して Java アプリケーションデータを報告するを参照してください。

次に、リクエストヘッダーからトレースコンテキストを解析して、トレースを有効にします。サンプルコード:

// リクエストヘッダーからトレースコンテキストを解析します。
extractor = tracing.propagation().extractor(Request::getHeader);

// そのコンテキストを、名前を付けてタグを追加できるスパンに変換します。
oneWayReceive = nextSpan(tracer, extractor.extract(request))
.name("process-request")
.kind(SERVER)
... add tags etc. // タグなどを追加します

// サーバー側を開始し、finish ではなく flush します。
oneWayReceive.start().flush();

// このスパンは完了しているので、これ以上変更しないでください。ただし、
// 後続の作業を表す子を作成できます。
next = tracer.newSpan(oneWayReceive.context()).name("step2").start();

SkyWalking を使用する

SkyWalking agent for Java を使用して、アプリケーションを Managed Service for OpenTelemetry に統合できます。詳細については、SkyWalking を使用して Java アプリケーションデータを報告するを参照してください。

次に、バックエンドのトレースを有効にできます。

SkyWalking agent for Java V8.x を使用する場合は、SkyWalking Cross Process Propagation Headers Protocol v3 (sw8) を使用する必要があります。

OpenTelemetry を使用する

OpenTelemetry を使用して、アプリケーションを Managed Service for OpenTelemetry に統合できます。詳細については、OpenTelemetry を使用して Go アプリケーションのトレースデータを送信するを参照してください。

次に、HTTP リクエストハンドラーを使用して、リクエストコンテキストからスパンを生成し、トレースを有効にします。サンプルコード:

// トレーサーを初期化します。
tracer := otel.Tracer(common.TraceInstrumentationName)
// リクエストコンテキストからスパンを生成します。
handler := http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
    ctx := req.Context()
    span := trace.SpanFromContext(ctx)
    // 何かを実行します
    w.Write([]byte("Hello World"))
})

Jaeger を使用する

Jaeger を使用して、アプリケーションを Managed Service for OpenTelemetry に統合できます。詳細については、Jaeger を使用して Go アプリケーションデータを報告するを参照してください。

次に、HTTP リクエストヘッダーからスパンコンテキストを解析して、トレースを有効にします。サンプルコード:

// HTTP リクエストヘッダーからスパンコンテキストを解析します。
spanCtx, _ := tracer.Extract(opentracing.HTTPHeaders, opentracing.HTTPHeadersCarrier(r.Header))
span := tracer.StartSpan("myspan", opentracing.ChildOf(spanCtx))
...
defer  span.Finish()

Zipkin を使用する

Zipkin を使用して、アプリケーションを Managed Service for OpenTelemetry に統合できます。詳細については、Zipkin を使用して Go アプリケーションのトレースデータを送信するを参照してください。

次に、HTTP リクエストヘッダーからスパンコンテキストを解析して、トレースを有効にします。サンプルコード:

// トレーサーを初期化します。
tracer, err := exampletracer.NewTracer("go-frontend", frontendPort)
// リクエストコンテキストからスパンを生成します。
router.Methods("GET").Path("/").HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    // コンテキストからスパンを取得します
	span := zipkin.SpanFromContext(r.Context())
    // タグを追加します
    span.Tag("some_key", "some_value") // キーと値を指定します
    // 何かを実行します...
	span.Annotate(time.Now(), "some_event") // イベントを指定します
})

SkyWalking を使用する

SkyWalking を使用して、アプリケーションを Managed Service for OpenTelemetry に統合できます。詳細については、SkyWalking を使用して Go アプリケーションデータを報告するを参照してください。

Gin、go-restful、http、Kratos v2、Go Micro、Go Resty などの主流の Web フレームワークをサポートする SkyWalking agent for Go を使用することをお勧めします。その後、コードを変更せずにトレースを実装できます。

HTTP リクエストヘッダーからトレースコンテキストを手動で解析することもできます。サンプルコード:

//HTTP リクエストヘッダー `sw8` からコンテキストを抽出します
span, ctx, err := tracer.CreateEntrySpan(r.Context(), "/api/test", func(key string) (string, error) {
		return r.Header.Get(key), nil
})

OpenTelemetry を使用する

OpenTelemetry を使用して、アプリケーションを Managed Service for OpenTelemetry に統合できます。詳細については、OpenTelemetry を使用して Python アプリケーションのトレースデータを報告するを参照してください。

次に、HTTP リクエストヘッダーからスパンコンテキストを解析して、トレースを有効にします。サンプルコード:

// トレーサーを初期化します。
trace.set_tracer_provider(TracerProvider())
trace.get_tracer_provider().add_span_processor(BatchSpanProcessor(ConsoleSpanExporter()))

tracer = trace.get_tracer(__name__)

@app.route('/test')
def test():
    headers = dict(request.headers)

    // HTTP リクエストヘッダーからトレースコンテキストを解析します。
    carrier ={'traceparent': headers['Traceparent'], 'tracestate': headers['Tracestate']}
    ctx = TraceContextTextMapPropagator().extract(carrier=carrier)

    with tracer.start_span("test", context=ctx):
        // 何かを実行します
        return "success"

Jaeger を使用する

Jaeger を使用して、アプリケーションを Managed Service for OpenTelemetry に統合できます。詳細については、Jaeger を使用して Python アプリケーションデータを報告するを参照してください。

次に、HTTP リクエストヘッダーからスパンコンテキストを解析して、トレースを有効にします。サンプルコード:

import logging
from flask import Flask
from jaeger_client import Config
from opentracing.ext import tags
from opentracing.propagation import Format

## トレーサーを初期化します。
def init_tracer(service, scope_manager=None):
    logging.getLogger('').handlers = []
    logging.basicConfig(format='%(message)s', level=logging.DEBUG)

    config = Config(
        config={
            'sampler': {
                'type': 'const',
                'param': 1,
            },
            'logging': True,
            'reporter_batch_size': 1,
        },
        service_name=service,
        scope_manager=scope_manager
    )
    return config.initialize_tracer()

## trace デコレーター
def trace(tracer, span_name):
    def decorator(f):
        @functools.wraps(f)
        def wrapped(*args, **kwargs):
            ## HTTP リクエストヘッダーからトレースコンテキストを解析します。
            span_ctx = tracer.extract(Format.HTTP_HEADERS, request.headers)
            span_tags = {tags.SPAN_KIND: tags.SPAN_KIND_RPC_SERVER}

            with tracer.start_active_span(span_name, child_of=span_ctx, tags=span_tags) as scope:
                rv = f(*args, **kwargs)

            return rv
        return wrapped
    return decorator

## api テスト例
@app.route('/test')
@trace(tracer, 'test')
def test():
    return "success"

SkyWalking を使用する

SkyWalking を使用して、アプリケーションを Managed Service for OpenTelemetry に統合できます。詳細については、SkyWalking を使用して Python アプリケーションデータを報告するを参照してください。

次に、HTTP リクエストヘッダーからスパンコンテキストを解析して、トレースを有効にします。サンプルコード:

from skywalking import config, agent
from skywalking.trace.context import SpanContext, get_context
from skywalking.trace.carrier import CarrierItem

# SkyWalking を設定し、必要に応じてパラメーターを調整します。
config.init(agent_collector_backend_services='<endpoint>', // エンドポイントを指定します。
            agent_authentication='<auth-token>') // 認証トークンを指定します。

agent.start()

# HTTP リクエストヘッダーを処理する関数を使用します。
def handle_request(headers):
    # リクエストヘッダーからトレース情報を取得します。
    carrier_items = []
    for item in SpanContext.make_carrier():
        carrier_header = headers.get(item.key.lower())
        if carrier_header:
            carrier_items.append(CarrierItem(item.key, carrier_header))

    carrier = SpanContext.make_carrier(carrier_items)

    # キャリアからトレースコンテキストを取得します。
    context = get_context().extract(carrier)
    
    # スパンを作成します。
    with get_context().new_entry_span(op='operation_name') as span: // 操作名を指定します。
        # リクエストを処理し、処理完了時にスパンを自動的に送信します。
        ...

# SkyWalking セグメント ID を持つ辞書を使用して、HTTP リクエストヘッダーをシミュレートします。
incoming_headers = {
    'sw8': '1-My40LjU=-MTY1MTcwNDI5OTk5OA==-xxxx-xx-x-x==',  // 値を指定します。
    # その他のヘッダー...
}

# 関数を呼び出してリクエストを処理します。
handle_request(incoming_headers)