Skills Directory精选自 GitHub 的开源 Skills

observability-and-instrumentationcommit fe6f081SKILL.md · 监控与运维

可观测性与埋点

为代码加入结构化日志、RED/USE 指标、OpenTelemetry 链路追踪和基于症状的告警及运行手册,让生产行为可见、可诊断。

npx skills add addyosmani/agent-skills --skill observability-and-instrumentation
权限
  • read-repo
  • write-files
  • shell
  • network
兼容工具
Claude Code, Codex, Cursor, Copilot, Gemini CLI
GitHub
112.3k
来源
社区 · Addy Osmani
状态
扫描通过
许可证
MIT

核心规则

埋点之前先写下值班人员会问的问题,每个信号都必须回答其中之一。

执行阶段

  1. 阶段 01定义“正常工作”

    为功能写下 2 到 4 个值班时会问的问题,作为所有埋点的依据。

  2. 阶段 02日志与指标

    输出带稳定事件名和关联 ID 的 JSON 日志,不记录密钥和 PII;为端点和依赖加 RED 指标,标签保持低基数并用直方图。

  3. 阶段 03分布式追踪

    用 OpenTelemetry 自动埋点,只在关键工作单元加手动 span,并在每个异步边界传递上下文。

  4. 阶段 04告警与手册

    只对用户可感知的症状告警,分 page 和 ticket 两级,每条告警都链接到 docs/runbooks/ 下的运行手册。

  5. 阶段 05验证遥测本身

    在预发环境制造错误、发送测试流量、跟踪单个请求并试触发每条告警,确认输出正确。

权限说明(据 SKILL.md 整理)

能力是否需要说明
文件写入需要在代码中加入日志、指标、追踪初始化和告警规则,并在 docs/runbooks/ 下编写运行手册。
命令执行需要运行应用或测试以触发代码路径,检查实际的日志和指标输出。
网络外发不需要技能未要求代理调用外部 API;在预发环境和追踪界面中的检查作为验证清单描述。

SKILL.md 头部信息(YAML)

SKILL.md 头部信息(YAML)commit fe6f081
---
name: observability-and-instrumentation
description: Instruments code so production behavior is visible and diagnosable. Use when adding logging, metrics, tracing, or alerting. Use when shipping any feature that runs in production and you need evidence it works. Use when production issues are reported but you can't tell what happened from the available data.
---

相关技能

规则扫描无法覆盖所有风险,安装前请阅读此技能的 SKILL.md,确认权限后再使用。