SuperAPI AI 工具集

ln-627-observability-auditor

部署与运维

查看项目

更新于 10-15 12:07

技能介绍

用途

ln-627-observability-auditor 是一个专注于可观测性审计的 L3 Worker 技能,属于审计类别中的第 10 类(中等优先级)。其目标是审计日志、监控与可观测性实践,检查结构化日志、健康检查、指标采集、请求追踪和日志级别,并计算合规评分(X/10)。

主要能力

该技能执行五项检查:

  1. 结构化日志:通过 grep 查找 console.log(非结构化日志),检查是否使用合适的日志库(如 winston、pino、logrus、zap)。生产代码使用 console.log 判定为 MEDIUM,开发代码使用判定为 LOW。建议使用结构化日志库,工作量 M。
  2. 健康检查端点:通过 grep 查找 /health、/ready、/live 路由并检查 API 路由定义。缺少健康检查端点判定为 HIGH(监控盲区),建议添加 /health 端点,工作量 S。
  3. 指标采集:检查 Prometheus 客户端、StatsD、CloudWatch,grep 指标记录(histogram、counter)。无指标埋点判定为 MEDIUM,建议添加 Prometheus 指标,工作量 M。
  4. 请求追踪:检查日志中的关联 ID,验证追踪传播(OpenTelemetry、Zipkin)。无关联 ID 判定为 MEDIUM(分布式系统难以调试),建议添加请求 ID 中间件,工作量 M。
  5. 日志级别:检查日志库是否支持级别(info、warn、error、debug)并验证级别使用是否恰当。仅有错误日志判定为 LOW(可见性不足),建议添加 info/debug 日志,工作量 S。

使用方式

该技能接收 contextStore,其中包含技术栈、框架、代码库根目录和 output_dir。工作流程为:解析 context 与 output_dir;确定项目类型(Layer 2 预检)——Web 服务适用全部检查,CLI 工具不适用健康检查/探针,库则多数检查为可选,据此调整适用检查项;通过 grep 检查可观测性模式(Layer 1);按候选逐项进行上下文分析(Layer 2);收集确认的发现;计算评分;在内存中按模板构建完整 Markdown 报告,单次 Write 调用写入 {output_dir}/ln-627--global.md;返回最小摘要给协调器。

优先使用 hex-graph 处理追踪、调用路径或跨文件引用,优先使用 hex-line 进行本地代码读取。若 MCP 不可用、不支持或未索引,则回退到内置的 Read/Grep/Glob/Bash,并在报告中说明回退情况。

报告写入 {output_dir}/ln-627--global.md,类别为 "Observability",检查项为 structured_logging、health_endpoints、metrics_collection、request_tracing、log_levels。摘要按 audit_summary_contract.md 输出;在托管模式下调用方传入 runId 和 summaryArtifactPath,独立模式下 worker 自行生成运行范围的工件路径。当 summaryArtifactPath 缺失时,独立运行时摘要写入 .hex-skills/runtime-artifacts/runs/{run_id}/evaluation-worker/{worker}--{identifier}.json。

适用场景

适用于对代码库进行可观测性审计,尤其是 Web 服务、微服务架构(请求追踪尤为关键)以及需要评估日志、监控、健康检查合规性的项目。单块架构对请求追踪需求较低,库和 CLI 工具则相应减少检查项。

限制

该技能只报告不自动修复,不会注入日志或端点。检测需框架感知,根据项目技术栈调整模式(Node 用 winston/pino,Go 用 logrus/zap 等)。工作量估算:S = 小于 1 小时,M = 1-4 小时,L = 大于 4 小时。排除项:console.log 检测跳过测试文件,跳过仅开发用脚本。严重程度需结合上下文:生产代码中的 console.log 为 MEDIUM,开发工具中为 LOW。

完成定义

contextStore 已解析(技术栈、框架、output_dir);全部 5 项检查完成;发现项包含严重程度、位置、工作量和建议;按 audit_scoring.md 计算评分;报告以原子单次 Write 调用写入 {output_dir}/ln-627--global.md;摘要按契约写入。

版本:3.0.0,最后更新:2025-12-23。