Starlette如何记录请求日志

老丽吖_6144

老丽吖_6144

2026-11-20

501人浏览

原创

starlette 记录请求日志的标准做法是注册一个中间件,在请求进入应用前记录时间戳和元数据,并在响应返回后计算耗时并输出日志。具体实现时,需要继承 starlette.middleware.base.basehttpmiddleware 或实现 asgiapp 协议,通过调用 await call_next(request) 获取响应对象,随后使用 python 标准库的 logging 模块将请求方法、路径、状态码及处理时长写入日志文件。这样做能确保所有经过该应用的请求都被统一捕获,且不会侵入业务逻辑代码。

Starlette如何记录请求日志

如何自定义中间件以捕获请求详情

要实现这一功能,开发者需创建一个类并重写 async __call__ 方法。在该方法中,先记录当前时间,然后调用 super().__call__(scope, receive, send) 执行后续逻辑,最后记录结束时间并格式化输出日志信息。关键在于使用 logging.getLogger(__name__).info() 来生成结构化日志,便于后续分析。

Starlette如何记录请求日志

import logging
import time
from starlette.middleware.base import BaseHTTPMiddleware
from starlette.requests import Request
from starlette.responses import Response

logger = logging.getLogger("starlette.access")

class AccessLogMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
        start_time = time.time()
        response = await call_next(request)
        process_time = time.time() - start_time
        logger.info(
            f"{request.method} {request.url.path} {response.status_code} {process_time:.4f}s"
        )
        return response

上述代码定义了一个名为 AccessLogMiddleware 的中间件。当应用启动时,通过 app.add_middleware(AccessLogMiddleware) 将其注册。对于每个请求,它会打印类似 GET /api/users 200 0.0123s 的日志行。若需更详细的日志,可加入 request.headers 中的用户代理或客户端 IP 地址。注意,call_next 必须被正确 await,否则响应无法完整返回。

如何处理异常导致的日志缺失

当请求在处理过程中抛出未捕获异常时,默认行为可能导致日志不完整或丢失。为解决此问题,应在中间件的 try...except 块中捕获异常,并记录错误堆栈。这样即使响应失败,也能保留完整的请求上下文信息,便于排查故障。

Starlette 1.5.1
Starlette 1.5.1

Starlette 1.5.1 是轻量级 Python ASGI 框架与工具集,提供路由、请求响应、中间件、WebSocket 和后台任务等组件,适合构建异步 Web 服务。本下载为官方 PyPI 通用 wheel 包,可使用 pip 安装,并由包管理器处理依赖;运行应用时还需配置 ASGI 服务器。

下载

Starlette如何记录请求日志

import traceback
import logging
import time
from starlette.middleware.base import BaseHTTPMiddleware
from starlette.requests import Request
from starlette.responses import JSONResponse

logger = logging.getLogger("starlette.error")

class ErrorLoggingMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
        try:
            start_time = time.time()
            response = await call_next(request)
            process_time = time.time() - start_time
            if response.status_code >= 400:
                logger.warning(
                    f"Error: {request.method} {request.url.path} {response.status_code} {process_time:.4f}s"
                )
            return response
        except Exception as e:
            process_time = time.time() - start_time
            logger.error(
                f"Exception: {request.method} {request.url.path} {process_time:.4f}s\n"
                + "".join(traceback.format_exception(type(e), e, e.__traceback__))
            )
            return JSONResponse(
                status_code=500,
                content={"detail": "Internal Server Error"}
            )

该中间件在捕获到异常时,会记录完整的堆栈跟踪信息,并返回一个标准的 500 错误响应。这确保了即使在系统崩溃边缘,关键诊断数据也不会丢失。开发者可根据需要调整日志级别,例如将 warning 改为 error 以区分严重性。此外,JSONResponse 的使用保证了 API 客户端收到合法的 JSON 格式错误响应,符合 RESTful 规范。

基于特定输入条件如何优化日志性能

