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

156 lines
4.5 KiB
Go

package telemetry
import "testing"
func TestLoadConfig(t *testing.T) {
tests := []struct {
name string
env map[string]string
wantEnabled bool
wantService string
wantProto Protocol
wantRatio float64
}{
{
name: "disabled by default",
env: map[string]string{},
wantEnabled: false,
wantService: "silo-server",
wantProto: ProtocolGRPC,
wantRatio: 1.0,
},
{
name: "enabled via endpoint",
env: map[string]string{"OTEL_EXPORTER_OTLP_ENDPOINT": "http://collector:4317"},
wantEnabled: true,
wantService: "silo-server",
wantProto: ProtocolGRPC,
wantRatio: 1.0,
},
{
name: "enabled via SILO_OTEL_ENABLED",
env: map[string]string{"SILO_OTEL_ENABLED": "true"},
wantEnabled: true,
wantService: "silo-server",
wantProto: ProtocolGRPC,
wantRatio: 1.0,
},
{
name: "service name override",
env: map[string]string{"SILO_OTEL_ENABLED": "1", "OTEL_SERVICE_NAME": "custom"},
wantEnabled: true,
wantService: "custom",
wantProto: ProtocolGRPC,
wantRatio: 1.0,
},
{
name: "http protocol",
env: map[string]string{"SILO_OTEL_ENABLED": "yes", "OTEL_EXPORTER_OTLP_PROTOCOL": "http/protobuf"},
wantEnabled: true,
wantService: "silo-server",
wantProto: ProtocolHTTP,
wantRatio: 1.0,
},
{
name: "sampler ratio override",
env: map[string]string{"SILO_OTEL_ENABLED": "on", "OTEL_TRACES_SAMPLER_ARG": "0.25"},
wantEnabled: true,
wantService: "silo-server",
wantProto: ProtocolGRPC,
wantRatio: 0.25,
},
{
name: "invalid sampler arg falls back",
env: map[string]string{"SILO_OTEL_ENABLED": "true", "OTEL_TRACES_SAMPLER_ARG": "not-a-number"},
wantEnabled: true,
wantService: "silo-server",
wantProto: ProtocolGRPC,
wantRatio: 1.0,
},
{
name: "sampler arg above 1 clamps to 1.0",
env: map[string]string{"SILO_OTEL_ENABLED": "true", "OTEL_TRACES_SAMPLER_ARG": "5"},
wantEnabled: true,
wantService: "silo-server",
wantProto: ProtocolGRPC,
wantRatio: 1.0,
},
{
name: "sampler arg +Inf falls back",
env: map[string]string{"SILO_OTEL_ENABLED": "true", "OTEL_TRACES_SAMPLER_ARG": "+Inf"},
wantEnabled: true,
wantService: "silo-server",
wantProto: ProtocolGRPC,
wantRatio: 1.0,
},
{
name: "sampler arg negative falls back",
env: map[string]string{"SILO_OTEL_ENABLED": "true", "OTEL_TRACES_SAMPLER_ARG": "-0.5"},
wantEnabled: true,
wantService: "silo-server",
wantProto: ProtocolGRPC,
wantRatio: 1.0,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// Clear all relevant env, then set the case's values.
for _, k := range []string{
"SILO_OTEL_ENABLED", "OTEL_EXPORTER_OTLP_ENDPOINT",
"OTEL_EXPORTER_OTLP_PROTOCOL", "OTEL_SERVICE_NAME",
"OTEL_SERVICE_VERSION", "OTEL_TRACES_SAMPLER",
"OTEL_TRACES_SAMPLER_ARG",
} {
t.Setenv(k, "")
}
for k, v := range tt.env {
t.Setenv(k, v)
}
cfg := LoadConfig("node-1")
if cfg.Enabled != tt.wantEnabled {
t.Errorf("Enabled = %v, want %v", cfg.Enabled, tt.wantEnabled)
}
if cfg.ServiceName != tt.wantService {
t.Errorf("ServiceName = %q, want %q", cfg.ServiceName, tt.wantService)
}
if cfg.Protocol != tt.wantProto {
t.Errorf("Protocol = %q, want %q", cfg.Protocol, tt.wantProto)
}
if cfg.SamplerRatio != tt.wantRatio {
t.Errorf("SamplerRatio = %v, want %v", cfg.SamplerRatio, tt.wantRatio)
}
if cfg.NodeID != "node-1" {
t.Errorf("NodeID = %q, want %q", cfg.NodeID, "node-1")
}
if cfg.Sampler != SamplerParentBasedTraceIDRatio {
t.Errorf("Sampler = %q, want default %q", cfg.Sampler, SamplerParentBasedTraceIDRatio)
}
})
}
}
func TestParseSampler(t *testing.T) {
tests := []struct {
raw string
want Sampler
}{
{"", SamplerParentBasedTraceIDRatio},
{"always_on", SamplerAlwaysOn},
{"ALWAYS_OFF", SamplerAlwaysOff},
{" traceidratio ", SamplerTraceIDRatio},
{"parentbased_always_on", SamplerParentBasedAlwaysOn},
{"parentbased_always_off", SamplerParentBasedAlwaysOff},
{"parentbased_traceidratio", SamplerParentBasedTraceIDRatio},
// Unsupported spec value and garbage both fall back to the default.
{"jaeger_remote", SamplerParentBasedTraceIDRatio},
{"bogus", SamplerParentBasedTraceIDRatio},
}
for _, tt := range tests {
if got := parseSampler(tt.raw); got != tt.want {
t.Errorf("parseSampler(%q) = %q, want %q", tt.raw, got, tt.want)
}
}
}