Migrer vers OpenTelemetry Python

pip install aws-xray-sdk
        

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

Dans X-Ray, le global xray_recorder est initialisé et utilisé pour générer des segments et des sous-segments.

Dans OpenTelemetry, vous devez initialiser un globalTracerProvider. Grâce à celaTracerProvider, vous pouvez acquérir un traceur que vous pouvez utiliser pour générer des spans n'importe où dans votre application. Il est recommandé de configurer les composants suivants :

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
          

Le SDK Python X-Ray prend en charge les frameworks d'applications tels que Django, Flask et Bottle pour suivre les demandes entrantes pour les applications Python exécutées sur ces derniers. Cela se fait en ajoutant XRayMiddleware à l'application pour chaque framework.

OpenTelemetry fournit des instrumentations pour Django et Flask via les bibliothèques d'instrumentation spécifiques. Aucune instrumentation pour Bottle n'est disponible dans OpenTelemetry, les applications peuvent toujours être tracées à l'aide de l'instrumentation OpenTelemetry WSGI.

Pour l'exemple de code suivant, vous avez besoin de la dépendance suivante :

pip install opentelemetry-instrumentation-flask
        

Vous devez initialiser le OpenTelemetry SDK et enregistrer le global TracerProvider avant d'ajouter des instrumentations pour votre infrastructure d'application. Sans cela, les opérations de traçage le serontno-ops. Une fois que vous avez configuré le globalTracerProvider, vous pouvez utiliser l'instrument pour votre infrastructure d'application. L'exemple suivant illustre une application 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()
        

Le SDK Python de X-Ray trace la demande du client du AWS SDK en appliquant des correctifs à la bibliothèque. botocore Pour plus d'informations, consultez la section Tracing AWS SDK calls with the X-Ray SDK for Python. Dans votre application, la patch_all() méthode est utilisée pour instrumenter toutes les bibliothèques ou appliquer des correctifs de manière sélective à l'aide de la botocore ou boto3 des bibliothèques utilisantpatch((['botocore'])). L'une des méthodes choisies instrumente tous les clients Boto3 de votre application et génère un sous-segment pour tout appel effectué à l'aide de ces clients.

Pour l'exemple de code suivant, vous aurez besoin de la dépendance suivante :

pip install opentelemetry-instrumentation-botocore
        

Utilisez l'instrumentation OpenTelemetry Botocore de manière programmatique pour instrumenter tous les clients Boto3 de votre application. L'exemple suivant illustre l'botocoreinstrumentation.

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}")
        

Le SDK Python de X-Ray trace les appels HTTP sortants via les requêtes en appliquant des correctifs à la bibliothèque de requêtes. Pour plus d'informations, voir Suivi des appels aux services Web HTTP en aval à l'aide du SDK X-Ray pour Python. Dans votre application, vous pouvez utiliser la patch_all() méthode pour instrumenter toutes les bibliothèques ou en appliquant des correctifs sélectifs aux bibliothèques de requêtes en utilisantpatch((['requests'])). N'importe laquelle des options instrumente la requests bibliothèque, générant un sous-segment pour chaque appel effectué par le biais requests de cette option.

Pour l'exemple de code suivant, vous aurez besoin de la dépendance suivante :

pip install opentelemetry-instrumentation-requests
        

Utilisez l'instrumentation OpenTelemetry des requêtes par programmation pour instrumenter la bibliothèque de requêtes afin de générer des traces pour les requêtes HTTP qu'elle effectue dans votre application. Pour plus d'informations, consultez la section Instrumentation OpenTelemetry des requêtes. L'exemple suivant illustre l'instrumentation de la requests bibliothèque.

from opentelemetry.instrumentation.requests import RequestsInstrumentor

# Instrument Requests
RequestsInstrumentor().instrument()

...

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

Vous pouvez également instrumenter la urllib3 bibliothèque sous-jacente pour suivre les requêtes 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")