在高并发场景下,频繁的文件 I/O 可能成为瓶颈。为优化性能,可采用异步日志记录器或批量写入策略。例如,使用 aiologger 库替代标准 logging,或在中间件中缓存日志条目,定期 flush 到磁盘。此外,可对高频路径设置采样率,避免重复记录相同模式的请求。

在实际应用中,若发现日志写入延迟影响响应时间,可考虑将日志发送至外部监控系统如 ELK 或 Prometheus,而非直接写入本地文件。这种架构分离能有效降低主线程阻塞风险,提升整体吞吐量。开发者应根据实际负载测试选择合适方案,平衡可观测性与系统性能。

相关文章

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

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

下载

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

相关专题

更多
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API

Python FastAPI 异步开发利用 async/await 关键字,通过定义异步视图函数、使用异步数据库库 (如 databases)、异步 HTTP 客户端 (如 httpx),并结合后台任务队列(如 Celery)和异步依赖项,实现高效的 I/O 密集型 API,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

2025.12.22

119

5

Python 微服务架构与 FastAPI 框架
Python 微服务架构与 FastAPI 框架

本专题系统讲解 Python 微服务架构设计与 FastAPI 框架应用,涵盖 FastAPI 的快速开发、路由与依赖注入、数据模型验证、API 文档自动生成、OAuth2 与 JWT 身份验证、异步支持、部署与扩展等。通过实际案例,帮助学习者掌握 使用 FastAPI 构建高效、可扩展的微服务应用,提高服务响应速度与系统可维护性。

2026.02.06

614

18

Python Web框架FastAPI 全栈开发教程合集
Python Web框架FastAPI 全栈开发教程合集

以 FastAPI 为核心,讲解现代 Python Web API 的高效开发方式,涵盖路由定义与路径参数/查询参数/请求体绑定、Pydantic 模型的数据校验与序列化、依赖注入(Depends)系统的分层设计、中间件与 CORS 配置、OAuth2 + JWT 认证流程、后台任务(BackgroundTasks)、WebSocket 实时通信、SQLAlchemy 异步 ORM 集成、自动生成 OpenAPI/Swagger 交互文

2026.05.09

796

23

Python FastAPI异步微服务与高性能接口设计
Python FastAPI异步微服务与高性能接口设计

本专题聚焦 Python FastAPI 框架在高性能接口与微服务开发中的应用,讲解异步请求处理、依赖注入机制、路由设计、数据库异步操作以及接口性能优化策略。结合实际项目案例,帮助开发者构建高并发、低延迟的现代化后端服务架构。

2026.06.16

699

12

Nginx CVE-2026-123007排查与防护指南
Nginx CVE-2026-123007排查与防护指南

Nginx HTTP/2漏洞该怎么修复?本专题围绕CVE-2026-123007,介绍安全版本升级、模块兼容检查和配置恢复方法,以及日志排查、权限设置等后续加固操作,方便你按实际部署情况查找对应教程。

2026.11.20

0

8

GoFrame框架Web开发与路由中间件
GoFrame框架Web开发与路由中间件

本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。

2026.11.17

20

15

GoFrame框架安装与gf命令行工具
GoFrame框架安装与gf命令行工具

本专题围绕GoFrame框架的安装与工具链配置展开,讲清Go版本要求、gf命令行的安装方式、代理镜像与依赖准备,说明项目初始化、热编译、交叉编译打包的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.17

60

15

GoFrame框架零基础入门
GoFrame框架零基础入门

本专题整理GoFrame框架的入门知识,从模块化设计理念、环境准备到跑通第一个Web服务,讲清目录分层、配置加载、日志与中间件的用法,并对比Gin、Go-Zero的差异,帮助Go开发者建立整体认知。

2026.11.17

80

15

SQLAlchemy 一对多关系怎么建立
SQLAlchemy 一对多关系怎么建立

SQLAlchemy 一对多关系怎么建立?本专题整理父子表外键、relationship 双向映射、关联查询、级联删除和加载优化等相关文章,帮助你理解并实现常见的 ORM 关系建模。

2026.11.17

20

10

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程