Application Real-Time Monitoring Service:Web アプリケーションまたはミニアプリ向けのエンドツーエンドトレースの有効化

OpenTelemetry を使用した Java

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. リクエストヘッダーからトレースコンテキストを解析し、子スパンを作成します。

       @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 を使用した Java

1. Jaeger クライアントの依存関係を追加します。

       <dependency>
         <groupId>io.jaegertracing</groupId>
         <artifactId>jaeger-client</artifactId>
         <version>最新バージョン</version>
       </dependency>

2. トレーサーを初期化します。<endpoint> は、OpenTelemetry 向けマネージドサービスコンソールの [アクセスポイント情報] タブ（[クラスター構成] ページ）から取得したエンドポイントに置き換えてください。

       // manualDemo をご自身のアプリケーション名に置き換え
       io.jaegertracing.Configuration config = new io.jaegertracing.Configuration("manualDemo");
       io.jaegertracing.Configuration.SenderConfiguration sender = new io.jaegertracing.Configuration.SenderConfiguration();
       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. トレースコンテキストを解析し、子スパンを作成します。

       @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(t, span);
               throw t;
           } finally {
               span.finish();
           }
           return "success";
       }

Zipkin を使用した Java

Zipkin 経由でアプリケーションを OpenTelemetry 向けマネージドサービスと統合します。詳細については、「Zipkin を使用した Java アプリケーションデータの報告」をご参照ください。

リクエストヘッダーからトレースコンテキストを解析します。

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

// コンテキストをスパンに変換
oneWayReceive = nextSpan(tracer, extractor.extract(request))
.name("process-request")
.kind(SERVER)
... add tags etc.

// サーバー側スパンを開始し、フラッシュ
oneWayReceive.start().flush();

// 後続処理用の子スパンを作成
next = tracer.newSpan(oneWayReceive.context()).name("step2").start();

OpenTelemetry を使用した Go

アプリケーションを OpenTelemetry 向けマネージドサービスと統合します。詳細については、「OpenTelemetry を使用した Go アプリケーションのトレースデータの送信」をご参照ください。

リクエストコンテキストからスパンを生成します。

// トレーサーを初期化
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 を使用した Go

アプリケーションを 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 を使用した Go

アプリケーションを OpenTelemetry 向けマネージドサービスと統合します。詳細については、「Zipkin を使用した Go アプリケーションのトレースデータの送信」をご参照ください。

リクエストコンテキストからスパンを取得します。

// トレーサーを初期化
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 を使用した Go

アプリケーションを OpenTelemetry 向けマネージドサービスと統合します。詳細については、「SkyWalking を使用した Go アプリケーションデータの報告」をご参照ください。

sw8 ヘッダーからトレースコンテキストを解析します。

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

OpenTelemetry を使用した Python

アプリケーションを OpenTelemetry 向けマネージドサービスと統合します。詳細については、「OpenTelemetry を使用した Python アプリケーションのトレースデータの報告」をご参照ください。

traceparent および tracestate ヘッダーからトレースコンテキストを解析します。

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)

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

    with tracer.start_span("test", context=ctx):
        # リクエストを処理
        return "success"

Jaeger を使用した Python

アプリケーションを OpenTelemetry 向けマネージドサービスと統合します。詳細については、「Jaeger を使用した Python アプリケーションデータの報告」をご参照ください。

リクエストヘッダーからトレースコンテキストを解析します。

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()

# トレースデコレータ
def trace(tracer, span_name):
    def decorator(f):
        @functools.wraps(f)
        def wrapped(*args, **kwargs):
            # リクエストヘッダーからトレースコンテキストを解析
            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

# 例：エンドポイント
@app.route('/test')
@trace(tracer, 'test')
def test():
    return "success"

SkyWalking を使用した Python

アプリケーションを OpenTelemetry 向けマネージドサービスと統合します。詳細については、「SkyWalking を使用した Python アプリケーションデータの報告」をご参照ください。

sw8 ヘッダーからトレースコンテキストを解析します。

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()

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:
        # リクエストを処理。完了時にスパンが自動的に送信されます。
        ...

# 例：模擬された着信リクエストヘッダー
incoming_headers = {
    'sw8': '1-My40LjU=-MTY1MTcwNDI5OTk5OA==-xxxx-xx-x-x==',
}

handle_request(incoming_headers)