用途
本技能是一份综合性日志实践指南,目标是在应用开发中实现结构化、安全且性能良好的日志,覆盖日志级别、结构化日志格式、上下文信息、PII 保护以及集中式日志系统等主题。
主要能力
资料列出的能力主题包括:日志级别(Log Levels)、结构化日志(JSON)、上下文日志(Contextual Logging)、PII 与敏感数据处理、性能日志、集中式日志、分布式追踪、日志采样(面向高流量服务)。
同时提供了快速上手示例:以 TypeScript 定义 LogLevel 枚举(DEBUG=0、INFO=1、WARN=2、ERROR=3、FATAL=4),并实现一个带最小级别(默认 INFO)的 Logger 类,含 debug、info、warn 等方法,按最小级别过滤输出。示例代码在资料中未完整给出(标注为 see reference guides for full implementation)。
使用方式
资料给出“When to Use”场景清单,包括:搭建应用日志基础设施、实现结构化日志、为不同环境配置日志级别、管理日志中的敏感数据、搭建集中式日志、实现分布式追踪、调试生产问题、满足日志合规要求。
详细实现分散在 references/ 目录下的参考指南中,按上表主题分别展开。资料未提供具体安装命令或接入步骤,暂未提供。
最佳实践
应做(DO):生产环境使用结构化日志(JSON);所有日志包含 correlation/request ID;使用恰当的日志级别(不过度使用 DEBUG);对敏感数据(PII、密码、令牌)进行脱敏;包含上下文(userId、requestId 等);记录错误时带完整堆栈;分布式系统使用集中式日志;设置日志轮转管理磁盘空间;监控日志量与成本;使用异步日志提升性能;时间戳采用 ISO 8601 格式;记录业务事件(用户操作、交易);为错误模式设置告警。
不应做(DON'T):记录密码、令牌或敏感数据;生产环境使用 console.log;默认在生产环境使用 DEBUG 级别;在紧密循环中记录日志(应使用采样);未经匿名化包含 PII;忽视日志轮转(磁盘会被写满);在热路径中使用同步日志;无必要地写入多个传输目标;忘记包含错误堆栈;记录二进制数据或大对象;使用字符串拼接(应使用结构化字段);在高流量 API 中记录每一个请求。
适用场景与限制
适用场景为各类需要规范日志的应用开发与运维场景。资料未说明具体支持的编程语言范围、依赖要求、许可证或收费信息,暂未提供。