agilelabs-fx-docs main topics/logging-and-diagnostics.md

日志与诊断

本页聚合日志策略、诊断入口、运行期定位与问题排查入口。

适用场景

  • 生产环境问题排查。
  • 请求链路、错误定位、WorkContext 与 Activity 追踪。
  • 诊断端点和后台管理入口保护。

必须遵守

  • 诊断页与后台入口必须受认证或网络边界保护。
  • 错误响应与日志职责分离:客户端拿规范化错误,详细信息进日志。
  • 非 HTTP 执行流也要建立可追踪的上下文。

推荐做法

  • 在 WebAPI 场景中统一异常处理与日志输出。
  • 利用 WorkContext、Activity、请求会话信息对齐 TraceId。
  • 发布前检查 /fwdev/req_stat/jobs 暴露范围。

常见坑

  • 在错误响应里直接暴露完整堆栈。
  • 后台任务没有建立上下文,导致日志链路断裂。
  • 诊断端点默认裸露到公网。

真实用例

  • niusys-webapi:异常过滤器、/jobs 鉴权、Swagger 对齐。
  • woscm:项目级异常处理器、TraceId 回写、公共管道中间件。

相关页面