Observability

Observability Assistant | 可觀測性助手

Language: English | 繁體中文

Version: 1.0.0 Last Updated: 2026-06-19 Applicability: Claude Code Skills

Core Standard: This skill implements Observability Standards. For the authoritative methodology (full Metrics/Traces detail, sampling, OTel integration), refer to the core standard.

Guide observability implementation across the three pillars: Logs, Metrics, and Traces.

引導三支柱可觀測性實作：Logs、Metrics、Traces。

Capabilities | 功能

Usage | 使用方式

/observability                        # Show observability guide
/observability --checklist            # Run instrumentation checklist
/observability --maturity             # Maturity assessment (L0-L4)
/observability --alerting             # Alert design guide
/observability "payment-service"      # Guide for specific service

Three Pillars Framework | 三支柱框架

Each pillar gives a different lens; their power is in correlation.

Correlation fields: trace_id links Logs ↔ Traces ↔ Metrics (via Exemplars); service.name filters all three pillars. Workflow: metric anomaly → exemplar → trace → trace_id in logs.

Golden Signals | 四大黃金信號

Based on Google SRE. Every service SHOULD monitor all four before production.

Metric Types | Metric 型別

Naming: <domain>.<entity>.<action>.<unit> in snake_case (e.g. db.client.query.duration.seconds). Label cardinality: keep labels under ~1000 unique values — never use user_id / request_id / raw url / ip as labels; record those in Logs or Traces instead.

Maturity Model (L0–L4) | 成熟度模型

Self-check: find logs for one request across services (L1+) → dashboards of error rate & latency (L2+) → trace request ingress→DB→back (L3+) → auto-detect anomalies before users report (L4).

Instrumentation Checklist | 上線前檢查表

Before deploying a service to production:

• Structured logging — JSON with trace_id correlation
• HTTP/gRPC entry metrics — request count, duration histogram, error rate per endpoint
• Business operation metrics — key events tracked (orders, payments)
• Distributed tracing — span propagation, sampling rate, W3C Trace Context headers
• Health checks — liveness (running?) and readiness (can serve?) probes
• Golden Signals dashboard — Latency, Traffic, Errors, Saturation visualized
• Alert rules — at minimum SLO burn-rate alerts
• Log retention — policies set per log level
• Sensitive data excluded — no passwords, tokens, or PII in logs/traces

Next Steps Guidance | 下一步引導

可觀測性引導完成。建議下一步：

• 執行 /slo 定義 SLI/SLO/Error Budget ⭐ 推薦
• 執行 /incident 設定事故回應流程
• 執行 /checkin 提交變更

Reference | 參考

• Detailed guide: guide.md — the three pillars (logs, metrics, traces) in depth. Read it when setting up monitoring, choosing metric types, implementing tracing, or assessing maturity.
• Core standard: observability-standards.md
• Core standard: alerting-standards.md
• Core standard: slo-standards.md