Files
silo-server/internal/taskmanager/tasks/scan_libraries.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

116 lines
3.1 KiB
Go

package tasks
import (
"context"
"encoding/json"
"fmt"
"log/slog"
"sync"
"sync/atomic"
"github.com/Silo-Server/silo-server/internal/cache"
"github.com/Silo-Server/silo-server/internal/models"
"github.com/Silo-Server/silo-server/internal/taskmanager"
)
// ScanFolderRepository provides folder operations for scanning.
type ScanFolderRepository interface {
GetEnabled(ctx context.Context) ([]*models.MediaFolder, error)
}
// LibraryScanQueuer enqueues a full-library scan for durable execution.
type LibraryScanQueuer interface {
EnqueueLibraryScan(ctx context.Context, folderID int, trigger string) (bool, error)
}
// ScanLibrariesTask scans all enabled library folders for media changes.
type ScanLibrariesTask struct {
folderRepo ScanFolderRepository
queuer LibraryScanQueuer
eventBus cache.EventBus
}
// NewScanLibrariesTask creates a new ScanLibrariesTask.
func NewScanLibrariesTask(folderRepo ScanFolderRepository, queuer LibraryScanQueuer, eventBus cache.EventBus) *ScanLibrariesTask {
return &ScanLibrariesTask{
folderRepo: folderRepo,
queuer: queuer,
eventBus: eventBus,
}
}
func (t *ScanLibrariesTask) Key() string { return "scan_libraries" }
func (t *ScanLibrariesTask) Name() string { return "Queue Media Library Scans" }
func (t *ScanLibrariesTask) Description() string {
return "Queues durable full-library scans for all enabled libraries; actual scan progress continues in Admin Libraries and Server Activity"
}
func (t *ScanLibrariesTask) Category() taskmanager.TaskCategory {
return taskmanager.TaskCategoryLibrary
}
func (t *ScanLibrariesTask) IsHidden() bool { return false }
func (t *ScanLibrariesTask) DefaultTriggers() []taskmanager.TriggerConfig {
return []taskmanager.TriggerConfig{
{Type: taskmanager.TriggerTypeDaily, TimeOfDay: "02:00"},
}
}
func (t *ScanLibrariesTask) Execute(ctx context.Context, progress taskmanager.ProgressReporter) error {
folders, err := t.folderRepo.GetEnabled(ctx)
if err != nil {
return fmt.Errorf("listing enabled folders: %w", err)
}
if len(folders) == 0 {
progress.Report(100, "No folders to scan")
return nil
}
type scanSummary struct {
Queued int `json:"queued"`
Skipped int `json:"skipped"`
Errors int `json:"errors"`
}
var (
mu sync.Mutex
summary scanSummary
done atomic.Int64
total = int64(len(folders))
)
for _, folder := range folders {
if folder == nil {
done.Add(1)
continue
}
created, enqueueErr := t.queuer.EnqueueLibraryScan(ctx, folder.ID, "task:scan_libraries")
if enqueueErr != nil {
slog.ErrorContext(ctx, "scan task: failed to enqueue library scan", "component", "taskmanager", "folder_id", folder.ID, "name", folder.Name, "error", enqueueErr)
mu.Lock()
summary.Errors++
mu.Unlock()
} else {
mu.Lock()
if created {
summary.Queued++
} else {
summary.Skipped++
}
mu.Unlock()
}
completed := done.Add(1)
progress.Report(float64(completed)/float64(total)*100,
fmt.Sprintf("Queued %s (%d/%d folders)", folder.Name, completed, total))
}
progress.Report(100, "Library scans queued")
if data, err := json.Marshal(summary); err == nil {
progress.SetResultData(data)
}
return nil
}