迁移到 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，你可以获得一个 Tracer，你可以用它在应用程序中的任何地方生成跨度。建议您配置以下组件：

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 提供工具。中没有适用于 Bottle 的工具 OpenTelemetry，仍然可以使用 OpenTelemetry WSGI Instrumention 来跟踪应用程序。

对于以下代码示例，您需要以下依赖关系：

pip install opentelemetry-instrumentation-flask
        

在为应用程序框架添加工具 TracerProvider 之前，必须初始化 OpenTelemetry SDK 并注册全局版本。没有它，追踪操作将是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 Amazon SDK 通过修补botocore库来跟踪 SDK 客户端请求。有关更多信息，请参阅使用适用于 Python 的 X-Ray SD Amazon K 追踪 SDK 调用。在您的应用程序中，该patch_all()方法用于使用或库来检测所有库或有选择地botocore进行修补。boto3 patch((['botocore']))任何选定的方法都会检测应用程序中的所有 Boto3 客户端，并为使用这些客户端进行的任何调用生成子分段。

对于以下代码示例，您将需要以下依赖关系：

pip install opentelemetry-instrumentation-botocore
        

以编程方式使用 OpenTelemetry Botocore Instrumenting 来检测应用程序中的所有 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 通过修补请求库来通过请求跟踪传出的 HTTP 调用。有关更多信息，请参阅使用适用于 Python 的 X-Ray SDK 跟踪对下游 HTTP 网络服务的调用。在您的应用程序中，您可以使用patch_all()方法对所有库进行检测，也可以使用选择性地修补请求库。patch((['requests']))任何一个选项都会对requests库进行乐器，为通过requests的任何呼叫生成一个子分段。

对于以下代码示例，您将需要以下依赖关系：

pip install opentelemetry-instrumentation-requests
        

以编程方式使用 Requests Instruction 来检测 OpenTelemetry 请求库，为其在应用程序中发出的 HTTP 请求生成跟踪。有关更多信息，请参阅OpenTelemetry 请求检测。以下示例演示了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")