Files
silo-server/internal/notifications/channel_dispatcher.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

130 lines
3.5 KiB
Go

package notifications
import (
"context"
"log/slog"
"sync"
"time"
)
// channelDispatcher is the shared dispatch core behind the per-channel
// Dispatcher implementations (webhooks, web push, Apple push). dispatch never
// blocks the fanout loop on destination I/O: it hands the delivery ID to a
// bounded worker pool that claims the delivery's pending outbox attempts and
// sends them. A full queue simply drops the hand-off — the durable pending
// rows are picked up by the retry sweep, so delivery is delayed, never lost.
type channelDispatcher[A any] struct {
channel string // log label, e.g. "web push"
queue chan string
logger *slog.Logger
claimPending func(ctx context.Context, deliveryID string) ([]A, error)
process func(ctx context.Context, attempt A)
// Optional integrated retry sweep: when claimDue is set, run also drains
// due retries and recovers stale pending rows, skipping ticks while
// enabled reports the channel off. Webhooks instead run the standalone
// WebhookRetryWorker, whose lifecycle the system manages separately.
enabled func(ctx context.Context) bool
claimDue func(ctx context.Context, limit int) ([]A, error)
claimLimit int
}
// dispatch queues the delivery's attempts for immediate send without blocking.
func (d *channelDispatcher[A]) dispatch(deliveryID string) {
select {
case d.queue <- deliveryID:
default:
d.logger.Warn("dispatch queue full; deferring to retry worker",
"channel", d.channel, "delivery_id", deliveryID)
}
}
// run consumes the dispatch queue with a bounded worker pool (plus the retry
// sweep when configured) until ctx is canceled. One slow destination cannot
// block other deliveries.
func (d *channelDispatcher[A]) run(ctx context.Context) {
var wg sync.WaitGroup
for range webhookDispatchWorkers {
wg.Add(1)
go func() {
defer wg.Done()
for {
select {
case <-ctx.Done():
return
case deliveryID := <-d.queue:
d.processDelivery(ctx, deliveryID)
}
}
}()
}
if d.claimDue != nil {
wg.Add(1)
go func() {
defer wg.Done()
runRetrySweep(ctx, d.channel, d.logger, d.enabled, d.claimDue, d.claimLimit, d.process)
}()
}
wg.Wait()
}
func (d *channelDispatcher[A]) processDelivery(ctx context.Context, deliveryID string) {
attempts, err := d.claimPending(ctx, deliveryID)
if err != nil {
if ctx.Err() == nil {
d.logger.WarnContext(ctx, "attempt claim failed", "channel", d.channel, "delivery_id", deliveryID, "error", err)
}
return
}
for _, attempt := range attempts {
if ctx.Err() != nil {
return
}
d.process(ctx, attempt)
}
}
// runRetrySweep polls for due attempts until ctx is canceled, draining every
// due batch each tick. Shared by the integrated dispatcher sweeps and the
// standalone webhook retry worker.
func runRetrySweep[A any](
ctx context.Context,
channel string,
logger *slog.Logger,
enabled func(context.Context) bool,
claim func(context.Context, int) ([]A, error),
limit int,
process func(context.Context, A),
) {
ticker := time.NewTicker(webhookRetryInterval)
defer ticker.Stop()
for {
select {
case <-ctx.Done():
return
case <-ticker.C:
}
if !enabled(ctx) {
continue
}
for {
attempts, err := claim(ctx, limit)
if err != nil {
if ctx.Err() == nil {
logger.WarnContext(ctx, "retry claim failed", "channel", channel, "error", err)
}
break
}
if len(attempts) == 0 {
break
}
for _, attempt := range attempts {
if ctx.Err() != nil {
return
}
process(ctx, attempt)
}
}
}
}