OpenTelemetryを活用してGCP × Python × マイクロサービス構成のObservabilityを高める

from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.resources import Resource
from opentelemetry.exporter.cloud_trace import CloudTraceSpanExporter

def init_trace(service_name: str, environment: str):
    ...
    tracer_provider = TracerProvider(
        # service.name, service.environment という名前のカスタムラベルを付与する
        resource=Resource.create(
            {
                "service.name": service_name,
                "service.environment": environment,
            }
        ),
    )
    # resource_regex に渡した正規表現にマッチするラベル名のみがSpanに紐付けられる
    # Cloud Trace ではSpanに紐付けられるラベルが32個までと決まっており、
    # 不用意にその制限に当たるラベルが付与されないようにこのような設定が必要となっている
    # FYI: https://github.com/GoogleCloudPlatform/python-docs-samples/issues/7300#issuecomment-1164737444
    exporter = CloudTraceSpanExporter(resource_regex="service.*")
    ...


init_trace(service_name: "sample-application", environment: "production")

import requests
from opentelemetry import trace


class TraceContextManager:
    @classmethod
    def get_trace_context(cls):
        """
        分散トレーシングするにはアプリケーション間で同じX-Cloud-Trace-Contextを引き回す必要がある
        X-Cloud-Trace-Context のフォーマットは`TRACE_ID/SPAN_ID;o=TRACE_TRUE`
        https://cloud.google.com/trace/docs/setup#force-trace
        """
        return f"{cls.__get_trace_id()}/{cls.__get_span_id()}"

    @classmethod
    def __span_context(cls):
        return trace.get_current_span().get_span_context()

    @classmethod
    def __get_trace_id(cls):
        """
        Trace IDはOpenTelemetryの仕様では128 ビットの番号を表す32文字の16進数値だが
        OpenTelemetryのPython package内だと別フォーマットで管理されているため
        パッケージ側のフォーマット関数をかませる必要がある
        """
        return trace.format_trace_id(cls.__span_context().trace_id)

    @classmethod
    def __get_span_id(cls):
        return cls.__span_context().span_id


headers = {}
trace_context = TraceContextManager.get_trace_context()
if trace_context:
    headers["X-Cloud-Trace-Context"] = trace_context
res = requests.post(url, json={}, headers=headers)

from flask import Flask, current_app
from opentelemetry.instrumentation.wsgi import OpenTelemetryMiddleware


app = Flask(__name__)
# middlewareの設定を行う
with current_app.app_context():
    current_app.wsgi_app = OpenTelemetryMiddleware(current_app.wsgi_app)


def handler(req: Request) -> Response:
    ...

from opentelemetry import trace


class TraceContextManager:
    @classmethod
    def get_trace_id(cls):
        """
        Trace IDはOpenTelemetryの仕様では128 ビットの番号を表す32文字の16進数値だが
        OpenTelemetryのPython package内だと別フォーマットで管理されているため
        パッケージ側のフォーマット関数をかませる必要がある
        """
        return trace.format_trace_id(cls.__span_context().trace_id)

    @classmethod
    def __span_context(cls):
        return trace.get_current_span().get_span_context()


@app.get("/")
def handler():
  # gcp-trace-idとしてTrace IDをタグ付与する
  sentry_sdk.set_tag("gcp-trace-id", TraceContextManager.get_trace_id())
  ...