如何在Uvicorn中集成OpenTelemetry

冬丽小哥_2331

冬丽小哥_2331

2026-11-21

656人浏览

原创

Uvicorn本身不支持OpenTelemetry自动埋点,必须在uvicorn.run()前完成FastAPIInstrumentor.instrument_app(app)和TracerProvider初始化,否则Span静默丢弃;跨服务调用须用instrumented异步客户端(如httpx.AsyncClient+HTTPXClientInstrumentor),且Nginx等网关需透传traceparent头。

如何在uvicorn中集成opentelemetry

Uvicorn 本身不直接支持 OpenTelemetry 自动埋点,必须通过 FastAPI(或其他 ASGI 框架)层接入,且关键动作必须在 uvicorn.run() 之前完成——否则所有 Span 静默丢弃。

FastAPIInstrumentor.instrument_app() 必须在 uvicorn.run() 前调用

Uvicorn 只是 ASGI 服务器,它不参与 Span 创建;真正生成入口 Span 的是 FastAPIInstrumentor 对路由中间件的注入。如果把 instrument_app() 放在 uvicorn.run() 后面,或者放在异步启动逻辑里(比如 asyncio.run() 内部),instrumentation 就不会生效。

  • ✅ 正确顺序:app = FastAPI() → FastAPIInstrumentor.instrument_app(app) → uvicorn.run(app, ...)
  • ❌ 错误写法:在 if __name__ == "__main__": 块里先 uvicorn.run(),再调 instrument —— 此时 app 已被封装,instrument 失效
  • ⚠️ 注意:instrument_app() 不抛异常,失败时仅静默跳过,需靠日志或手动检查 request.headers.get("traceparent") 是否存在来验证

TracerProvider 必须提前初始化并绑定 Resource

OpenTelemetry SDK 要求全局 TracerProvider 在任何 get_tracer() 调用前就位,否则返回空 tracer,Span 全部丢失。只装包、不设 provider 是最常见断链原因。

  • 必须显式创建:TracerProvider(resource=Resource.create({SERVICE_NAME: "my-service"}))
  • 必须绑定导出器:用 BatchSpanProcessor(非 SimpleSpanProcessor),否则压测时主线程阻塞、超时频发
  • 示例片段:
    from opentelemetry import trace
    from opentelemetry.sdk.trace import TracerProvider
    from opentelemetry.sdk.resources import Resource
    from opentelemetry.exporter.jaeger.thrift import JaegerExporter
    from opentelemetry.sdk.trace.export import BatchSpanProcessor
    
    resource = Resource.create({SERVICE_NAME: "user-api"})
    provider = TracerProvider(resource=resource)
    processor = BatchSpanProcessor(JaegerExporter())
    provider.add_span_processor(processor)
    trace.set_tracer_provider(provider)

跨服务 HTTP 调用必须用 instrumented 异步客户端

FastAPI 路由内若用 httpx.get() 或 requests.get() 发起下游请求,traceparent 头不会自动注入,链路在第一跳就断裂。Uvicorn 的异步特性决定了必须用 httpx.AsyncClient + 对应插桩器。

Uvicorn 0.52.1
Uvicorn 0.52.1

Uvicorn 0.52.1 是 Python ASGI Web 服务器,提供异步应用服务及 WebSocket 支持,常用于 FastAPI、Starlette 等应用的开发和部署。本下载为官方 PyPI 通用 wheel 包,可使用 pip 安装,并由包管理器处理所需依赖。

下载
  • ✅ 必须安装:opentelemetry-instrumentation-httpx
  • ✅ 必须调用:HTTPXClientInstrumentor().instrument()(在 uvicorn.run() 前)
  • ❌ 禁用:httpx.Client(同步)、aiohttp(除非额外调用 AIOHttpClientInstrumentor().instrument())
  • 验证方式:在路由中打印 request.headers.get("traceparent"),上游有值、下游服务入口也应能读到

别让 Nginx 或网关吃掉 traceparent 头

即使代码全配对,如果前端有 Nginx、Kong 或 API 网关,它们默认可能过滤或重写 traceparent 和 tracestate。这些头必须透传,且大小写敏感(W3C 规范要求小写)。

  • Nginx 示例配置:proxy_pass_request_headers on; + 显式放行:proxy_set_header traceparent $http_traceparent;
  • Kubernetes Ingress:确认 annotation 中未设置 nginx.ingress.kubernetes.io/configuration-snippet 删除了自定义 header
  • Jaeger UI 查不到 Span?优先查下游服务是否收到 traceparent,而不是怀疑 exporter 配置

最容易被忽略的是:Uvicorn 进程启动后,instrumentation 就已冻结;任何后续的 provider 设置、instrument 调用都无效。所有初始化必须在 uvicorn.run() 之前一次性完成,且顺序不可颠倒。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

uvicorn

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1971

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

5624

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1909

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

34517

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

4027

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

4027

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1303

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

636

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

3143

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方部署指南
Uvicorn官方部署指南

共0课时 | 0人学习

Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习