Migrar para Python OpenTelemetry

pip install aws-xray-sdk
        

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

No X-Ray, o xray_recorder global é inicializado e usado para gerar segmentos e subsegmentos.

Em OpenTelemetry, você precisa inicializar um globalTracerProvider. Ao usar este TracerProvider, você pode adquirir um Rastreador que pode ser usado para gerar extensões em qualquer lugar da sua aplicação. É recomendável configurar os seguintes 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
          

O SDK Python do X-Ray é compatível com estruturas de aplicações como Django, Flask e Bottle no rastreamento de solicitações recebidas de aplicações Python executadas nelas. Para fazer isso, adicione XRayMiddleware à aplicação de cada estrutura.

OpenTelemetry fornece instrumentações para Django e Flask por meio de bibliotecas de instrumentação específicas. Não há instrumentação para Bottle disponível em OpenTelemetry, as aplicações ainda podem ser rastreadas usando a instrumentação WSGI. OpenTelemetry

Para o exemplo de código a seguir, você precisa da seguinte dependência:

pip install opentelemetry-instrumentation-flask
        

Você deve inicializar o OpenTelemetry SDK e registrar o global TracerProvider antes de adicionar instrumentações à estrutura do seu aplicativo. Sem isso, as operações de rastreamento serão no-ops. Após configurar o TracerProvider global, você pode usar o instrumentor para sua estrutura de aplicações. O exemplo a seguir demonstra um aplicativo 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()
        

O X-Ray Python SDK rastreia a solicitação do cliente AWS SDK aplicando patches na biblioteca. botocore Para obter mais informações, consulte Rastreando chamadas do AWS SDK com o X-Ray SDK para Python. Na sua aplicação, o método patch_all() é usado para instrumentar todas as bibliotecas ou corrigir seletivamente usando as bibliotecas botocore ou boto3 com patch((['botocore'])). Qualquer um dos métodos escolhidos instrumenta todos os clientes do Boto3 na sua aplicação e gera um subsegmento para qualquer chamada feita usando esses clientes.

Para o exemplo de código a seguir, você precisará da seguinte dependência:

pip install opentelemetry-instrumentation-botocore
        

Use a instrumentação OpenTelemetry Botocore programaticamente para instrumentar todos os clientes do Boto3 em seu aplicativo. Os exemplos a seguir demonstram a instrumentação do 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}")
        

O X-Ray Python SDK rastreia chamadas HTTP de saída por meio de solicitações corrigindo a biblioteca de solicitações. Para obter mais informações, consulte Rastrear chamadas para serviços web HTTP downstream usando o SDK do X-Ray para Python. Na sua aplicação, você pode usar o método patch_all() para instrumentar todas as bibliotecas ou corrigir seletivamente as bibliotecas de solicitações usando patch((['requests'])). Qualquer uma das opções instrumenta a biblioteca requests, gerando um subsegmento para qualquer chamada feita por meio de requests.

Para o exemplo de código a seguir, você precisará da seguinte dependência:

pip install opentelemetry-instrumentation-requests
        

Use a Instrumentação de OpenTelemetry Solicitações programaticamente para instrumentar a biblioteca de solicitações para gerar rastreamentos para solicitações HTTP feitas por ela em seu aplicativo. Para obter mais informações, consulte OpenTelemetry solicitações de instrumentação. O exemplo a seguir demonstra a instrumentação da biblioteca requests.

from opentelemetry.instrumentation.requests import RequestsInstrumentor

# Instrument Requests
RequestsInstrumentor().instrument()

...

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

Como alternativa, você também pode instrumentar a biblioteca urllib3 subjacente para rastrear solicitações 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")