SuperAPI AI 工具集

logging-sucks

设计与创作

查看项目

更新于 10-15 21:38

技能介绍

用途:设计或审查结构化应用日志,包括规范化的请求完成事件、关联(correlation)、脱敏与采样。适用于修改日志埋点,或对现有日志做审计。

主要能力与原则: 事件设计:先明确日志需要回答的事故问题。运行时能可靠发出时,优先为每个请求或任务设置一个规范完成事件,在执行过程中累积结果、耗时、关联信息与相关领域上下文。对可独立处理的失败、长时间运行的进度或必需的审计记录,保留独立事件,不强行合并为单一请求摘要。 字段:使用日志器自带的结构化字段与既有命名约定,包含稳定的事件名、严重级别、时间戳、服务与结果;复用平台已提供的元数据。在可用且合适时附加请求、trace 或任务标识。只保留能回答具体查询的字段,不追求字段数量。 关联:通过 HTTP、队列与异步任务,用运行时支持的机制传播关联标识,避免使用可能在并发请求间泄漏标识的可变全局上下文。 隐私与成本:对有用上下文采用允许列表,并在发出前脱敏。不要因为可得就序列化完整请求对象、凭据、Cookie、原始请求体、私有 URL 或个人数据。按产品数据政策与保留需求纳入允许的标识。限制事件大小,避免在紧密循环中打日志。 保留与采样:依据实际流量、预算与事故需求选择保留与采样策略。倾向保留错误和有诊断价值的慢请求,但不强制 100% 保留、VIP 追踪或固定成功采样率。需考虑崩溃或取消可能导致完成事件无法发出。

使用方式:做审计时,只报告有证据支撑的发现,不直接编辑;被要求修改埋点时,实施改动并检查受影响的成功、失败或并发路径,验证关联隔离、脱敏与发出行为,通过后停止可选验证。报告该改动支持的事故查询及仍存在的可见性缺口。不要仅为套用本技能模式而替换日志栈或重写无关调用点。

限制:具体事件 schema 或采样设计需参考 references/event-design.md;本资料未提供该文件内容、安装命令、平台支持范围与收费信息。