Application Real-Time Monitoring Service:Python アプリケーションのログにトレース ID を関連付ける

環境変数

トレースコンテキストフィールド

ログ出力にトレースコンテキストを含めるには、OTEL_PYTHON_LOG_FORMAT フォーマット文字列で以下のフィールドを使用します。

環境変数の設定

アプリケーションを起動する前に、以下の環境変数を設定します。

export OTEL_PYTHON_LOG_CORRELATION=true
export OTEL_PYTHON_LOG_LEVEL=info
export OTEL_PYTHON_LOG_FORMAT='%(asctime)s %(levelname)s [%(name)s] [%(filename)s:%(lineno)d] [trace_id=%(otelTraceID)s span_id=%(otelSpanID)s resource.service.name=%(otelServiceName)s trace_sampled=%(otelTraceSampled)s] - %(message)s'

アプリケーションの起動後、ログ出力にはトレースコンテキストが含まれます。

Submitting thread
INFO:     Started server process [271]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
2025-01-02 21:55:31,142 WARNING [__main__] [app.py:14] [trace_id=534xxx021eb span_id=15xxx32 resource.service.name=fastapi-agent-manual trace_sampled=True] - calling client
INFO:     127.0.0.1:59956 - "GET / HTTP/1.1" 200 OK

カスタムハンドラへのトレースコンテキストの追加

トレースコンテキストは、ルートロガーにのみ自動的に注入されます。カスタムハンドラを使用する場合は、OTEL_PYTHON_LOG_FORMAT 環境変数から読み取るようにフォーマッタを設定します。

import os
import logging

# 環境変数からフォーマット文字列を読み取る
log_format = os.getenv('OTEL_PYTHON_LOG_FORMAT')

# トレースコンテキストフィールドを持つカスタムハンドラを作成
my_handler = logging.StreamHandler()
formatter = logging.Formatter(log_format)
my_handler.setFormatter(formatter)

# ロガーにハンドラをアタッチ
logger = logging.getLogger('my_module')
logger.addHandler(my_handler)
logger.setLevel(logging.INFO)

structlog へのトレースコンテキストの追加

アプリケーションで structlog を使用している場合、自動トレースコンテキスト注入はサポートされていません。structlog パイプラインに、OpenTelemetry SDK からトレースコンテキストを読み取るカスタムプロセッサを追加します。

from opentelemetry import trace
import structlog

def add_otel_context(logger, method, event_dict):
    span = trace.get_current_span()
    ctx = span.get_span_context()
    if ctx.is_valid:
        event_dict['trace_id'] = format(ctx.trace_id, '032x')
        event_dict['span_id'] = format(ctx.span_id, '016x')
    return event_dict

structlog.configure(
    processors=[
        add_otel_context,
        structlog.processors.JSONRenderer(),
    ]
)

設定後、トレースされたリクエスト内で生成される各 structlog エントリには、trace_id および span_id フィールドが含まれます。SLS は、これらのフィールドを使用して、ログを対応する分散トレースと関連付けます。