关于 observability-sre
Observability & Site Reliability Engineering 是面向服务设计与运维人员的可观测性和可靠性参考技能,涵盖指标、日志、追踪、SLO、告警及事件处理,并提供实现示例。
主要功能
- 01指标、日志与追踪指南
- 02基于用户症状的告警原则
- 03SLO 与错误预算实践
- 04追踪上下文与结构化日志
- 05Prometheus 和 OpenTelemetry 示例
适用场景
- 01定义服务 SLO 和错误预算
- 02设计面向症状的生产告警
- 03关联日志与分布式追踪
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ majiayu000/ spellbook --skill observability-sre安装后在 Claude Code 中输入/observability-sre确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
reference/extended.mdincident-response.mdlogging.mdmonitoring.mdtracing.mdtemplates/slo-template.md详细介绍
可观测性与站点可靠性工程
核心原则
- 三大支柱 — 指标、日志和追踪提供全面的可见性
- 可观测性优先 — 构建能够解释自身行为的系统
- SLO 驱动 — 定义对用户有意义的可靠性目标
- 主动检测 — 在客户发现问题之前找到问题
- 无责文化 — 从故障中学习,而不追究责任
- 自动化繁琐工作 — 减少重复性的运维工作
- 持续改进 — 每次事故都会让系统更具韧性
- 全栈可见性 — 从基础设施到业务指标进行监控
硬性规则(必须遵守)
这些规则是强制性的。违反这些规则意味着此技能未能正常工作。
仅针对症状发出告警
针对面向用户的症状发出告警,而不是针对内部基础设施指标。
# ❌ FORBIDDEN: Alerting on internal metrics
- alert: CPUHigh
expr: cpu_usage > 70%
# Users don't care about CPU, they care about latency
- alert: MemoryHigh
expr: memory_usage > 80%
# Internal metric, may not affect users
# ✅ REQUIRED: Alert on user experience
- alert: APILatencyHigh
expr: slo:api_latency:p95 > 0.200
annotations:
summary: "Users experiencing slow response times"
- alert: ErrorRateHigh
expr: slo:api_errors:rate5m > 0.001
annotations:
summary: "Users encountering errors"
低基数标签
Loki/Prometheus 标签必须保持低基数(少于 10 个唯一标签)。
# ❌ FORBIDDEN: High cardinality labels
labels:
user_id: "usr_123" # Millions of values!
order_id: "ord_456" # Millions of values!
request_id: "req_789" # Every request is unique!
# ✅ REQUIRED: Low cardinality only
labels:
namespace: "production" # Few values
app: "api-server" # Few values
level: "error" # 5-6 values
method: "GET" # ~10 values
# High cardinality data goes in log body:
logger.info({
user_id: "usr_123", # In JSON body, not label
order_id: "ord_456",
}, "Order processed");
基于 SLO 的错误预算
每项服务都必须定义 SLO,并跟踪错误预算。
# ❌ FORBIDDEN: No SLO definition
# Just monitoring without targets
# ✅ REQUIRED: Explicit SLO with budget
# SLO: 99.9% availability
# Error Budget: 0.1% = 43.2 minutes/month downtime
groups:
- name: slo_tracking
rules:
- record: slo:api_availability:ratio
expr: sum(rate(http_requests_total{status!~"5.."}[5m])) / sum(rate(http_requests_total[5m]))
- alert: ErrorBudgetBurnRate
expr: slo:api_availability:ratio < 0.999
for: 5m
annotations:
summary: "Burning error budget too fast"
日志中的追踪上下文
所有日志都必须包含 trace_id,以便与分布式追踪进行关联。
// ❌ FORBIDDEN: Logs without trace context
logger.info("Payment processed");
// ✅ REQUIRED: Include trace_id in every log
const span = trace.getActiveSpan();
logger.info({
trace_id: span?.spanContext().traceId,
span_id: span?.spanContext().spanId,
order_id: "ord_123",
}, "Payment processed");
// Output includes correlation:
// {"trace_id":"abc123","span_id":"def456","order_id":"ord_123","msg":"Payment processed"}
快速参考
何时使用什么
| 场景 | 工具/模式 | 原因 |
|---|---|---|
| 指标采集 | Prometheus + Grafana | 行业标准,查询语言功能强大 |
| 分布式追踪 | OpenTelemetry + Tempo/Jaeger | 与供应商无关,CNCF 标准 |
| 日志聚合(成本敏感) | Grafana Loki | 仅为标签建立索引,成本低 10 倍 |
| 日志聚合(搜索需求高) | ELK Stack | 全文搜索,高级分析 |
| 统一可观测性 | Elastic/Datadog/Dynatrace | 在一个界面中查看所有遥测数据 |
| 事件管理 | PagerDuty/Opsgenie | 告警路由、值班排班 |
| 混沌工程 | Gremlin/Chaos Mesh | 可控地注入故障 |
| AIOps/异常检测 | Dynatrace/Datadog | AI 驱动的根因分析 |
三大支柱
| 支柱 | 内容 | 适用场景 | 工具 |
|---|---|---|---|
| 指标 | 数值型时间序列数据 | 实时监控、告警 | Prometheus、StatsD、CloudWatch |
| 日志 | 带上下文的事件记录 | 调试、审计跟踪 | Loki、ELK、Splunk |
| 追踪 | 请求在各服务之间的完整路径 | 性能分析、依赖关系 | OpenTelemetry、Jaeger、Zipkin |
第四大支柱(新兴): 持续性能剖析 — 代码级性能数据(函数级别的 CPU、内存使用情况)
可观测性架构
分层 Prometheus 设置
# 2025 Best Practice: Federated architecture
# Prevents metric chaos while enabling drill-down
# Layer 1: Application Prometheus
# - Detailed business logic metrics
# - High cardinality acceptable
# - Short retention (7 days)
# Layer 2: Cluster Prometheus
# - Per-environment/cluster metrics
# - Medium retention (30 days)
# - Aggregates from application level
# Layer 3: Global Prometheus
# - Cross-cluster critical metrics
# - Long retention (1 year)
# - Federation from cluster level
# Global Prometheus config
scrape_configs:
- job_name: 'federate'
scrape_interval: 15s
honor_labels: true
metrics_path: '/federate'
params:
'match[]':
- '{job="kubernetes-nodes"}'
- '{__name__=~"job:.*"}' # Recording rules only
static_configs:
- targets:
- 'cluster-prom-us-east.internal:9090'
- 'cluster-prom-eu-west.internal:9090'
用于性能优化的记录规则
# Precompute expensive queries
groups:
- name: api_performance
interval: 30s
rules:
# Request rate (requests per second)
- record: job:api_requests:rate5m
expr: sum(rate(http_requests_total[5m])) by (job, method, status)
# Error rate
- record: job:api_errors:rate5m
expr: |
sum(rate(http_requests_total{status=~"5.."}[5m])) by (job)
/
sum(rate(http_requests_total[5m])) by (job)
# P95 latency
- record: job:api_latency:p95
expr: histogram_quantile(0.95, sum(rate(http_request_duration_seconds_bucket[5m])) by (job, le))
资源优化
# Increase scrape interval for high-target deployments
scrape_interval: 30s # Default: 15s reduces load by 50%
# Use relabeling to drop unnecessary metrics
metric_relabel_configs:
- source_labels: [__name__]
regex: 'go_.*|process_.*' # Drop Go runtime metrics
action: drop
# Limit sample retention
storage:
tsdb:
retention.time: 15d # Keep only 15 days locally
retention.size: 50GB # Or max 50GB
使用 OpenTelemetry 进行分布式追踪
自动插桩设置
// Node.js auto-instrumentation
import { NodeSDK } from '@opentelemetry/sdk-node';
import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
const sdk = new NodeSDK({
traceExporter: new OTLPTraceExporter({
url: 'http://otel-collector:4318/v1/traces',
}),
instrumentations: [
getNodeAutoInstrumentations({
// Auto-instruments HTTP, Express, PostgreSQL, Redis, etc.
'@opentelemetry/instrumentation-fs': { enabled: false }, // Too noisy
}),
],
});
sdk.start();
为业务逻辑进行手动插桩
import { trace, SpanStatusCode } from '@opentelemetry/api';
const tracer = trace.getTracer('payment-service', '1.0.0');
async function processPayment(orderId: string, amount: number) {
// Create custom span for business operation
return tracer.startActiveSpan('processPayment', async (span) => {
try {
// Add business context
span.setAttributes({
'order.id': orderId,
'payment.amount': amount,
'payment.currency': 'USD',
});
// Child span for external API call
const paymentResult = await tracer.startActiveSpan('stripe.charge', async (childSpan) => {
const result = await stripe.charges.create({ amount, currency: 'usd' });
childSpan.setAttribute('stripe.charge_id', result.id);
childSpan.setStatus({ code: SpanStatusCode.OK });
childSpan.end();
return result;
});
span.setStatus({ code: SpanStatusCode.OK });
return paymentResult;
} catch (error) {
span.recordException(error);
span.setStatus({ code: SpanStatusCode.ERROR, message: error.message });
throw error;
} finally {
span.end();
}
});
}
采样策略
# OpenTelemetry Collector config
processors:
# Probabilistic sampling: Keep 10% of traces
probabilistic_sampler:
sampling_percentage: 10
# Tail sampling: Make decisions after seeing full trace
tail_sampling:
policies:
# Always sample errors
- name: error-traces
type: status_code
status_code: {status_codes: [ERROR]}
# Always sample slow requests
- name: slow-traces
type: latency
latency: {threshold_ms: 1000}
# Sample 5% of normal traffic
- name: normal-traces
type: probabilistic
probabilistic: {sampling_percentage: 5}
上下文传播
// Ensure trace context flows across services
import { propagation, context } from '@opentelemetry/api';
// Outgoing HTTP request (automatic with auto-instrumentation)
fetch('https://api.example.com/data', {
headers: {
// W3C Trace Context headers injected automatically:
// traceparent: 00-<trace-id>-<span-id>-01
// tracestate: vendor=value
},
});
// Manual propagation for non-HTTP (e.g., message queues)
const carrier = {};
propagation.inject(context.active(), carrier);
await publishMessage(queue, { data: payload, headers: carrier });
结构化日志最佳实践
JSON 日志格式
// Use structured logging library
import pino from 'pino';
const logger = pino({
level: process.env.LOG_LEVEL || 'info',
formatters: {
level: (label) => ({ level: label }),
},
timestamp: pino.stdTimeFunctions.isoTime,
// Include trace context in logs
mixin() {
const span = trace.getActiveSpan();
if (!span) return {};
const { traceId, spanId } = span.spanContext();
return {
trace_id: traceId,
span_id: spanId,
};
},
});
// Structured logging with context
logger.info(
{
user_id: '123',
order_id: 'ord_456',
amount: 99.99,
payment_method: 'card',
},
'Payment processed successfully'
);
// Output:
// {"level":"info","time":"2025-01-15T10:30:00.000Z","trace_id":"abc123","span_id":"def456","user_id":"123","order_id":"ord_456","amount":99.99,"payment_method":"card","msg":"Payment processed successfully"}
日志级别
// Follow standard severity levels
logger.trace({ details }, 'Low-level debugging'); // Very verbose
logger.debug({ state }, 'Debug information'); // Development
logger.info({ event }, 'Normal operation'); // Production default
logger.warn({ issue }, 'Warning condition'); // Potential issues
logger.error({ error, context }, 'Error occurred'); // Errors
logger.fatal({ critical }, 'Fatal error'); // Process crash
Grafana Loki 配置
# Promtail config - ships logs to Loki
server:
http_listen_port: 9080
positions:
filename: /tmp/positions.yaml
clients:
- url: http://loki:3100/loki/api/v1/push
scrape_configs:
- job_name: kubernetes
kubernetes_sd_configs:
- role: pod
relabel_configs:
# Add pod labels as Loki labels (LOW cardinality only!)
- source_labels: [__meta_kubernetes_namespace]
target_label: namespace
- source_labels: [__meta_kubernetes_pod_name]
target_label: pod
- source_labels: [__meta_kubernetes_pod_label_app]
target_label: app
pipeline_stages:
# Parse JSON logs
- json:
expressions:
level: level
trace_id: trace_id
# Extract fields as labels
- labels:
level:
trace_id:
Loki 最佳实践
- 低基数标签 — 仅使用 5-10 个标签(namespace、app、level)
- 在日志正文中使用高基数信息 — 将 user_id、order_id 放入 JSON,而不是标签
- 使用 LogQL 进行筛选 — 使用
{app="api"} | json | user_id="123" - 保留策略 — 较长时间保留近期日志,并压缩旧日志
# LogQL query examples
{namespace="production", app="api"} |= "error" # Text search
{app="api"} | json | level="error" | line_format "{{.msg}}" # JSON parsing
rate({app="api"}[5m]) # Log rate per second
sum by (level) (count_over_time({namespace="production"}[1h])) # Count by level
扩展参考
为使此技能保持简洁,从 ## SLO/SLI/SLA Management 开始的详细材料已移至 reference/extended.md。如果任务需要其中迁移的示例、命令目录、检查清单、平台详情或实现模板,请加载该参考文档。
评论
支持 Markdown