技能檔案

Go Observability

Name: Go Observability
Author: 333-333-333

Vendor-neutral observability with OpenTelemetry: structured logging (slog), distributed tracing, metrics, and export to object storage. Trigger: When adding logging, tracing, metrics, or configuring observability pipelines in microservices.

333-333-3330 星標2026年2月9日

職業
分類: 架構模式

技能內容

When to Use

Adding structured logging to a service
Implementing distributed tracing across microservices
Collecting and exporting metrics
Exporting observability data to object storage for long-term retention
Setting up Gin/gRPC middleware for automatic instrumentation

Critical Patterns

Pattern	Rule
OpenTelemetry standard	OTel SDK for traces + metrics — vendor neutral, export anywhere
slog for logging	Go stdlib `log/slog` — no Zap, no Logrus, no external deps
JSON in production	Structured JSON logs in prod, text in dev
Trace context propagation	Every request gets a trace ID, propagated across services
Export to object storage	Periodic export of logs/metrics/traces to S3/GCS/MinIO for retention

相關技能

Go Observability | Skills Pool

┌──────────────┐    ┌──────────────┐    ┌──────────────┐
│   Logging    │    │   Tracing    │    │   Metrics    │
│   (slog)     │    │   (OTel)     │    │   (OTel)     │
└──────┬───────┘    └──────┬───────┘    └──────┬───────┘
       │                   │                   │
       └───────────┬───────┴───────────────────┘
                   │
         ┌─────────▼──────────┐
         │  OTel Collector    │     ← Deployed as sidecar or standalone
         └─────────┬──────────┘
                   │
       ┌───────────┼───────────┐
       ▼           ▼           ▼
   Object Store  Jaeger    Prometheus
   (long-term)  (traces)   (metrics)

# OpenTelemetry SDK
go get go.opentelemetry.io/otel
go get go.opentelemetry.io/otel/sdk
go get go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc
go get go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc

# Gin instrumentation
go get go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin

# gRPC instrumentation
go get go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc

# View traces locally
open http://localhost:16686  # Jaeger UI

# View metrics
open http://localhost:9090   # Prometheus UI

Don't	Do
`log.Printf` / `fmt.Println`	`slog.InfoContext(ctx, ...)` with structured fields
Vendor-specific tracing SDKs	OpenTelemetry standard
Skip trace context propagation	Always pass `ctx`, use OTel propagators
Log sensitive data (passwords, tokens)	Log IDs and metadata only
Metrics in domain layer	Metrics in infrastructure, referenced via interface if needed
Custom log format per service	Same slog setup shared via `observability.SetupLogger()`

Go Observability

When to Use

Critical Patterns

Go Observability

When to Use

Critical Patterns

Three Pillars

Structured Logging (slog)

Logging Convention

Distributed Tracing (OpenTelemetry)

Metrics (OpenTelemetry)

Custom Business Metrics

Gin Middleware

gRPC Interceptors

Export to Object Storage

Local Dev Stack (docker-compose)

Commands

Anti-Patterns

Istio Traffic Management

Grafana Dashboards

Linkerd Patterns

Bluebubbles

Session Logs

Openclaw Qa Testing