Files
silo-server/internal/api/handlers/history_import.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

279 lines
9.4 KiB
Go

package handlers
import (
"encoding/json"
"errors"
"fmt"
"log/slog"
"net/http"
"strconv"
"github.com/go-chi/chi/v5"
apimw "github.com/Silo-Server/silo-server/internal/api/middleware"
"github.com/Silo-Server/silo-server/internal/historyimport"
)
type HistoryImportHandler struct {
service *historyimport.Service
}
func NewHistoryImportHandler(service *historyimport.Service) *HistoryImportHandler {
return &HistoryImportHandler{service: service}
}
func (h *HistoryImportHandler) HandleListSources(w http.ResponseWriter, r *http.Request) {
sources, err := h.service.ListUserSources(r.Context())
if err != nil {
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to list history import sources")
return
}
writeJSON(w, http.StatusOK, sources)
}
func (h *HistoryImportHandler) HandleLoginConnect(w http.ResponseWriter, r *http.Request) {
userID := apimw.GetUserID(r.Context())
if userID == 0 {
writeError(w, http.StatusUnauthorized, "unauthorized", "Authentication required")
return
}
var req historyimport.LoginConnectInput
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid request body")
return
}
if req.Username == "" || req.Password == "" {
writeError(w, http.StatusBadRequest, "bad_request", "username and password are required")
return
}
session, err := h.service.LoginConnect(r.Context(), userID, req)
if err != nil {
slog.ErrorContext(r.Context(), "history import emby connect login failed", "component", "api", "user_id", userID, "error", err)
h.writeHistoryImportError(w, err)
return
}
writeJSON(w, http.StatusOK, session)
}
func (h *HistoryImportHandler) HandleCreateRun(w http.ResponseWriter, r *http.Request) {
userID := apimw.GetUserID(r.Context())
if userID == 0 {
writeError(w, http.StatusUnauthorized, "unauthorized", "Authentication required")
return
}
var req historyimport.CreateRunInput
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid request body")
return
}
run, err := h.service.CreateRun(r.Context(), userID, req)
if err != nil {
h.writeHistoryImportError(w, err)
return
}
writeJSON(w, http.StatusCreated, run)
}
func (h *HistoryImportHandler) HandleListRuns(w http.ResponseWriter, r *http.Request) {
userID := apimw.GetUserID(r.Context())
if userID == 0 {
writeError(w, http.StatusUnauthorized, "unauthorized", "Authentication required")
return
}
limit, _ := parsePagination(r)
runs, err := h.service.ListRuns(r.Context(), userID, limit)
if err != nil {
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to list history import runs")
return
}
writeJSON(w, http.StatusOK, runs)
}
func (h *HistoryImportHandler) HandleGetRun(w http.ResponseWriter, r *http.Request) {
userID := apimw.GetUserID(r.Context())
if userID == 0 {
writeError(w, http.StatusUnauthorized, "unauthorized", "Authentication required")
return
}
runID := chi.URLParam(r, "id")
if runID == "" {
writeError(w, http.StatusBadRequest, "bad_request", "Run ID is required")
return
}
run, err := h.service.GetRun(r.Context(), userID, runID)
if err != nil {
h.writeHistoryImportError(w, err)
return
}
writeJSON(w, http.StatusOK, run)
}
func (h *HistoryImportHandler) HandleCreatePlexPin(w http.ResponseWriter, r *http.Request) {
userID := apimw.GetUserID(r.Context())
if userID == 0 {
writeError(w, http.StatusUnauthorized, "unauthorized", "Authentication required")
return
}
pin, err := h.service.CreatePlexPin(r.Context(), userID)
if err != nil {
slog.ErrorContext(r.Context(), "history import plex pin creation failed", "component", "api", "user_id", userID, "error", err)
h.writeHistoryImportError(w, err)
return
}
writeJSON(w, http.StatusOK, pin)
}
func (h *HistoryImportHandler) HandleCheckPlexPin(w http.ResponseWriter, r *http.Request) {
userID := apimw.GetUserID(r.Context())
if userID == 0 {
writeError(w, http.StatusUnauthorized, "unauthorized", "Authentication required")
return
}
var req historyimport.PlexCheckRequest
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid request body")
return
}
if req.SessionID == "" {
writeError(w, http.StatusBadRequest, "bad_request", "session_id is required")
return
}
result, err := h.service.CheckPlexPin(r.Context(), userID, req.SessionID)
if err != nil {
h.writeHistoryImportError(w, err)
return
}
writeJSON(w, http.StatusOK, result)
}
func (h *HistoryImportHandler) HandleAdminListSources(w http.ResponseWriter, r *http.Request) {
sources, err := h.service.ListAdminSources(r.Context())
if err != nil {
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to list history import sources")
return
}
writeJSON(w, http.StatusOK, sources)
}
func (h *HistoryImportHandler) HandleAdminCreateSource(w http.ResponseWriter, r *http.Request) {
var req historyimport.CreateSourceInput
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid request body")
return
}
source, err := h.service.CreateSource(r.Context(), req)
if err != nil {
h.writeHistoryImportError(w, err)
return
}
writeJSON(w, http.StatusCreated, source)
}
func (h *HistoryImportHandler) HandleAdminUpdateSource(w http.ResponseWriter, r *http.Request) {
id, err := parseHistoryImportID(r)
if err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid source ID")
return
}
var req historyimport.UpdateSourceInput
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid request body")
return
}
source, err := h.service.UpdateSource(r.Context(), id, req)
if err != nil {
h.writeHistoryImportError(w, err)
return
}
writeJSON(w, http.StatusOK, source)
}
func (h *HistoryImportHandler) HandleAdminDeleteSource(w http.ResponseWriter, r *http.Request) {
id, err := parseHistoryImportID(r)
if err != nil {
writeError(w, http.StatusBadRequest, "bad_request", "Invalid source ID")
return
}
if err := h.service.DeleteSource(r.Context(), id); err != nil {
h.writeHistoryImportError(w, err)
return
}
w.WriteHeader(http.StatusNoContent)
}
func (h *HistoryImportHandler) writeHistoryImportError(w http.ResponseWriter, err error) {
switch {
case errors.Is(err, historyimport.ErrSourceNotFound),
errors.Is(err, historyimport.ErrRunNotFound),
errors.Is(err, historyimport.ErrProfileNotFound),
errors.Is(err, historyimport.ErrConnectSessionNotFound),
errors.Is(err, historyimport.ErrPlexSessionNotFound),
errors.Is(err, historyimport.ErrMappingNotFound):
writeError(w, http.StatusNotFound, "not_found", err.Error())
case errors.Is(err, historyimport.ErrConnectSessionExpired),
errors.Is(err, historyimport.ErrConnectSessionUsed),
errors.Is(err, historyimport.ErrPlexSessionExpired),
errors.Is(err, historyimport.ErrPlexSessionUsed),
errors.Is(err, historyimport.ErrNoAdminToken):
writeError(w, http.StatusBadRequest, "bad_request", err.Error())
case errors.Is(err, historyimport.ErrActiveRunExists),
errors.Is(err, historyimport.ErrMappingDuplicate):
writeError(w, http.StatusConflict, "conflict", err.Error())
default:
if status := historyimport.UpstreamHTTPStatus(err); status > 0 {
httpStatus, code, message := historyImportUpstreamError(status)
writeError(w, httpStatus, code, message)
return
}
if err != nil && looksLikeValidationError(err) {
writeError(w, http.StatusBadRequest, "bad_request", err.Error())
return
}
slog.Error("history import: unhandled error", "error", err)
writeError(w, http.StatusInternalServerError, "internal_error", "History import request failed")
}
}
func historyImportUpstreamError(status int) (int, string, string) {
switch {
case status == http.StatusUnauthorized:
return http.StatusUnauthorized, "unauthorized", "Couldn't connect to that server. Check the URL, username, and password and try again."
case status >= 400 && status < 500:
return http.StatusBadRequest, "bad_request", "Couldn't start the import with those server settings."
default:
return http.StatusBadGateway, "bad_gateway", "The source server couldn't complete the import right now. Please try again."
}
}
func parseHistoryImportID(r *http.Request) (int, error) {
id, err := strconv.Atoi(chi.URLParam(r, "id"))
if err != nil || id <= 0 {
return 0, fmt.Errorf("invalid id")
}
return id, nil
}
func looksLikeValidationError(err error) bool {
message := err.Error()
return message == "profile_id is required" ||
message == "unsupported source type" ||
message == "direct server_url imports are no longer supported" ||
message == "exactly one of connect_session_id or source_id is required" ||
message == "selected server not found in connect session" ||
message == "selected server does not expose a usable address" ||
message == "jellyfin_base_url, jellyfin_username, and jellyfin_password are required" ||
message == "source_id is required" ||
message == "username and password are required" ||
message == "name, source_type, and base_url are required" ||
message == "plex OAuth not completed yet" ||
message == "selected Plex server not found in session" ||
message == "selected Plex server has no usable address" ||
message == "plex_token is required for predefined Plex sources" ||
message == "source is not a Plex server" ||
message == "plex_session_id or source_id is required for Plex imports"
}