Files
silo-server/internal/catalog/collection_sync_scheduler.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

159 lines
4.3 KiB
Go

package catalog
import (
"context"
"encoding/json"
"fmt"
"log/slog"
"sync"
"time"
"golang.org/x/sync/errgroup"
"github.com/Silo-Server/silo-server/internal/models"
)
// CollectionSyncScheduler finds collections due for automatic sync and
// processes them with bounded concurrency. It is driven by a TaskManager
// task on a short interval (e.g., every 5 minutes).
type CollectionSyncScheduler struct {
repo *LibraryCollectionRepository
service *LibraryCollectionService
logger *slog.Logger
// inFlight tracks collection IDs currently being synced to prevent
// concurrent syncs of the same collection (manual vs scheduled).
inFlight sync.Map
}
// CollectionSyncResult is the JSON summary attached to the task execution.
type CollectionSyncResult struct {
Due int `json:"due"`
Synced int `json:"synced"`
Failed int `json:"failed"`
Skipped int `json:"skipped"`
}
// NewCollectionSyncScheduler creates a new scheduler.
func NewCollectionSyncScheduler(
repo *LibraryCollectionRepository,
service *LibraryCollectionService,
logger *slog.Logger,
) *CollectionSyncScheduler {
return &CollectionSyncScheduler{
repo: repo,
service: service,
logger: logger,
}
}
// RunOnce queries for due collections and syncs them with bounded concurrency.
// It returns a JSON summary suitable for task result data.
func (s *CollectionSyncScheduler) RunOnce(ctx context.Context) (json.RawMessage, error) {
due, err := s.repo.ListDueForSync(ctx)
if err != nil {
return nil, fmt.Errorf("listing due collections: %w", err)
}
if len(due) == 0 {
return marshalResult(CollectionSyncResult{}), nil
}
s.logger.InfoContext(ctx, "collection sync scheduler: starting",
"due", len(due),
)
var (
mu sync.Mutex
result = CollectionSyncResult{Due: len(due)}
g, gctx = errgroup.WithContext(ctx)
)
g.SetLimit(3)
for _, collection := range due {
collection := collection
g.Go(func() error {
s.syncOne(gctx, collection, &mu, &result)
return nil // never propagate; failures are per-collection
})
}
_ = g.Wait()
s.logger.InfoContext(ctx, "collection sync scheduler: complete",
"due", result.Due,
"synced", result.Synced,
"failed", result.Failed,
"skipped", result.Skipped,
)
return marshalResult(result), nil
}
// syncOne syncs a single collection and advances its next_sync_at.
func (s *CollectionSyncScheduler) syncOne(ctx context.Context, collection *models.LibraryCollection, mu *sync.Mutex, result *CollectionSyncResult) {
// Guard against concurrent sync of the same collection (e.g., manual trigger).
if _, loaded := s.inFlight.LoadOrStore(collection.ID, struct{}{}); loaded {
s.logger.InfoContext(ctx, "collection sync scheduler: skipping (already in flight)",
"collection_id", collection.ID,
"title", collection.Title,
)
mu.Lock()
result.Skipped++
mu.Unlock()
return
}
defer s.inFlight.Delete(collection.ID)
startedAt := time.Now()
_, syncErr := s.service.SyncCollection(ctx, collection.ID)
completedAt := time.Now()
// Always advance next_sync_at, even on failure, so we retry on the
// natural cron schedule rather than every poll interval.
if collection.SyncSchedule != nil {
next := ComputeNextSyncAtFrom(*collection.SyncSchedule, completedAt)
if err := s.repo.UpdateNextSyncAt(ctx, collection.ID, next); err != nil {
s.logger.ErrorContext(ctx, "collection sync scheduler: failed to advance schedule",
"collection_id", collection.ID,
"error", err,
)
}
}
mu.Lock()
defer mu.Unlock()
if syncErr != nil {
result.Failed++
s.logger.ErrorContext(ctx, "collection sync scheduler: sync failed",
"collection_id", collection.ID,
"title", collection.Title,
"duration", completedAt.Sub(startedAt).Round(time.Millisecond),
"error", syncErr,
)
} else {
result.Synced++
s.logger.InfoContext(ctx, "collection sync scheduler: synced",
"collection_id", collection.ID,
"title", collection.Title,
"duration", completedAt.Sub(startedAt).Round(time.Millisecond),
)
}
}
// IsInFlight returns true if the given collection is currently being synced
// by the scheduler. Used by the manual sync handler to avoid overlap.
func (s *CollectionSyncScheduler) IsInFlight(collectionID string) bool {
_, ok := s.inFlight.Load(collectionID)
return ok
}
func marshalResult(r CollectionSyncResult) json.RawMessage {
data, _ := json.Marshal(r)
return data
}