Migrar a OpenTelemetry Python

pip install aws-xray-sdk
        

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

En X-Ray, el xray_recorder global se inicializa y se usa para generar segmentos y subsegmentos.

En OpenTelemetry, necesita inicializar un globalTracerProvider. Con este TracerProvider, puede adquirir un Rastreador que puede usar para generar intervalos en cualquier parte de la aplicación. Se recomienda que configure los siguientes componentes:

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
          

El X-Ray Python SDK admite marcos de aplicaciones como Django, Flask y Bottle para rastrear las solicitudes entrantes de las aplicaciones de Python que se ejecutan en ellos. Esto se hace agregando XRayMiddleware a la aplicación para cada marco.

OpenTelemetry proporciona instrumentaciones para Django y Flask a través de las bibliotecas de instrumentación específicas. No hay instrumentación para Bottle disponible en OpenTelemetry, pero aún se pueden rastrear las aplicaciones utilizando la instrumentación WSGI. OpenTelemetry

Para el ejemplo de código siguiente, necesita la siguiente dependencia:

pip install opentelemetry-instrumentation-flask
        

Debe inicializar el OpenTelemetry SDK y registrar el global TracerProvider antes de añadir instrumentaciones al marco de su aplicación. Sin él, las operaciones de rastreo serán no-ops. Una vez que haya configurado el TracerProvider global, puede usar el instrumentor para el marco de la aplicación. El ejemplo siguiente muestra una aplicación de 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()
        

El SDK de Python de X-Ray rastrea la solicitud del cliente del AWS SDK parcheando la botocore biblioteca. Para obtener más información, consulta Rastrear las llamadas AWS del SDK con el SDK de X-Ray para Python. En la aplicación, el método patch_all() se utiliza para instrumentar todas las bibliotecas o aplicar parches de forma selectiva mediante las bibliotecas de botocore o boto3 que utilizan patch((['botocore'])). Cualquiera de los métodos elegidos instrumenta todos los clientes de Boto3 de la aplicación y genera un subsegmento para cualquier llamada realizada con estos clientes.

Para el ejemplo de código siguiente, necesitará la siguiente dependencia:

pip install opentelemetry-instrumentation-botocore
        

Utilice la instrumentación de OpenTelemetry Botocore mediante programación para instrumentar todos los clientes de Boto3 de su aplicación. En el ejemplo siguiente se muestra la instrumentación de 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}")
        

El X-Ray Python SDK rastrea las llamadas a HTTP salientes a través de solicitudes parcheando la biblioteca de solicitudes. Para obtener más información, consulte Rastreo de llamadas a servicios web HTTP posteriores con el X-Ray SDK para Python. En la aplicación, puede usar el método patch_all() para instrumentar todas las bibliotecas o aplicar parches de forma selectiva a las bibliotecas de solicitudes mediante patch((['requests'])). Cualquiera de las opciones instrumenta la biblioteca de requests y genera un subsegmento para cualquier llamada realizada a través de requests.

Para el ejemplo de código siguiente, necesitará la siguiente dependencia:

pip install opentelemetry-instrumentation-requests
        

Utilice la instrumentación de OpenTelemetry solicitudes mediante programación para instrumentar la biblioteca de solicitudes a fin de generar un seguimiento de las solicitudes HTTP que realice en su aplicación. Para obtener más información, consulta OpenTelemetry la sección Instrumentación de solicitudes. En el ejemplo siguiente se muestra la instrumentación de la biblioteca de requests.

from opentelemetry.instrumentation.requests import RequestsInstrumentor

# Instrument Requests
RequestsInstrumentor().instrument()

...

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

Otra opción, también puede instrumentar la biblioteca de urllib3 subyacente para rastrear las solicitudes 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")