* 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>
194 lines
6.2 KiB
Go
194 lines
6.2 KiB
Go
package handlers
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"log/slog"
|
|
"net/http"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/go-chi/chi/v5"
|
|
|
|
"github.com/Silo-Server/silo-server/internal/intromarkers"
|
|
"github.com/Silo-Server/silo-server/internal/markers"
|
|
"github.com/Silo-Server/silo-server/internal/models"
|
|
)
|
|
|
|
type IntroEpisodeAnalyzer interface {
|
|
AnalyzeEpisode(ctx context.Context, episodeID string) (intromarkers.RunSummary, error)
|
|
}
|
|
|
|
type IntroEpisodeEligibilityChecker interface {
|
|
EpisodeIntroEligibility(ctx context.Context, episodeID string) (*intromarkers.EpisodeIntroEligibility, error)
|
|
}
|
|
|
|
type MarkerSettingsReader interface {
|
|
Get(ctx context.Context, key string) (string, error)
|
|
}
|
|
|
|
type AdminIntroFileResolver interface {
|
|
GetByEpisodeID(ctx context.Context, episodeID string) ([]*models.MediaFile, error)
|
|
}
|
|
|
|
type AdminIntroHandler struct {
|
|
analyzer IntroEpisodeAnalyzer
|
|
eligibility IntroEpisodeEligibilityChecker
|
|
Settings MarkerSettingsReader
|
|
FileResolver AdminIntroFileResolver
|
|
MarkerUpdateNotifier PlaybackMarkerUpdateNotifier
|
|
baseContext context.Context
|
|
inFlight sync.Map
|
|
logger *slog.Logger
|
|
}
|
|
|
|
func NewAdminIntroHandler(
|
|
analyzer IntroEpisodeAnalyzer,
|
|
eligibility IntroEpisodeEligibilityChecker,
|
|
baseContext context.Context,
|
|
logger *slog.Logger,
|
|
) *AdminIntroHandler {
|
|
if baseContext == nil {
|
|
baseContext = context.Background()
|
|
}
|
|
if logger == nil {
|
|
logger = slog.Default()
|
|
}
|
|
return &AdminIntroHandler{
|
|
analyzer: analyzer,
|
|
eligibility: eligibility,
|
|
baseContext: baseContext,
|
|
logger: logger,
|
|
}
|
|
}
|
|
|
|
type redetectIntroResponse struct {
|
|
Status string `json:"status"`
|
|
}
|
|
|
|
func (h *AdminIntroHandler) HandleRefreshEpisodeMarkers(w http.ResponseWriter, r *http.Request) {
|
|
h.handleEpisodeMarkers(w, r, "refresh")
|
|
}
|
|
|
|
func (h *AdminIntroHandler) HandleRedetectEpisodeIntro(w http.ResponseWriter, r *http.Request) {
|
|
h.handleEpisodeMarkers(w, r, "redetect")
|
|
}
|
|
|
|
func (h *AdminIntroHandler) handleEpisodeMarkers(w http.ResponseWriter, r *http.Request, action string) {
|
|
if h == nil || h.analyzer == nil || h.eligibility == nil {
|
|
writeError(w, http.StatusServiceUnavailable, "unavailable", "Intro detection is not configured")
|
|
return
|
|
}
|
|
|
|
episodeID := chi.URLParam(r, "id")
|
|
if episodeID == "" {
|
|
writeError(w, http.StatusBadRequest, "bad_request", "Item ID is required")
|
|
return
|
|
}
|
|
|
|
eligibility, err := h.eligibility.EpisodeIntroEligibility(r.Context(), episodeID)
|
|
if err != nil {
|
|
if errors.Is(err, intromarkers.ErrEpisodeNotFound) {
|
|
writeError(w, http.StatusBadRequest, "bad_request", "Item must be an episode")
|
|
return
|
|
}
|
|
h.logger.ErrorContext(r.Context(), "admin intro: resolve episode failed", "episode_id", episodeID, "error", err)
|
|
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to resolve episode")
|
|
return
|
|
}
|
|
if !eligibility.HasMediaFiles {
|
|
writeError(w, http.StatusConflict, "conflict", "Episode has no media files to analyze")
|
|
return
|
|
}
|
|
if !eligibility.IntroDetectionEnabled {
|
|
writeError(w, http.StatusConflict, "conflict", "Intro detection is disabled for this episode's library")
|
|
return
|
|
}
|
|
if h.Settings == nil {
|
|
writeError(w, http.StatusServiceUnavailable, "unavailable", "Marker settings are not configured")
|
|
return
|
|
}
|
|
raw, err := h.Settings.Get(r.Context(), markers.SettingMode)
|
|
if err != nil {
|
|
h.logger.ErrorContext(r.Context(), "admin markers: load mode failed", "episode_id", episodeID, "error", err)
|
|
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to load marker settings")
|
|
return
|
|
}
|
|
mode := markers.NormalizeMode(raw)
|
|
if !markers.ShouldRunLocal(mode) {
|
|
switch mode {
|
|
case markers.ModeOff:
|
|
writeError(w, http.StatusConflict, "conflict", "Marker detection is disabled")
|
|
case markers.ModeOnline:
|
|
writeError(w, http.StatusConflict, "conflict", "Online-only marker refresh is not available for this endpoint")
|
|
default:
|
|
writeError(w, http.StatusConflict, "conflict", "Local intro detection is disabled")
|
|
}
|
|
return
|
|
}
|
|
|
|
if _, loaded := h.inFlight.LoadOrStore(episodeID, struct{}{}); loaded {
|
|
writeJSON(w, http.StatusAccepted, redetectIntroResponse{Status: "already_running"})
|
|
return
|
|
}
|
|
|
|
go func() {
|
|
defer h.inFlight.Delete(episodeID)
|
|
start := time.Now()
|
|
h.logger.InfoContext(r.Context(), "admin markers: episode refresh started", "episode_id", episodeID, "action", action)
|
|
summary, err := h.analyzer.AnalyzeEpisode(h.baseContext, episodeID)
|
|
if err != nil {
|
|
h.logger.ErrorContext(r.Context(), "admin markers: episode refresh failed",
|
|
"episode_id", episodeID,
|
|
"action", action,
|
|
"duration", time.Since(start),
|
|
"error", err)
|
|
return
|
|
}
|
|
h.logger.InfoContext(r.Context(), "admin markers: episode refresh finished",
|
|
"episode_id", episodeID,
|
|
"action", action,
|
|
"duration", time.Since(start),
|
|
"files_considered", summary.FilesConsidered,
|
|
"season_groups_considered", summary.SeasonGroupsConsidered,
|
|
"chapter_markers_written", summary.ChapterMarkersWritten,
|
|
"chromaprint_markers_written", summary.ChromaprintMarkersWritten,
|
|
"fingerprint_cache_hits", summary.FingerprintCacheHits,
|
|
"fingerprints_computed", summary.FingerprintsComputed,
|
|
"errors", len(summary.Errors))
|
|
h.notifyEpisodeMarkerUpdates(h.baseContext, episodeID, action)
|
|
}()
|
|
|
|
writeJSON(w, http.StatusAccepted, redetectIntroResponse{Status: "queued"})
|
|
}
|
|
|
|
func (h *AdminIntroHandler) notifyEpisodeMarkerUpdates(ctx context.Context, episodeID, action string) {
|
|
if h == nil || h.FileResolver == nil || h.MarkerUpdateNotifier == nil {
|
|
return
|
|
}
|
|
files, err := h.FileResolver.GetByEpisodeID(ctx, episodeID)
|
|
if err != nil {
|
|
h.logger.WarnContext(ctx, "admin markers: reload episode files for marker update failed",
|
|
"episode_id", episodeID,
|
|
"action", action,
|
|
"error", err)
|
|
return
|
|
}
|
|
for _, file := range files {
|
|
if !hasAnyPlaybackMarker(file) {
|
|
continue
|
|
}
|
|
h.MarkerUpdateNotifier.MarkersUpdated(ctx, file)
|
|
h.logger.InfoContext(ctx, "admin markers: emitted marker update",
|
|
"episode_id", episodeID,
|
|
"action", action,
|
|
"file_id", file.ID)
|
|
}
|
|
}
|
|
|
|
func hasAnyPlaybackMarker(file *models.MediaFile) bool {
|
|
return file != nil &&
|
|
((file.IntroStart != nil && file.IntroEnd != nil) ||
|
|
(file.CreditsStart != nil && file.CreditsEnd != nil))
|
|
}
|