* 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>
96 lines
3.9 KiB
Go
96 lines
3.9 KiB
Go
package requests
|
|
|
|
import (
|
|
"context"
|
|
"log/slog"
|
|
)
|
|
|
|
// FulfillmentNotifier delivers the request.fulfilled notification once a
|
|
// completed request's media is confirmed present in the catalog. contentID is
|
|
// the matched catalog item id. Implementations must tolerate repeat calls for
|
|
// the same request (delivery creation is idempotent); returning nil means the
|
|
// request counts as handled and will not be retried.
|
|
type FulfillmentNotifier interface {
|
|
NotifyFulfilled(ctx context.Context, req Request, contentID string) error
|
|
}
|
|
|
|
// SetFulfillmentNotifier wires the notification system into the reconcile
|
|
// service. Optional; without it completed requests are never notified.
|
|
func (s *Service) SetFulfillmentNotifier(n FulfillmentNotifier) { s.notifier = n }
|
|
|
|
// LifecycleNotifier observes request lifecycle transitions (submitted,
|
|
// approved, declined) for broadcast destinations such as admin server
|
|
// channels. Implementations must be fast and non-blocking (dispatch async)
|
|
// and must never fail the transition: methods return nothing.
|
|
//
|
|
// Fulfillment is deliberately not part of this interface — it stays on
|
|
// FulfillmentNotifier, whose presence-checked, idempotent flow runs on the
|
|
// reconcile service rather than the API service.
|
|
type LifecycleNotifier interface {
|
|
RequestSubmitted(ctx context.Context, req Request)
|
|
RequestApproved(ctx context.Context, req Request)
|
|
RequestDeclined(ctx context.Context, req Request)
|
|
}
|
|
|
|
// SetLifecycleNotifier wires lifecycle observation into the API-facing
|
|
// service. Optional; without it transitions are not broadcast.
|
|
func (s *Service) SetLifecycleNotifier(n LifecycleNotifier) { s.lifecycle = n }
|
|
|
|
// notifyLifecycle resolves requester display identity and invokes one
|
|
// lifecycle hook. Best-effort by construction: the notifier cannot return an
|
|
// error and identity resolution failures just leave the name empty.
|
|
func (s *Service) notifyLifecycle(ctx context.Context, req Request, notify func(LifecycleNotifier, context.Context, Request)) {
|
|
if s.lifecycle == nil {
|
|
return
|
|
}
|
|
s.populateRequesterIdentity(ctx, &req)
|
|
notify(s.lifecycle, ctx, req)
|
|
}
|
|
|
|
// notifyFulfilledLimit bounds one notification pass; the remainder lands on
|
|
// the next reconcile run.
|
|
const notifyFulfilledLimit = 100
|
|
|
|
// notifyFulfilledPending notifies completed requests whose media has arrived
|
|
// in the catalog. Requests completed by an integration before the library
|
|
// scan imports the files stay pending (fulfilled_notified_at IS NULL) and are
|
|
// re-checked every run until presence confirms — the notification means
|
|
// "watchable in Silo", not "download finished". The delivery insert is
|
|
// idempotent (partial unique index per request), so the notify-then-stamp
|
|
// ordering can never double-send: a crash between the two retries into a
|
|
// dedupe no-op.
|
|
func (s *Service) notifyFulfilledPending(ctx context.Context) {
|
|
if s.notifier == nil {
|
|
return
|
|
}
|
|
candidates, err := s.store.ListFulfilledUnnotified(ctx, notifyFulfilledLimit)
|
|
if err != nil {
|
|
slog.WarnContext(ctx, "request fulfill-notify: list candidates failed", "component", "requests", "err", err)
|
|
return
|
|
}
|
|
for _, req := range candidates {
|
|
if ctx.Err() != nil {
|
|
return
|
|
}
|
|
matches, err := s.lookupPresence(ctx, req.MediaType, []PresenceCandidate{requestPresenceCandidate(*req)})
|
|
if err != nil {
|
|
slog.WarnContext(ctx, "request fulfill-notify: presence lookup failed", "component", "requests",
|
|
"request_id", req.ID, "tmdb_id", req.TMDBID, "err", err)
|
|
continue
|
|
}
|
|
match := matches[req.TMDBID]
|
|
if !match.Available {
|
|
continue // not in the catalog yet; retry next run
|
|
}
|
|
if err := s.notifier.NotifyFulfilled(ctx, *req, match.ContentID); err != nil {
|
|
slog.WarnContext(ctx, "request fulfill-notify: dispatch failed", "component", "requests",
|
|
"request_id", req.ID, "err", err)
|
|
continue
|
|
}
|
|
if err := s.store.MarkFulfilledNotified(ctx, req.ID); err != nil {
|
|
slog.WarnContext(ctx, "request fulfill-notify: mark failed", "component", "requests",
|
|
"request_id", req.ID, "err", err)
|
|
}
|
|
}
|
|
}
|