Application Real-Time Monitoring Service:OpenTelemetry を使用した Python アプリケーションからのトレースデータのレポート

ステップ 1：依存関係のインストール

pip install django
pip install requests
pip install opentelemetry-distro \
	opentelemetry-exporter-otlp

opentelemetry-bootstrap -a install

opentelemetry-bootstrap は、インストール済みのライブラリを検出し、該当するトレース可能化プラグインを自動的にインストールします。

ステップ 2：Django プロジェクトおよびアプリケーションの作成

1. AutoAndManualDemo プロジェクトを作成します：

      django-admin startproject AutoAndManualDemo

2. プロジェクト内に HelloWorld アプリケーションを作成します：

      cd AutoAndManualDemo
   
      # プロジェクト内に HelloWorld アプリケーションを作成します。
      python manage.py startapp helloworld

ステップ 3：アプリケーションコードの追加

1. 次のコードを AutoAndManualDemo/helloworld/views.py ファイルに追加します：

      from django.http import HttpResponse
      from datetime import datetime
   
      # ビューを定義します。
      def hello_world_view(request):
          result = "Hello World!  Current Time =" + str(get_time())
          return HttpResponse(result)
   
      def get_time():
          now = datetime.now()
          return now.strftime("%H:%M:%S")

2. AutoAndManualDemo/helloworld/urls.py ファイルを作成し、以下のコードを追加します：

      from django.urls import path
   
      from . import views
   
      urlpatterns = [
          path('', views.hello_world_view, name='helloworld')
      ]

3. AutoAndManualDemo/AutoAndManualDemo/urls.py ファイルに URL パターンを追加します：

      from django.contrib import admin
      from django.urls import path, include
   
      urlpatterns = [
       path('admin/', admin.site.urls),
       path('helloworld/', include('helloworld.urls')),
      ]

ステップ 4：アプリケーションの実行

起動コマンドの先頭に opentelemetry-instrument を付与し、エクスポーターの構成を渡します。

HTTP 経由でのレポート

opentelemetry-instrument \
    --traces_exporter console,otlp_proto_http \
    --metrics_exporter none \
    --service_name <your-service-name> \
    --exporter_otlp_traces_endpoint <endpoint> \
    python manage.py runserver --noreload

コンソールにトレースデータを表示しない場合は、--traces_exporter パラメーターを --traces_exporter otlp_proto_http に設定してください。

  export DJANGO_SETTINGS_MODULE=AutoAndManualDemo.settings

ステップ 5：トレースデータの送信確認

1. ブラウザで http://127.0.0.1:8000/helloworld/ にアクセスします。コンソールにトレースデータが表示され、OpenTelemetry 向けマネージドサービスにトレースデータが送信されます。

2. ARMS コンソールにログインします。

3. 左側のナビゲーションウィンドウで、アプリケーションモニタリング > アプリケーション を選択します。

4. アプリケーション ページで、設定したサービス名でアプリケーションを検索し、クリックします。

5. アプリケーションの詳細ページで、トレースが表示されていることを確認します。送信したリクエストに対応するスパンデータが表示されるはずです。

説明 言語 列に アイコンが表示されている場合、アプリケーションはアプリケーションモニタリングに接続されています。ハイフン（-）が表示されている場合、OpenTelemetry 向けマネージドサービスに接続されています。

ステップ 1：依存関係のインストール

pip install opentelemetry-api opentelemetry-sdk opentelemetry-exporter-otlp

ステップ 2：OpenTelemetry の初期化

トレーサープロバイダーおよびエクスポーターを構成する初期化モジュール（例： manual.py）を作成します。

from opentelemetry import trace
from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import (
    OTLPSpanExporter as OTLPSpanGrpcExporter,
)
from opentelemetry.exporter.otlp.proto.http.trace_exporter import (
    OTLPSpanExporter as OTLPSpanHttpExporter,
)
from opentelemetry.sdk.resources import SERVICE_NAME, HOST_NAME, Resource
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor


def init_opentelemetry():
    resource = Resource(attributes={
        SERVICE_NAME: "<your-service-name>",
        HOST_NAME: "<host-name>",
    })

    # オプション A：gRPC 経由でのエクスポート
    span_processor = BatchSpanProcessor(OTLPSpanGrpcExporter(
        endpoint="<endpoint>",
        headers=("Authentication=<token>"),
    ))

    # オプション B：HTTP 経由でのエクスポート（使用する場合はコメントを解除）
    # span_processor = BatchSpanProcessor(OTLPSpanHttpExporter(
    #     endpoint="<endpoint>",
    # ))

    trace_provider = TracerProvider(
        resource=resource,
        active_span_processor=span_processor,
    )
    trace.set_tracer_provider(trace_provider)

ステップ 3：スパンの作成

初期化後にトレーサーを取得し、操作の追跡にスパンを作成します。

tracer = trace.get_tracer(__name__)

# コンテキストマネージャーパターン
with tracer.start_as_current_span("child_span") as child_span:
    print("hello world")

親子関係を表すためにスパンをネストできます：

def outer_method():
    tracer = trace.get_tracer(__name__)
    with tracer.start_as_current_span("parent_span") as parent_span:
        inner_method()

def inner_method():
    tracer = trace.get_tracer(__name__)
    with tracer.start_as_current_span("child_span") as child_span:
        print("hello world")

ステップ 4：トレース ID およびスパン ID の取得

現在のスパンコンテキストからトレース ID およびスパン ID を抽出します。これらの ID は、ログとトレースの相関付けに役立ちます。

