OpenTelemetry Python への移行

pip install aws-xray-sdk
        

pip install opentelemetry-api opentelemetry-sdk opentelemetry-exporter-otlp opentelemetry-propagator-aws-xray
        

X-Ray では、グローバルな xray_recorder が初期化され、セグメントとサブセグメントを生成するために使用されました。

OpenTelemetry では、グローバルな TracerProvider を初期化する必要があります。この TracerProvider を使用すると、アプリケーションの任意の場所でスパンを生成するために使用できるトレーサーを取得できます。以下のコンポーネントを設定することをお勧めします。

from opentelemetry import (
    trace,
    propagate
)
from opentelemetry.sdk.trace import TracerProvider

from opentelemetry import trace
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
from opentelemetry.sdk.trace.export import BatchSpanProcessor
from opentelemetry.propagators.aws import AwsXRayPropagator

# Sends generated traces in the OTLP format to an OTel Collector running on port 4318
otlp_exporter = OTLPSpanExporter(endpoint="http://localhost:4318/v1/traces")
# Processes traces in batches as opposed to immediately one after the other
span_processor = BatchSpanProcessor(otlp_exporter)
# More configurations can be done here. We will visit them later.

# Sets the global default tracer provider
provider = TracerProvider(active_span_processor=span_processor)
trace.set_tracer_provider(provider)

# Configures the global propagator to use the X-Ray Propagator
propagate.set_global_textmap(AwsXRayPropagator())

# Creates a tracer from the global tracer provider
tracer = trace.get_tracer("my.tracer.name")
# Use this tracer to create Spans
          

X-Ray Python SDK は、Django、Flask、Bottle などのアプリケーションフレームワークをサポートし、それらで実行されている Python アプリケーションの受信リクエストをトレースします。これは、各フレームワークの XRayMiddleware をアプリケーションに追加することによって行われます。

OpenTelemetry は、特定の計装ライブラリを通じて Django と Flask の計装を提供しています。OpenTelemetry で使用できる Bottle の計装はありません。OpenTelemetry WSGI Instrumentation を使用してアプリケーションを追跡できます。

次のコード例では、次の依存関係が必要です。

pip install opentelemetry-instrumentation-flask
        

アプリケーションフレームワークの計装を追加する前に、OpenTelemetry SDK を初期化し、グローバルな TracerProvider を登録する必要があります。これを行わないと、トレースオペレーションは no-ops になります。グローバルな TracerProvider を設定したら、アプリケーションフレームワークに Instrumentor を使用できます。次の例は、Flask アプリケーションを示します。

from flask import Flask
from opentelemetry import trace
from opentelemetry.instrumentation.flask import FlaskInstrumentor
from opentelemetry.sdk.extension.aws.resource import AwsEc2ResourceDetector
from opentelemetry.sdk.resources import get_aggregated_resources
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter

provider = TracerProvider(resource=get_aggregated_resources(
    [
        AwsEc2ResourceDetector(),
    ]))

processor = BatchSpanProcessor(ConsoleSpanExporter())
provider.add_span_processor(processor)
trace.set_tracer_provider(provider)

# Creates a tracer from the global tracer provider
tracer = trace.get_tracer("my.tracer.name")

app = Flask(__name__)

# Instrument the Flask app
FlaskInstrumentor().instrument_app(app)


@app.route('/')
def hello_world():
    return 'Hello World!'


if __name__ == '__main__':
    app.run()
        

X-Ray Python SDK は、botocoreライブラリにパッチを適用して AWS SDK クライアントリクエストをトレースします。詳細については、「X-Ray AWS SDK for Python を使用した SDK 呼び出しのトレース」を参照してください。アプリケーションでは、patch_all() メソッドを使用してすべてのライブラリを計装するか、patch((['botocore'])) を使用した botocore または boto3 ライブラリを使用してパッチを選択的に適用します。選択したメソッドのいずれかがアプリケーション内のすべての Boto3 クライアントを計装し、これらのクライアントを使用して行われた呼び出しのサブセグメントを生成します。

次のコード例では、次の依存関係が必要です。

pip install opentelemetry-instrumentation-botocore
        

OpenTelemetry Botocore Instrumentation をプログラムで使用して、アプリケーション内のすべての Boto3 クライアントを計装します。以下の例は、botocore 計装を示しています。

import boto3
import opentelemetry.trace as trace
from botocore.exceptions import ClientError
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.resources import get_aggregated_resources
from opentelemetry.sdk.trace.export import (
    BatchSpanProcessor,
    ConsoleSpanExporter,
)
from opentelemetry.instrumentation.botocore import BotocoreInstrumentor

provider = TracerProvider()
processor = BatchSpanProcessor(ConsoleSpanExporter())
provider.add_span_processor(processor)
trace.set_tracer_provider(provider)

# Creates a tracer from the global tracer provider
tracer = trace.get_tracer("my.tracer.name")

# Instrument BotoCore
BotocoreInstrumentor().instrument()

# Initialize S3 client
s3 = boto3.client("s3", region_name="us-east-1")

# Your bucket name
bucket_name = "my-example-bucket"

# Get bucket location (as an example of describing it)
try:
    response = s3.get_bucket_location(Bucket=bucket_name)
    region = response.get("LocationConstraint") or "us-east-1"
    print(f"Bucket '{bucket_name}' is in region: {region}")

    # Optionally, get bucket's creation date via list_buckets
    buckets = s3.list_buckets()
    for bucket in buckets["Buckets"]:
        if bucket["Name"] == bucket_name:
            print(f"Bucket created on: {bucket['CreationDate']}")
            break
except ClientError as e:
    print(f"Failed to describe bucket: {e}")
        

X-Ray Python SDK は、requests ライブラリにパッチを適用して、リクエストを通じて送信 HTTP 呼び出しをトレースします。詳細については、「Tracing calls to downstream HTTP web services using the X-Ray SDK for Python」を参照してください。アプリケーションでは、patch_all() メソッドを使用してすべてのライブラリを計装するか、patch((['requests'])) を使用してリクエストライブラリに選択的にパッチを適用できます。オプションのいずれかが requests ライブラリを計装し、requests を介して行われた呼び出しのサブセグメントを生成します。

次のコード例では、次の依存関係が必要です。

pip install opentelemetry-instrumentation-requests
        

OpenTelemetry Requests Instrumentation をプログラムで使用して、requests ライブラリを計装し、アプリケーションで OpenTelemetry Requests によって行われた HTTP リクエストのトレースを生成します。詳細については、「OpenTelemetry requests Instrumentation」を参照してください。次の例は、requests ライブラリの計装を示しています。

from opentelemetry.instrumentation.requests import RequestsInstrumentor

# Instrument Requests
RequestsInstrumentor().instrument()

...

    example_session = requests.Session()
    example_session.get(url="https://example.com")
        

または、基盤となる urllib3 ライブラリを計装して HTTP リクエストをトレースすることもできます。

# pip install opentelemetry-instrumentation-urllib3
from opentelemetry.instrumentation.urllib3 import URLLib3Instrumentor

# Instrument urllib3
URLLib3Instrumentor().instrument()

...

    example_session = requests.Session()
    example_session.get(url="https://example.com")