* 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>
218 lines
5.3 KiB
Go
218 lines
5.3 KiB
Go
package tasks
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"log/slog"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/Silo-Server/silo-server/internal/taskmanager"
|
|
"github.com/Silo-Server/silo-server/internal/worker"
|
|
)
|
|
|
|
const (
|
|
refreshMetadataTaskInterval = 6 * time.Hour
|
|
refreshMetadataBatchSize = 200
|
|
refreshMetadataWorkerCount = 12
|
|
)
|
|
|
|
// MetadataRefresher can refresh metadata for a queued target.
|
|
type MetadataRefresher interface {
|
|
RefreshScheduledTarget(ctx context.Context, targetType, contentID string) error
|
|
}
|
|
|
|
// RefreshCandidateFinder finds items needing metadata refresh.
|
|
type RefreshCandidateFinder interface {
|
|
FindCandidates(ctx context.Context, limit int) ([]worker.RefreshCandidate, error)
|
|
}
|
|
|
|
type RefreshDebtPruner interface {
|
|
PruneDisabledLibraryDebt(ctx context.Context) error
|
|
}
|
|
|
|
// RefreshMetadataTask refreshes stale metadata for media items.
|
|
type RefreshMetadataTask struct {
|
|
finder RefreshCandidateFinder
|
|
refresher MetadataRefresher
|
|
}
|
|
|
|
// NewRefreshMetadataTask creates a new RefreshMetadataTask.
|
|
func NewRefreshMetadataTask(finder RefreshCandidateFinder, refresher MetadataRefresher) *RefreshMetadataTask {
|
|
return &RefreshMetadataTask{
|
|
finder: finder,
|
|
refresher: refresher,
|
|
}
|
|
}
|
|
|
|
func (t *RefreshMetadataTask) Key() string { return "refresh_metadata" }
|
|
func (t *RefreshMetadataTask) Name() string { return "Refresh Metadata" }
|
|
func (t *RefreshMetadataTask) Description() string {
|
|
return "Refreshes stale metadata from providers for existing media items"
|
|
}
|
|
func (t *RefreshMetadataTask) Category() taskmanager.TaskCategory {
|
|
return taskmanager.TaskCategoryMetadata
|
|
}
|
|
func (t *RefreshMetadataTask) IsHidden() bool { return false }
|
|
|
|
func (t *RefreshMetadataTask) DefaultTriggers() []taskmanager.TriggerConfig {
|
|
return []taskmanager.TriggerConfig{
|
|
{Type: taskmanager.TriggerTypeInterval, IntervalMs: int64(refreshMetadataTaskInterval / time.Millisecond)},
|
|
}
|
|
}
|
|
|
|
func (t *RefreshMetadataTask) Execute(ctx context.Context, progress taskmanager.ProgressReporter) error {
|
|
progress.Report(0, "Finding refresh candidates")
|
|
if pruner, ok := t.finder.(RefreshDebtPruner); ok {
|
|
if err := pruner.PruneDisabledLibraryDebt(ctx); err != nil {
|
|
return fmt.Errorf("pruning disabled-library refresh debt: %w", err)
|
|
}
|
|
}
|
|
|
|
var refreshed, errored, claimed, batches int
|
|
for {
|
|
if ctx.Err() != nil {
|
|
return ctx.Err()
|
|
}
|
|
|
|
candidates, err := t.finder.FindCandidates(ctx, refreshMetadataBatchSize)
|
|
if err != nil {
|
|
return fmt.Errorf("finding refresh candidates: %w", err)
|
|
}
|
|
|
|
if len(candidates) == 0 {
|
|
if claimed == 0 {
|
|
progress.Report(100, "No items need refreshing")
|
|
} else {
|
|
progress.Report(100, fmt.Sprintf(
|
|
"Refreshed %d, errored %d",
|
|
refreshed,
|
|
errored,
|
|
))
|
|
}
|
|
return nil
|
|
}
|
|
|
|
batches++
|
|
claimed += len(candidates)
|
|
batchRefreshed, batchErrored, err := t.refreshBatch(ctx, progress, batches, candidates, refreshed, errored)
|
|
refreshed += batchRefreshed
|
|
errored += batchErrored
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if len(candidates) < refreshMetadataBatchSize {
|
|
progress.Report(100, fmt.Sprintf(
|
|
"Refreshed %d, errored %d",
|
|
refreshed,
|
|
errored,
|
|
))
|
|
return nil
|
|
}
|
|
}
|
|
}
|
|
|
|
func (t *RefreshMetadataTask) refreshBatch(
|
|
ctx context.Context,
|
|
progress taskmanager.ProgressReporter,
|
|
batchNumber int,
|
|
candidates []worker.RefreshCandidate,
|
|
baseRefreshed int,
|
|
baseErrored int,
|
|
) (int, int, error) {
|
|
if len(candidates) == 0 {
|
|
return 0, 0, nil
|
|
}
|
|
|
|
workerCount := refreshMetadataWorkerCount
|
|
if len(candidates) < workerCount {
|
|
workerCount = len(candidates)
|
|
}
|
|
|
|
type refreshJob struct {
|
|
candidate worker.RefreshCandidate
|
|
}
|
|
|
|
jobs := make(chan refreshJob)
|
|
var wg sync.WaitGroup
|
|
var mu sync.Mutex
|
|
var started, processed, refreshed, errored int
|
|
|
|
for i := 0; i < workerCount; i++ {
|
|
wg.Add(1)
|
|
go func() {
|
|
defer wg.Done()
|
|
for job := range jobs {
|
|
if ctx.Err() != nil {
|
|
return
|
|
}
|
|
|
|
mu.Lock()
|
|
started++
|
|
current := started
|
|
startRefreshed := baseRefreshed + refreshed
|
|
startErrored := baseErrored + errored
|
|
mu.Unlock()
|
|
progress.Report(0, fmt.Sprintf(
|
|
"Refreshing batch %d item %d/%d (refreshed %d, errored %d)",
|
|
batchNumber,
|
|
current,
|
|
len(candidates),
|
|
startRefreshed,
|
|
startErrored,
|
|
))
|
|
|
|
itemCtx, cancel := context.WithTimeout(ctx, 2*time.Minute)
|
|
err := t.refresher.RefreshScheduledTarget(itemCtx, job.candidate.TargetType, job.candidate.ContentID)
|
|
cancel()
|
|
|
|
mu.Lock()
|
|
processed++
|
|
if err != nil {
|
|
errored++
|
|
} else {
|
|
refreshed++
|
|
}
|
|
done := processed
|
|
doneRefreshed := baseRefreshed + refreshed
|
|
doneErrored := baseErrored + errored
|
|
mu.Unlock()
|
|
|
|
if err != nil {
|
|
slog.WarnContext(ctx, "refresh task: failed", "component", "taskmanager",
|
|
"target_type", job.candidate.TargetType,
|
|
"content_id", job.candidate.ContentID,
|
|
"error", err)
|
|
}
|
|
|
|
progress.Report(0, fmt.Sprintf(
|
|
"Refreshing batch %d item %d/%d (refreshed %d, errored %d)",
|
|
batchNumber,
|
|
done,
|
|
len(candidates),
|
|
doneRefreshed,
|
|
doneErrored,
|
|
))
|
|
}
|
|
}()
|
|
}
|
|
|
|
for _, candidate := range candidates {
|
|
select {
|
|
case jobs <- refreshJob{candidate: candidate}:
|
|
case <-ctx.Done():
|
|
close(jobs)
|
|
wg.Wait()
|
|
return refreshed, errored, ctx.Err()
|
|
}
|
|
}
|
|
close(jobs)
|
|
wg.Wait()
|
|
|
|
if ctx.Err() != nil {
|
|
return refreshed, errored, ctx.Err()
|
|
}
|
|
return refreshed, errored, nil
|
|
}
|