Application Real-Time Monitoring Service:アプリのエンドツーエンドトレースの有効化

ARMS エージェント (推奨)

ARMS エージェントは、デフォルトで OpenTelemetry プロトコルをサポートしています。ご利用の Java アプリケーションがすでにアプリケーションモニタリングで監視されている場合、エンドツーエンドトレースは追加の構成なしで機能します。

要件:

• ARMS エージェントのバージョンは V2.x、V3.x、または V4.x。より良いユーザーエクスペリエンスのためには V4.x を推奨します。

• サポートされている Web コンテナ: Apache Tomcat、Jetty、WebLogic、または Undertow

• サポートされているフレームワーク: Spring Boot または Spring Web MVC。詳細については、「ARMS がサポートする Java コンポーネントとフレームワーク」をご参照ください。

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

OpenTelemetry (自動インストルメンテーション)

自動イベントトラッキングで OpenTelemetry を使用する場合、OpenTelemetry はほとんどの主要な Java フレームワークをサポートしているため、追加の構成なしでトレースが機能します。詳細については、「OpenTelemetry を使用した Java アプリケーションのトレースデータレポート」をご参照ください。

OpenTelemetry (手動インストルメンテーション)

アプリケーションを手動でイベントトラッキングする場合、フロントエンドリクエストから 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. W3C 伝播で OpenTelemetry を初期化する:

Resource resource = Resource.getDefault()
        .merge(Resource.create(Attributes.of(
                ResourceAttributes.SERVICE_NAME, "otel-demo",
                ResourceAttributes.HOST_NAME, "<your-hostname>"
        )));

SdkTracerProvider sdkTracerProvider = SdkTracerProvider.builder()
        .addSpanProcessor(BatchSpanProcessor.builder(OtlpHttpSpanExporter.builder()
                .setEndpoint("<your-endpoint>")
                .addHeader("Authentication", "<your-token>")
                .build()).build())
        .setResource(resource)
        .build();

// Enable W3C trace context propagation
openTelemetry = OpenTelemetrySdk.builder()
        .setTracerProvider(sdkTracerProvider)
        .setPropagators(ContextPropagators.create(
                TextMapPropagator.composite(
                    W3CTraceContextPropagator.getInstance(),
                    W3CBaggagePropagator.getInstance())))
        .buildAndRegisterGlobal();

tracer = ExtendedTracer.create(
        openTelemetry.getTracer("com.example.tracer", "1.0.0"));

次のプレースホルダーを実際の値に置き換えます。

3. リクエストヘッダーからトレースコンテキストを解析する:

// In your @Controller, extract the trace context from the incoming request headers
@RequestMapping("/test")
public String test(@RequestHeader Map<String, String> headers) {
    Span span = OpenTelemetrySupport.getTracer()
            .spanBuilder("/test")
            // Set the parent span from the frontend request headers
            .setParentFrom(OpenTelemetrySupport.getContextPropagators(), headers)
            .setSpanKind(SpanKind.SERVER)
            .startSpan();
    try (Scope scope = span.makeCurrent()) {
        // Process the request
    } catch (Throwable t) {
        span.setStatus(StatusCode.ERROR, "handle parent span error");
    } finally {
        span.end();
    }
    return "success";
}

SkyWalking

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

SkyWalking v8.x エージェントを使用する場合は、ステップ 1 で sw8 プロトコルを選択します。

OpenTelemetry

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

次に、ご利用の HTTP ハンドラでリクエストコンテキストからスパンを抽出します。

// Initialize the tracer
tracer := otel.Tracer(common.TraceInstrumentationName)

// Extract the span from the incoming request context
handler := http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
    ctx := req.Context()
    span := trace.SpanFromContext(ctx)
    // Process the request
    w.Write([]byte("Hello World"))
})

SkyWalking

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

SkyWalking Go エージェントは、Gin、go-restful、http、Kratos v2、Go Micro、Go Resty などの Web フレームワークをそのままサポートしています。サポートされているフレームワークでエージェントを使用する場合、コード変更なしでトレースが機能します。

リクエストヘッダーからトレースコンテキストを手動で解析するには:

// Extract context from the sw8 HTTP request header
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 アプリケーションのトレースデータレポート」をご参照ください。

次に、リクエストヘッダーからトレースコンテキストを解析します。次の例は Flask を使用しています。

# Initialize the tracer
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)

    # Parse the W3C trace context from the request headers
    carrier = {
        'traceparent': headers['Traceparent'],
        'tracestate': headers['Tracestate']
    }
    ctx = TraceContextTextMapPropagator().extract(carrier=carrier)

    with tracer.start_span("test", context=ctx):
        # Process the request
        return "success"

SkyWalking

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

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

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

# Configure SkyWalking
config.init(
    agent_collector_backend_services='<endpoint>',
    agent_authentication='<auth-token>')

agent.start()

def handle_request(headers):
    # Extract trace information from the 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)

    # Extract the trace context from the carrier
    context = get_context().extract(carrier)

    # Create a span that continues the frontend trace
    with get_context().new_entry_span(op='operation_name') as span:
        # Process the request
        ...

# Example: use a dictionary with SkyWalking segment IDs to simulate incoming request headers
incoming_headers = {
    'sw8': '1-My40LjU=-MTY1MTcwNDI5OTk5OA==-xxxx-xx-x-x==',
}

handle_request(incoming_headers)

次のプレースホルダーを実際の値に置き換えます。