Files
silo-server/internal/telemetry/loghandler_test.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

96 lines
3.0 KiB
Go

package telemetry
import (
"context"
"errors"
"log/slog"
"testing"
"time"
)
// captureHandler records handled messages; it is gated by an optional level.
type captureHandler struct {
level slog.Leveler
msgs *[]string
}
func newCapture(level slog.Leveler) (*captureHandler, *[]string) {
msgs := &[]string{}
return &captureHandler{level: level, msgs: msgs}, msgs
}
func (h *captureHandler) Enabled(_ context.Context, level slog.Level) bool {
if h.level == nil {
return true
}
return level >= h.level.Level()
}
func (h *captureHandler) Handle(_ context.Context, r slog.Record) error {
*h.msgs = append(*h.msgs, r.Message)
return nil
}
func (h *captureHandler) WithAttrs([]slog.Attr) slog.Handler { return h }
func (h *captureHandler) WithGroup(string) slog.Handler { return h }
// erroringHandler always fails on Handle.
type erroringHandler struct{}
func (erroringHandler) Enabled(context.Context, slog.Level) bool { return true }
func (erroringHandler) Handle(context.Context, slog.Record) error { return errors.New("boom") }
func (erroringHandler) WithAttrs([]slog.Attr) slog.Handler { return erroringHandler{} }
func (erroringHandler) WithGroup(string) slog.Handler { return erroringHandler{} }
func TestFanOutForwardsToBoth(t *testing.T) {
console, consoleMsgs := newCapture(nil)
otel, otelMsgs := newCapture(nil)
h := FanOut(console, otel)
r := slog.NewRecord(time.Now(), slog.LevelInfo, "hello", 0)
if err := h.Handle(context.Background(), r); err != nil {
t.Fatalf("Handle error = %v", err)
}
if len(*consoleMsgs) != 1 || (*consoleMsgs)[0] != "hello" {
t.Errorf("console msgs = %v, want [hello]", *consoleMsgs)
}
if len(*otelMsgs) != 1 || (*otelMsgs)[0] != "hello" {
t.Errorf("otel msgs = %v, want [hello]", *otelMsgs)
}
}
func TestFanOutSwallowsOTelError(t *testing.T) {
console, consoleMsgs := newCapture(nil)
// Wrap the erroring handler like NewOTelHandler does.
otel := &bestEffortHandler{inner: erroringHandler{}}
h := FanOut(console, otel)
r := slog.NewRecord(time.Now(), slog.LevelInfo, "hi", 0)
if err := h.Handle(context.Background(), r); err != nil {
t.Fatalf("fan-out Handle returned error despite best-effort otel: %v", err)
}
if len(*consoleMsgs) != 1 {
t.Errorf("console did not receive record: %v", *consoleMsgs)
}
}
func TestLevelGateDropsDebugOnBothBranches(t *testing.T) {
level := new(slog.LevelVar)
level.Set(slog.LevelInfo)
console, consoleMsgs := newCapture(level)
otelInner, otelMsgs := newCapture(nil) // otel provider is unfiltered by default
otel := LevelGated(otelInner, level)
logger := slog.New(FanOut(console, otel))
logger.DebugContext(context.Background(), "debug-dropped")
logger.InfoContext(context.Background(), "info-kept")
if len(*consoleMsgs) != 1 || (*consoleMsgs)[0] != "info-kept" {
t.Errorf("console msgs = %v, want [info-kept]", *consoleMsgs)
}
if len(*otelMsgs) != 1 || (*otelMsgs)[0] != "info-kept" {
t.Errorf("otel msgs = %v, want [info-kept] (debug must be dropped by level gate)", *otelMsgs)
}
}