SuperAPI AI 工具集

awesome-logging-standards

通用与其它

查看项目

更新于 10-15 23:45

技能介绍

用途:为项目应用一致的日志规范,使运维可调试、可合规,同时避免泄露密钥或 PII。适用于新增或重构日志语句、用户询问日志格式或该记录什么、制定或审查项目日志标准、以及事故后发现日志不足或泄露数据之后。

主要能力:定义日志级别(ERROR 失败与异常、WARN 可恢复问题与弃用、INFO 关键业务事件与请求摘要、DEBUG 详细流程,生产环境禁用或采样);结构化输出,优先使用键值字段(如 JSON)而非长文本,全应用统一结构(timestamp、level、message、fields);上下文包含 request_id、trace_id 或 correlation_id,仅在安全且策略允许时包含 user_id、order_id;禁止记录密码、令牌、API 密钥或完整卡号,需脱敏或省略;路径写入前先清洗,去掉查询串,将携带令牌、邮箱等个人标识的路径段替换为路由模板(/users/:id),必要时掩码客户端 IP;区分审计日志与应用日志,各自保留期与访问权限。

使用方式:先检查项目现有实践(格式、库、级别)并保持一致;选择合适级别;添加请求 id、操作名、耗时、状态等上下文;脱敏;验证日志输出到 stdout 或配置的 sink、格式可解析、样本中无密钥与 PII。请求驱动服务推荐宽事件:由中间件创建事件并负责计时、状态与发送(在 finally 中发送以保证失败也产生事件),处理器只追加业务字段,每个事件包含 commit hash、服务版本、区域等环境字段。

限制与注意:不要记录完整请求/响应或环境变量;不要用无界值(user_id、email、完整 URL、原始错误文本)作为指标/标签键,以免基数爆炸;不要用 console.log 替代项目日志库;不要引入第二套日志系统;若项目有日志或隐私政策(保留期、PII、密钥),须遵循。资料未提供具体库的安装命令或代码示例之外的实现细节。