Migrasi ke Python OpenTelemetry

pip install aws-xray-sdk
        

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

Dalam X-Ray, global xray_recorder diinisialisasi dan digunakan untuk menghasilkan segmen dan sub-segmen.

Di OpenTelemetry, Anda perlu menginisialisasi globalTracerProvider. Dengan menggunakan iniTracerProvider, Anda dapat memperoleh Tracer yang dapat Anda gunakan untuk menghasilkan rentang di mana saja di aplikasi Anda. Disarankan agar Anda mengkonfigurasi komponen-komponen berikut:

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 mendukung kerangka aplikasi seperti Django, Flask, dan Bottle dalam menelusuri permintaan masuk untuk aplikasi Python yang berjalan pada mereka. Ini dilakukan dengan menambahkan aplikasi XRayMiddleware untuk setiap kerangka kerja.

OpenTelemetry menyediakan instrumentasi untuk Django dan Flask melalui pustaka instrumentasi tertentu. Tidak ada instrumentasi untuk Botol yang tersedia di OpenTelemetry, aplikasi masih dapat dilacak dengan menggunakan Instrumentasi OpenTelemetry WSGI.

Untuk contoh kode berikut, Anda memerlukan ketergantungan berikut:

pip install opentelemetry-instrumentation-flask
        

Anda harus menginisialisasi OpenTelemetry SDK dan mendaftarkan global TracerProvider sebelum menambahkan instrumentasi untuk kerangka kerja aplikasi Anda. Tanpa itu, operasi jejak akan terjadino-ops. Setelah Anda mengonfigurasi globalTracerProvider, Anda dapat menggunakan instrumentor untuk kerangka kerja aplikasi Anda. Contoh berikut menunjukkan aplikasi 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 melacak permintaan klien AWS SDK dengan menambal perpustakaan. botocore Untuk informasi selengkapnya, lihat Menelusuri panggilan AWS SDK dengan X-Ray SDK untuk Python. Dalam aplikasi Anda, patch_all() metode ini digunakan untuk instrumen semua pustaka atau patch selektif menggunakan pustaka atau menggunakan boto3 pustaka. botocore patch((['botocore'])) Salah satu metode yang dipilih menginstrumentasikan semua klien Boto3 dalam aplikasi Anda dan menghasilkan sub-segmen untuk setiap panggilan yang dilakukan menggunakan klien ini.

Untuk contoh kode berikut, Anda memerlukan ketergantungan berikut:

pip install opentelemetry-instrumentation-botocore
        

Gunakan OpenTelemetry Botocore Instrumentation secara terprogram untuk instrumen semua klien Boto3 dalam aplikasi Anda. Contoh berikut menunjukkan botocore instrumentasi.

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 melacak panggilan HTTP keluar melalui permintaan dengan menambal perpustakaan permintaan. Untuk informasi selengkapnya, lihat Menelusuri panggilan ke layanan web HTTP hilir menggunakan X-Ray SDK untuk Python. Dalam aplikasi Anda, Anda dapat menggunakan patch_all() metode ini untuk menginstrumentasi semua pustaka atau dengan menambal pustaka permintaan secara selektif dengan menggunakan. patch((['requests'])) Salah satu opsi instrumen requests perpustakaan, menghasilkan sub-segmen untuk setiap panggilan yang dilakukan. requests

Untuk contoh kode berikut, Anda memerlukan ketergantungan berikut:

pip install opentelemetry-instrumentation-requests
        

Gunakan Instrumentasi OpenTelemetry Permintaan secara terprogram untuk menginstrumentasikan pustaka permintaan untuk menghasilkan jejak permintaan HTTP yang dibuat olehnya dalam aplikasi Anda. Untuk informasi selengkapnya, lihat OpenTelemetry permintaan Instrumentasi. Contoh berikut menunjukkan instrumentasi requests perpustakaan.

from opentelemetry.instrumentation.requests import RequestsInstrumentor

# Instrument Requests
RequestsInstrumentor().instrument()

...

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

Atau, Anda juga dapat menginstruksikan urllib3 pustaka yang mendasarinya untuk melacak permintaan 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")