ctx = trace.get_current_span().get_span_context()
trace_id = '{trace:032x}'.format(trace=ctx.trace_id)
span_id = '{span:016x}'.format(span=ctx.span_id)
print(trace_id)
print(span_id)

ステップ 5：Baggage API を使用したカスタムメタデータの伝搬

OpenTelemetry Baggage API は、トレース内のスパン間でキーと値のペアを伝搬します。ユーザー ID、テナント ID、リクエストコンテキストなどのメタデータをサービス間で渡すために、バゲージを使用します。

from opentelemetry import trace, baggage

def baggage_and_attribute_usage():
    tracer = trace.get_tracer(__name__)

    # グローバルレベルでバゲージを設定
    global_ctx = baggage.set_baggage("key", "value_from_global_ctx")

    # カスタム属性を持つスパンを作成
    with tracer.start_as_current_span(
        name='baggage_parent_span',
        attributes={'attribute_key': 'value'},
    ) as baggage_parent_span:

        # 親コンテキストでバゲージを設定
        parent_ctx = baggage.set_baggage("key", "value_from_parent_ctx")

        with tracer.start_as_current_span(
            name='baggage_child_span',
            context=parent_ctx,
        ) as baggage_child_span:

            # 子コンテキストでバゲージを設定
            child_ctx = baggage.set_baggage("key", "value_from_child_ctx")

    # 各コンテキストからバゲージ値を読み取ります
    print(baggage.get_baggage("key", global_ctx))   # value_from_global_ctx
    print(baggage.get_baggage("key", parent_ctx))    # value_from_parent_ctx
    print(baggage.get_baggage("key", child_ctx))     # value_from_child_ctx

ステップ 6：実行および確認

python manual.py

アプリケーションの実行後、ARMS コンソールでトレースデータを確認します。「自動トレース可能化」セクションの「トレースデータの送信確認」の手順に従ってください。

ステップ 1：依存関係のインストール

pip install django
pip install requests
pip install opentelemetry-sdk
pip install opentelemetry-instrumentation-django
pip install opentelemetry-exporter-otlp

ステップ 2：Django プロジェクトおよびアプリケーションの作成

1. AutoAndManualDemo プロジェクトを作成します：

      django-admin startproject AutoAndManualDemo

2. プロジェクト内に HelloWorld アプリケーションを作成します：

      cd AutoAndManualDemo
   
      # プロジェクト内に HelloWorld アプリケーションを作成します。
      python manage.py startapp helloworld

ステップ 3：コードへのカスタムスパンの追加

OpenTelemetry トレース API をインポートし、追跡したい操作の周囲にスパンを作成します。

以下の Django ビューの例では、Django トレース可能化プラグインによって自動的に作成されるスパンに加え、2 つのカスタムスパン（hello_world_span および time_span）を追加しています。helloworld/views.py ファイルを次のように変更します：

from django.http import HttpResponse
from opentelemetry import trace
from datetime import datetime


def hello_world_view(request):
    tracer = trace.get_tracer(__name__)

    with tracer.start_as_current_span("hello_world_span") as hello_world_span:
        result = "Hello World!  Current Time =" + str(get_time())
        return HttpResponse(result)


def get_time():
    now = datetime.now()
    tracer = trace.get_tracer(__name__)
    with tracer.start_as_current_span("time_span") as time_span:
        return now.strftime("%H:%M:%S")

ステップ 4：urls.py ファイルの変更

1. helloworld/urls.py ファイルを作成し、以下のコードを追加します：

      from django.urls import path
   
      from . import views
   
      urlpatterns = [
          path('', views.hello_world_view, name='helloworld')
      ]

2. AutoAndManualDemo/AutoAndManualDemo/urls.py ファイルに URL パターンを追加します：

      from django.contrib import admin
      from django.urls import path, include
   
      urlpatterns = [
       path('admin/', admin.site.urls),
       path('helloworld/', include('helloworld.urls')),
      ]

ステップ 5：トレーサープロバイダーの構成

エクスポーターおよびトレーサープロバイダーを設定する初期化モジュールを作成します。manual.py ファイルの OpenTelemetry 初期化コードに、以下のコードを追加します。このモジュールは、アプリケーションの起動時に早期にインポートする必要があります（例： manage.py または WSGI/ASGI エントリポイント内）。

from opentelemetry import trace
from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
# HTTP を使用する場合は、次の行のコメントを解除し、gRPC のインポート行をコメントアウトしてください：
# from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
from opentelemetry.sdk.resources import SERVICE_NAME, HOST_NAME, Resource
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter


resource = Resource(attributes={
    SERVICE_NAME: "<your-service-name>",
    HOST_NAME: "<host-name>",
})

trace.set_tracer_provider(TracerProvider(resource=resource))

# gRPC 経由でトレースをエクスポート
trace.get_tracer_provider().add_span_processor(
    BatchSpanProcessor(OTLPSpanExporter(
        endpoint="<endpoint>",
        headers="Authentication=<token>",  # gRPC のみ必須
    ))
)

# トレースをコンソールにも出力（デバッグに便利）
trace.get_tracer_provider().add_span_processor(
    BatchSpanProcessor(ConsoleSpanExporter())
)

ステップ 6：実行および確認

python manage.py runserver --noreload

  pip install grpcio

http://127.0.0.1:8000/helloworld/ にリクエストを送信し、ARMS コンソールでトレースデータを確認します。「自動トレース可能化」セクションの「トレースデータの送信確認」の手順に従ってください。