Files
silo-server/internal/watchlist/maintainer.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

151 lines
4.9 KiB
Go

// Package watchlist holds cross-cutting watchlist behavior that doesn't belong
// to a single handler — currently the auto-removal of fully-watched movies.
// Series are intentionally never removed: they stay on the watchlist and the
// read paths hide fully-watched ones via catalog.WatchlistVisibility, so a
// newly added episode makes the series reappear without any re-add machinery.
package watchlist
import (
"context"
"log/slog"
"time"
"github.com/Silo-Server/silo-server/internal/models"
"github.com/Silo-Server/silo-server/internal/userstore"
"github.com/Silo-Server/silo-server/internal/watchsync"
)
type itemLookup interface {
// GetByIDs returns the catalog items for the given content IDs, silently
// omitting IDs that don't resolve (episode IDs live in their own table and
// are expected misses here).
GetByIDs(ctx context.Context, contentIDs []string) ([]*models.MediaItem, error)
}
type listEventDispatcher interface {
HandleLocalListEvent(ctx context.Context, event watchsync.LocalListEvent) error
}
// maintainerStore is the narrow slice of the user store the maintainer needs.
type maintainerStore interface {
RemoveWatchedFromWatchlist(ctx context.Context, profileID string) (bool, error)
InWatchlist(ctx context.Context, profileID, mediaItemID string) (bool, error)
RemoveFromWatchlist(ctx context.Context, profileID, mediaItemID string) error
}
// Maintainer removes a fully-watched movie from a profile's watchlist when its
// watch completes. It implements watchstate.CompletionObserver. Removals route
// through the same local-list-event path as a manual removal, so connected
// watchlist providers mirror the change.
//
// Episode and series completions are deliberately ignored: removing a series on
// full watch would strand it off the watchlist when new episodes air later, so
// fully-watched series are hidden at read time instead (see
// catalog.WatchlistVisibility) and resurface as soon as an unwatched episode
// appears.
type Maintainer struct {
storeFor func(ctx context.Context, userID int) (maintainerStore, error)
items itemLookup
dispatcher listEventDispatcher
}
func NewMaintainer(stores userstore.UserStoreProvider, items itemLookup) *Maintainer {
return &Maintainer{
storeFor: func(ctx context.Context, userID int) (maintainerStore, error) {
return stores.ForUser(ctx, userID)
},
items: items,
}
}
func (m *Maintainer) WithListEventDispatcher(d listEventDispatcher) *Maintainer {
if m == nil {
return nil
}
m.dispatcher = d
return m
}
// HandleWatchedCompleted reacts to completed watches asynchronously so it never
// blocks the caller's watch-recording path.
func (m *Maintainer) HandleWatchedCompleted(ctx context.Context, userID int, profileID string, mediaItemIDs []string) {
if m == nil || m.storeFor == nil || userID == 0 || profileID == "" || len(mediaItemIDs) == 0 {
return
}
ids := append([]string(nil), mediaItemIDs...)
go func() {
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Minute)
defer cancel()
if err := m.process(ctx, userID, profileID, ids); err != nil {
slog.WarnContext(ctx, "watchlist auto-remove failed", "component", "watchlist", "user_id", userID, "profile_id", profileID, "error", err)
}
}()
}
func (m *Maintainer) process(ctx context.Context, userID int, profileID string, mediaItemIDs []string) error {
store, err := m.storeFor(ctx, userID)
if err != nil {
return err
}
enabled, err := store.RemoveWatchedFromWatchlist(ctx, profileID)
if err != nil {
return err
}
if !enabled {
return nil
}
if m.items == nil {
return nil
}
items, err := m.items.GetByIDs(ctx, mediaItemIDs)
if err != nil {
return err
}
for _, item := range items {
if item == nil || item.Type != "movie" {
continue
}
if err := m.removeFromWatchlist(ctx, store, userID, profileID, item); err != nil {
return err
}
}
return nil
}
func (m *Maintainer) removeFromWatchlist(ctx context.Context, store maintainerStore, userID int, profileID string, item *models.MediaItem) error {
in, err := store.InWatchlist(ctx, profileID, item.ContentID)
if err != nil {
return err
}
if !in {
return nil
}
if err := store.RemoveFromWatchlist(ctx, profileID, item.ContentID); err != nil {
return err
}
m.dispatchRemoval(ctx, userID, profileID, item)
return nil
}
func (m *Maintainer) dispatchRemoval(ctx context.Context, userID int, profileID string, item *models.MediaItem) {
if m.dispatcher == nil {
return
}
_ = m.dispatcher.HandleLocalListEvent(ctx, watchsync.LocalListEvent{
List: watchsync.ListKindWatchlist,
Change: watchsync.ListChangeRemoved,
UserID: userID,
ProfileID: profileID,
Items: []watchsync.LocalFavorite{{
MediaItemID: item.ContentID,
Kind: item.Type,
Title: item.Title,
Year: item.Year,
IMDbID: item.ImdbID,
TMDBID: item.TmdbID,
TVDBID: item.TvdbID,
FavoritedAt: time.Now().UTC(),
}},
})
}