* 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>
104 lines
4.1 KiB
Go
104 lines
4.1 KiB
Go
// Package noderecipe is the recipe-handoff half of restart-resilient playback
|
|
// for jellycompat on dedicated transcode nodes. A native transcode carries its
|
|
// reconstruction recipe in the stream token, so a transcode node that restarts
|
|
// can rebuild ffmpeg from the token the client re-presents. The jellycompat
|
|
// node-hop token is server-minted and could carry the recipe too, but it
|
|
// deliberately does not: the recipe is mutated in place under a stable session id
|
|
// (a Jellyfin audio/subtitle switch restarts ffmpeg without re-minting the
|
|
// client's token), and a third-party Jellyfin client cannot be driven to refresh
|
|
// a stale token — so a token snapshot could reconstruct a stale rendition. The
|
|
// authoritative, mutable recipe therefore lives server-side (the central compat
|
|
// store), out of a restarted node's reach (Postgres).
|
|
//
|
|
// This store bridges that gap over the same shared Redis the offload topology
|
|
// already relies on (the node-session tracker): central writes the recipe keyed
|
|
// by the upstream session id when it starts a remote transcode, and the
|
|
// transcode node reads it on a reconstruct miss. It is
|
|
// off the hot path — written once at start, read only after a node restart.
|
|
package noderecipe
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"log/slog"
|
|
"time"
|
|
|
|
"github.com/redis/go-redis/v9"
|
|
|
|
"github.com/Silo-Server/silo-server/internal/playback"
|
|
)
|
|
|
|
// KeyPrefix namespaces per-session recipe keys: silo:noderecipe:<upstreamSessionID>.
|
|
const KeyPrefix = "silo:noderecipe:"
|
|
|
|
// DefaultTTL bounds how long a stored recipe survives. It matches the stream
|
|
// token lifetime (playback.MaxTokenTTL, 24h): past it no surviving token could
|
|
// still drive a reconstruct, so the recipe is safe to lapse.
|
|
const DefaultTTL = playback.MaxTokenTTL
|
|
|
|
// Store is the Redis-backed recipe store shared by central (writer, at remote
|
|
// transcode start) and the transcode nodes (reader, on a reconstruct miss).
|
|
type Store struct {
|
|
rdb *redis.Client
|
|
ttl time.Duration
|
|
}
|
|
|
|
// NewStore wraps a Redis client. A nil client yields a disabled store whose
|
|
// writes no-op and whose reads miss, so a single integrated box (no Redis, no
|
|
// remote node) needs no special-casing.
|
|
func NewStore(rdb *redis.Client, ttl time.Duration) *Store {
|
|
if ttl <= 0 {
|
|
ttl = DefaultTTL
|
|
}
|
|
return &Store{rdb: rdb, ttl: ttl}
|
|
}
|
|
|
|
func key(sessionID string) string { return KeyPrefix + sessionID }
|
|
|
|
// Put stores the reconstruction recipe for a remote transcode session. Best
|
|
// effort: a write error is returned for the caller to log, never fatal.
|
|
func (s *Store) Put(ctx context.Context, sessionID string, card playback.RecipeCard) error {
|
|
if s == nil || s.rdb == nil || sessionID == "" {
|
|
return nil
|
|
}
|
|
data, err := json.Marshal(card)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return s.rdb.Set(ctx, key(sessionID), data, s.ttl).Err()
|
|
}
|
|
|
|
// Get returns the stored recipe for sessionID. It fails CLOSED — a miss or any
|
|
// error yields (nil, false) — because an absent recipe legitimately means the
|
|
// node cannot reconstruct and should 404, never rebuild from a bad recipe.
|
|
func (s *Store) Get(ctx context.Context, sessionID string) (*playback.RecipeCard, bool) {
|
|
if s == nil || s.rdb == nil || sessionID == "" {
|
|
return nil, false
|
|
}
|
|
data, err := s.rdb.Get(ctx, key(sessionID)).Bytes()
|
|
if err != nil {
|
|
if !errors.Is(err, redis.Nil) {
|
|
slog.WarnContext(ctx, "load node recipe failed", "component", "noderecipe", "error", err, "playback_session_id", sessionID)
|
|
}
|
|
return nil, false
|
|
}
|
|
var card playback.RecipeCard
|
|
if err := json.Unmarshal(data, &card); err != nil {
|
|
slog.WarnContext(ctx, "decode node recipe failed", "component", "noderecipe", "error", err, "playback_session_id", sessionID)
|
|
return nil, false
|
|
}
|
|
return &card, true
|
|
}
|
|
|
|
// Delete removes the stored recipe for sessionID so an explicitly-stopped
|
|
// session cannot be resurrected from a leftover recipe after a node restart.
|
|
// Safe on a nil/disabled store and on a missing key (a missing key is not an
|
|
// error). A delete error is returned for the caller to log, never fatal.
|
|
func (s *Store) Delete(ctx context.Context, sessionID string) error {
|
|
if s == nil || s.rdb == nil || sessionID == "" {
|
|
return nil
|
|
}
|
|
return s.rdb.Del(ctx, key(sessionID)).Err()
|
|
}
|