如何为 FastAPI 路由设置 OpenTelemetry span 属性？

Question

将标记添加到跟踪的跨度对于以后分析跟踪数据并按所需标记对其进行切片和切块非常有用。

阅读 OpenTelemetry docs 后，我想不出将自定义标签添加到跨度的方法。

这是我的示例 FastAPI 应用程序，已经使用 OpenTelemetry 进行了检测：

"""main.py"""
from typing import Dict

import fastapi

from opentelemetry import trace
from opentelemetry.sdk.trace.export import (
    ConsoleSpanExporter,
    SimpleExportSpanProcessor,
)
from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor
from opentelemetry.sdk.trace import TracerProvider


trace.set_tracer_provider(TracerProvider())
trace.get_tracer_provider().add_span_processor(SimpleExportSpanProcessor(ConsoleSpanExporter()))


app = fastapi.FastAPI()


@app.get("/user/{id}")
async def get_user(id: int) -> Dict[str, str]:
    """Test endpoint."""
    return {"message": "hello user!"}


FastAPIInstrumentor.instrument_app(app)

你可以运行它与 uvicorn main:app --reload

如何将用户 ID 添加到跨度中？

Answer 1

在阅读了 ASGI instrumentation 的 OpenTelemetryMiddleware (here) 的源代码后，我意识到你可以简单地获取当前 span，设置标签（或属性），当前 span 将与所有返回它的属性。

@app.get("/user/{id}")
async def get_user(id: int) -> Dict[str, str]:
    """Test endpoint."""
    # Instrument the user id as a span tag
    current_span = trace.get_current_span()
    if current_span:
        current_span.set_attribute("user_id", id)

    return {"message": "hello user!"}

如何为 FastAPI 路由设置 OpenTelemetry span 属性？

How to set an OpenTelemetry span attribute for a FastAPI route?

telemetry

fastapi

open-telemetry