timing-asgi：为你的Python ASGI应用添加计时中间件

timing-asgi：为你的Python ASGI应用添加计时中间件

项目介绍

timing-asgi是一个针对ASGI的应用的计时中间件，旨在自动化监控ASGI端点的性能。它最初由GRID公司开发，并用于其基于Python和ASGI框架Starlette构建的后端服务，与云监控服务如Datadog集成，提供statsd基础的度量统计。

项目技术分析

该库支持ASGI3标准，通过安装pip install timing-asgi即可轻松部署。TimingMiddleware是核心组件，它可以插入到ASGI应用程序中，记录每个请求处理的时间，并将这些数据暴露给TimingClient。TimingClient可以定制化以满足不同的数据收集需求，例如在上述示例中，数据被打印到控制台，但在实际生产环境中，可能会发送到像Datadog这样的监控系统。

timing-asgi还提供了诸如StarletteScopeToName这样的工具，它们可以帮助转换ASGI范围信息到可读的指标名称，以便更好地理解并分析数据。

项目及技术应用场景

• Web应用性能监测：对于任何基于ASGI（如FastAPI或Quart）构建的高性能Python Web服务，timing-asgi能帮助开发者实时了解HTTP请求的响应时间，从而优化代码性能。
• 故障排查：当遇到性能下降或异常问题时，通过查看计时数据，可以快速定位潜在的问题点。
• 持续集成/持续交付(CI/CD)：在自动化测试阶段，可以利用这些度量来确保新代码引入的改动没有导致性能退步。

项目特点

• 轻量级：设计简洁，易于集成到现有的ASGI应用中，无需大量额外的依赖。
• 高度可定制：可以自定义TimingClient以适应不同的监控解决方案，如Prometheus、Elasticsearch或其他日志系统。
• 灵活的指标命名：允许通过metric_namer参数设置如何转换ASGI范围信息为有意义的指标名称。
• 兼容性：虽然主要面向ASGI3，但对ASGI2的支持也在旧版本中得到维护。

使用示例

以下是一个简单的使用timing-asgi的例子：

import uvicorn
from starlette.applications import Starlette
from starlette.responses import PlainTextResponse
from timing_asgi import TimingMiddleware, TimingClient
from timing_asgi.integrations import StarletteScopeToName

app = Starlette()

@app.route("/")
async def homepage(request):
    return PlainTextResponse("hello world")

app.add_middleware(
    TimingMiddleware,
    client=PrintTimings(),  # 自定义类，实现数据处理
    metric_namer=StarletteScopeToName(prefix="myapp", starlette_app=app)
)

if __name__ == "__main__":
    uvicorn.run(app)

运行这个例子，你可以看到每个请求处理的时间被打印出来，这对于跟踪性能非常有帮助。

总结，如果你正在寻找一个简单而强大的工具来监控你的ASGI应用的性能，那么timing-asgi无疑是一个值得尝试的选择。立即安装并体验它带来的好处吧！