Files
silo-server/internal/telemetry/loghandler.go
203a18ae83 feat(observability): OpenTelemetry logs+traces with secret redaction and slog standardization (#290)
* feat(observability): OpenTelemetry logs+traces with secret redaction

Part of #265. Adds opt-in OpenTelemetry (logs + traces) alongside the existing
stderr + opslog pipeline, plus secret redaction on all sinks. Default-off: with
no OTEL_* / SILO_OTEL_ENABLED config, behavior is unchanged.

Bootstrap (internal/telemetry):
- Setup() builds one shared resource, a TracerProvider (parent-based trace-id
  ratio sampler), a LoggerProvider, and the W3C TraceContext+Baggage propagator
  from env. It installs NO MeterProvider — metrics stay on Prometheus, and the
  built-in no-op global MeterProvider keeps the trace instrumentation libs from
  double-emitting. Shutdown is deferred with a flush timeout.
- Logs are bridged via otelslog fan-out (slog.MultiHandler), level-gated by the
  shared LevelVar and best-effort so a failing collector can't break the console
  or DB branches. stderr + opslog stay untouched.

Secret redaction (internal/logredact):
- A slog.Handler masks secret-keyed attributes (password, token, api_key,
  authorization, cookie, ...) — including .With-bound attrs, nested groups,
  secret-keyed group subtrees, and values behind a LogValuer — on the console
  and OTLP sinks, with a no-op fast path when a record has no secret keys.
  opslog.shouldRedact delegates to logredact.SecretKey so all sinks share one
  marker list.

Rotation is infra-managed (no custom file sink): container runtime for stderr,
collector/backend for OTLP, opslog partition-pruning for the DB. Documented in
docs/architecture/observability.md.

Verification: go build ./..., go vet, gofmt -l — clean; go test
./internal/telemetry/ ./internal/logredact/ -race pass.

AI-use disclosure: implemented with AI assistance (Claude Code), including
adversarial reviews that hardened the bootstrap and fixed two redaction leak
paths; reviewed by the author.

* refactor(observability): slog context+component sweep, sloglint gate (phase 3)

Part of #265. Builds on the OTel bootstrap + redaction commit.

Standardizes every log call site onto the context-carrying slog variants so
records correlate with the active OpenTelemetry trace, and locks the standard
in with a machine gate so future code (human- or AI-authored) can't drift back.

- Call-site sweep: converted the remaining slog.<Level>(...) calls to the
  slog.<Level>Context(ctx, ...) form wherever a context.Context is in scope
  (background/init calls with no ctx are left as-is), across 183 files. Applied
  via a type-aware AST codemod. Log levels and message strings are preserved
  verbatim; a component attr (canonical per-package name) is added to direct
  package-level slog calls. Bound-logger calls keep their existing .With
  bindings. The main.go and telemetry package conversions rode with their file
  in the previous commit to keep each file within a single commit.
- Enforcement (.golangci.yml): enable sloglint with context=scope, static-msg,
  key-naming-case=snake, no-mixed-args. After the sweep all four report zero
  violations repo-wide (tests included), so make lint / CI now blocks any
  regression to the non-context form. The gate ships with the sweep because it
  cannot be green until the legacy sites are converted.

Metrics remain on Prometheus; no behavior change to /metrics or Grafana.

Verification: go build ./..., go vet ./..., gofmt -l — clean; sloglint (all 4
rules) 0 violations repo-wide; log levels verified unchanged.

AI-use disclosure: implemented with AI assistance (Claude Code), including the
codemod; reviewed by the author.

* fix(observability): honor per-signal OTLP protocol and secret WithGroup names

Two Codex review findings on PR #290:

- telemetry: OTEL_EXPORTER_OTLP_{TRACES,LOGS}_PROTOCOL now override the
  generic OTEL_EXPORTER_OTLP_PROTOCOL per signal, so mixed collector
  setups (e.g. HTTP logs + gRPC traces) build the right exporter.
- logredact: entering a group whose name is secret-bearing (e.g.
  WithGroup("authorization")) now masks every leaf in that subtree,
  matching how slog.Group("authorization", ...) is masked as a whole.

* fix(observability): address review feedback on telemetry bootstrap

- Telemetry setup failure no longer kills boot: Setup returns usable
  no-op providers alongside the error and main logs and continues with
  telemetry disabled, honoring the best-effort contract.
- Honor OTEL_TRACES_SAMPLER (always_on/off, traceidratio, parentbased_*
  variants); unsupported values fall back to parentbased_traceidratio.
- Attach node identity as semconv service.instance.id instead of the
  non-semconv node.name.
- Rename opslog retention-scope log attrs to target_component/target_level
  so they no longer collide with the canonical component routing key, and
  tag those lines with component=opslog.
- Fix stale levelGated comment casing; use WarnContext in the telemetry
  shutdown defer; document the LogValuer double-resolve on the redaction
  slow path.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Quick <31828688+Quick104@users.noreply.github.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-09 08:53:52 -04:00

88 lines
2.9 KiB
Go

package telemetry
import (
"context"
"log/slog"
"go.opentelemetry.io/contrib/bridges/otelslog"
logapi "go.opentelemetry.io/otel/log"
)
// NewOTelHandler builds an slog.Handler that bridges records into the OTel logs
// pipeline via otelslog, wrapped so that Handle/WithAttrs/WithGroup never
// propagate an export error. This mirrors the best-effort contract of the
// existing internal/logsink/opslog handlers: a failure to export must not break
// the handler chain (e.g. the console or opslog DB branch must still run).
func NewOTelHandler(lp logapi.LoggerProvider) slog.Handler {
return &bestEffortHandler{
inner: otelslog.NewHandler("silo-server", otelslog.WithLoggerProvider(lp)),
}
}
// bestEffortHandler wraps a handler so its Handle never returns an error.
type bestEffortHandler struct {
inner slog.Handler
}
func (h *bestEffortHandler) Enabled(ctx context.Context, level slog.Level) bool {
return h.inner.Enabled(ctx, level)
}
func (h *bestEffortHandler) Handle(ctx context.Context, r slog.Record) error {
// Swallow export errors: telemetry is best-effort and must never break the
// fan-out chain.
_ = h.inner.Handle(ctx, r)
return nil
}
func (h *bestEffortHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
return &bestEffortHandler{inner: h.inner.WithAttrs(attrs)}
}
func (h *bestEffortHandler) WithGroup(name string) slog.Handler {
return &bestEffortHandler{inner: h.inner.WithGroup(name)}
}
// LevelGated wraps a handler so both Enabled and Handle are gated by the shared
// level. This is REQUIRED for the OTel branch: slog.MultiHandler.Enabled ORs its
// children, so without gating, the otel branch (whose Enabled follows the
// unfiltered LoggerProvider) would make the logger emit and export Debug records
// even when the shared level is Info — a per-call allocation cost and a silent
// stderr/OTLP divergence.
func LevelGated(h slog.Handler, level slog.Leveler) slog.Handler {
return &LevelGatedHandler{inner: h, level: level}
}
type LevelGatedHandler struct {
inner slog.Handler
level slog.Leveler
}
func (h *LevelGatedHandler) Enabled(ctx context.Context, level slog.Level) bool {
if level < h.level.Level() {
return false
}
return h.inner.Enabled(ctx, level)
}
func (h *LevelGatedHandler) Handle(ctx context.Context, r slog.Record) error {
if r.Level < h.level.Level() {
return nil
}
return h.inner.Handle(ctx, r)
}
func (h *LevelGatedHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
return &LevelGatedHandler{inner: h.inner.WithAttrs(attrs), level: h.level}
}
func (h *LevelGatedHandler) WithGroup(name string) slog.Handler {
return &LevelGatedHandler{inner: h.inner.WithGroup(name), level: h.level}
}
// FanOut returns a handler that dispatches each record to both the console and
// otel handlers using the stdlib slog.MultiHandler (Go 1.26).
func FanOut(console, otel slog.Handler) slog.Handler {
return slog.NewMultiHandler(console, otel)
}