工程开发
create-evlog-framework-integration avatar

create-evlog-framework-integration

添加 evlog 框架集成:通过标准化中间件、构建配置、测试与文档,实现全栈自动化广域事件日志记录。

简介

此技能为将 evlog 可观测性框架扩展至新的 HTTP 框架(如 Hono、Elysia、Fastify、Express 或 NestJS)提供了一套系统化的蓝图。它专为希望通过将零散的日志输出转化为结构化、请求范围内的广域事件来统一日志策略的软件工程师与维护者而设计。通过遵循这 16 个步骤的整合流程,您可以确保每个新的框架支持包都能继承 evlog 的核心优势:自动请求追踪、结构化错误处理、性能遥测以及与日志导入管线的无缝整合。

  • 实现 createMiddlewareLogger 工具,以处理完整的请求生命周期,包括增强、过滤与异步日志排空。

  • 标准化框架专用的胶水代码,用于上下文注入、头部解析(支持 Web API 与 Node.js 格式)以及错误元数据附加。

  • 在 tsdown.config.ts 与 package.json 中纳入全面的构建系统更新,以确保正确的 ESM/CJS 输出与对等依赖管理。

  • 提供强大的测试架构,利用标准辅助工具来监控排空调用、断言敏感头部过滤并验证广域事件结构。

  • 促进端到端的文档覆盖,自动更新落地页、安装指南、功能表与框架特定的使用示例。

  • 整合流程由 16 点检查清单严格定义,要求手动验证源代码、构建配置、文档与示例应用程序。

  • 所有整合必须利用 shared/middleware、shared/headers 与 shared/storage 工具,以防止逻辑重复并维持一致的可观测性模式。

  • 预期输入包括在 packages/evlog/src 下的新目录、apps/docs/content 中的更新文档,以及一个用于在实际环境中展示功能的新示例应用程序。

  • 输出包含一个生产就绪的框架适配器、语义版本控制变更集,以及更新的工作流程模板(semantic-pull-request)以支持自动化 CI/CD。

  • 此工作流程通过框架特定的模块扩充强化类型安全,确保 useLogger() 上下文能在框架的处理器生态系统中正确访问与定义类型。

仓库统计

Star 数
1,210
Fork 数
36
Open Issue 数
12
主要语言
TypeScript
默认分支
main
同步状态
空闲
最近同步时间
2026年5月1日 08:47
在 GitHub 查看