* 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>
300 lines
10 KiB
Go
300 lines
10 KiB
Go
package handlers
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"log/slog"
|
|
"net/http"
|
|
"strconv"
|
|
|
|
"github.com/go-chi/chi/v5"
|
|
|
|
"github.com/Silo-Server/silo-server/internal/access"
|
|
apimw "github.com/Silo-Server/silo-server/internal/api/middleware"
|
|
"github.com/Silo-Server/silo-server/internal/catalog"
|
|
"github.com/Silo-Server/silo-server/internal/metadata/translation"
|
|
"github.com/Silo-Server/silo-server/internal/models"
|
|
)
|
|
|
|
type metadataAIItemAccess interface {
|
|
GetByID(ctx context.Context, contentID string) (*models.MediaItem, error)
|
|
EnsureAccessible(ctx context.Context, contentID string, filter catalog.AccessFilter) error
|
|
}
|
|
|
|
type metadataAISeasonLookup interface {
|
|
GetByID(ctx context.Context, contentID string) (*models.Season, error)
|
|
}
|
|
|
|
type metadataAIEpisodeLookup interface {
|
|
GetByID(ctx context.Context, contentID string) (*models.Episode, error)
|
|
}
|
|
|
|
type metadataAITarget struct {
|
|
kind translation.TargetKind
|
|
accessContentID string
|
|
}
|
|
|
|
// MetadataAIHandler exposes AI translation of catalog descriptions into the
|
|
// localization tables. The admin routes are mounted under the per-item
|
|
// metadata curation guard; the on-view route is viewer-facing and enforces
|
|
// item access itself.
|
|
type MetadataAIHandler struct {
|
|
service *translation.Service
|
|
// ItemAccess authorizes the viewer-facing on-view route; nil disables it.
|
|
ItemAccess metadataAIItemAccess
|
|
// SeasonLookup and EpisodeLookup let the viewer route resolve non-item
|
|
// detail pages to the parent series for authorization.
|
|
SeasonLookup metadataAISeasonLookup
|
|
EpisodeLookup metadataAIEpisodeLookup
|
|
}
|
|
|
|
// NewMetadataAIHandler creates a handler backed by the given service.
|
|
func NewMetadataAIHandler(service *translation.Service) *MetadataAIHandler {
|
|
return &MetadataAIHandler{service: service}
|
|
}
|
|
|
|
// HandleStatus reports whether metadata AI translation is available and the
|
|
// viewer-facing on-view mode, so the metadata editor and detail pages can
|
|
// show or hide their entry points.
|
|
// GET /api/v1/metadata/ai/status
|
|
func (h *MetadataAIHandler) HandleStatus(w http.ResponseWriter, r *http.Request) {
|
|
writeJSON(w, http.StatusOK, map[string]any{
|
|
"enabled": h.service.Enabled(),
|
|
"on_view": h.service.OnViewMode(),
|
|
})
|
|
}
|
|
|
|
// WriteMetadataAIDisabledStatus answers the status probe with a clean negative
|
|
// when no metadata AI handler is wired.
|
|
func WriteMetadataAIDisabledStatus(w http.ResponseWriter, _ *http.Request) {
|
|
writeJSON(w, http.StatusOK, map[string]any{"enabled": false, "on_view": "off"})
|
|
}
|
|
|
|
type translateDescriptionRequest struct {
|
|
// TargetLanguage echoes the detail response's pending_translation_language.
|
|
TargetLanguage string `json:"target_language"`
|
|
}
|
|
|
|
// HandleTranslateOnView is the viewer-facing on-demand description
|
|
// translation: any profile that can access the item may request its
|
|
// descriptions in the language the detail response reported missing. Gated by
|
|
// metadata_ai.on_view; duplicate viewers collapse onto one job and recently
|
|
// failed targets are not retried (cooldown in the service).
|
|
// POST /api/v1/items/{id}/translate-description
|
|
func (h *MetadataAIHandler) HandleTranslateOnView(w http.ResponseWriter, r *http.Request) {
|
|
contentID := chi.URLParam(r, "id")
|
|
var req translateDescriptionRequest
|
|
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
|
|
writeError(w, http.StatusBadRequest, "invalid_request", "Invalid request body")
|
|
return
|
|
}
|
|
if req.TargetLanguage == "" {
|
|
writeError(w, http.StatusBadRequest, "bad_request", "target_language is required")
|
|
return
|
|
}
|
|
|
|
scope, ok := access.GetScope(r.Context())
|
|
if !ok || h.ItemAccess == nil {
|
|
writeError(w, http.StatusForbidden, "forbidden", "Viewer access is required")
|
|
return
|
|
}
|
|
filter := catalog.AccessFilter{
|
|
AllowedLibraryIDs: scope.AllowedLibraryIDs,
|
|
DisabledLibraryIDs: scope.DisabledLibraryIDs,
|
|
MaxContentRating: scope.MaxContentRating,
|
|
UserID: scope.UserID,
|
|
ProfileID: scope.ProfileID,
|
|
}
|
|
target, err := h.resolveTranslationTarget(r.Context(), contentID)
|
|
if err != nil {
|
|
if errors.Is(err, catalog.ErrItemNotFound) {
|
|
writeError(w, http.StatusNotFound, "not_found", "Item not found")
|
|
return
|
|
}
|
|
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to authorize item")
|
|
return
|
|
}
|
|
if err := h.ItemAccess.EnsureAccessible(r.Context(), target.accessContentID, filter); err != nil {
|
|
if errors.Is(err, catalog.ErrItemNotFound) {
|
|
writeError(w, http.StatusNotFound, "not_found", "Item not found")
|
|
return
|
|
}
|
|
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to authorize item")
|
|
return
|
|
}
|
|
|
|
var requestedBy *int
|
|
if userID := apimw.GetUserID(r.Context()); userID != 0 {
|
|
requestedBy = &userID
|
|
}
|
|
|
|
job, err := h.service.RequestOnView(r.Context(), target.kind, contentID, req.TargetLanguage, requestedBy)
|
|
if err != nil {
|
|
switch {
|
|
case errors.Is(err, translation.ErrNotConfigured):
|
|
writeError(w, http.StatusServiceUnavailable, "not_configured",
|
|
"On-view translation is not enabled on this server")
|
|
case errors.Is(err, translation.ErrInvalidRequest):
|
|
writeError(w, http.StatusBadRequest, "bad_request", err.Error())
|
|
default:
|
|
slog.ErrorContext(r.Context(), "failed to request on-view translation", "component", "api",
|
|
"content_id", contentID, "error", err)
|
|
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to start translation")
|
|
}
|
|
return
|
|
}
|
|
|
|
writeJSON(w, http.StatusAccepted, map[string]any{"job": job})
|
|
}
|
|
|
|
func (h *MetadataAIHandler) resolveTranslationTarget(ctx context.Context, contentID string) (metadataAITarget, error) {
|
|
if h.ItemAccess == nil {
|
|
return metadataAITarget{}, catalog.ErrItemNotFound
|
|
}
|
|
|
|
item, err := h.ItemAccess.GetByID(ctx, contentID)
|
|
switch {
|
|
case err == nil:
|
|
if item == nil {
|
|
return metadataAITarget{}, catalog.ErrItemNotFound
|
|
}
|
|
return metadataAITarget{kind: translation.TargetItem, accessContentID: contentID}, nil
|
|
case !errors.Is(err, catalog.ErrItemNotFound):
|
|
return metadataAITarget{}, err
|
|
}
|
|
|
|
if h.SeasonLookup != nil {
|
|
season, err := h.SeasonLookup.GetByID(ctx, contentID)
|
|
switch {
|
|
case err == nil:
|
|
if season == nil {
|
|
return metadataAITarget{}, catalog.ErrItemNotFound
|
|
}
|
|
return metadataAITarget{kind: translation.TargetSeason, accessContentID: season.SeriesID}, nil
|
|
case !errors.Is(err, catalog.ErrSeasonNotFound):
|
|
return metadataAITarget{}, err
|
|
}
|
|
}
|
|
|
|
if h.EpisodeLookup != nil {
|
|
episode, err := h.EpisodeLookup.GetByID(ctx, contentID)
|
|
switch {
|
|
case err == nil:
|
|
if episode == nil {
|
|
return metadataAITarget{}, catalog.ErrItemNotFound
|
|
}
|
|
return metadataAITarget{kind: translation.TargetEpisode, accessContentID: episode.SeriesID}, nil
|
|
case !errors.Is(err, catalog.ErrEpisodeNotFound):
|
|
return metadataAITarget{}, err
|
|
}
|
|
}
|
|
|
|
return metadataAITarget{}, catalog.ErrItemNotFound
|
|
}
|
|
|
|
type translateMetadataRequest struct {
|
|
TargetLanguage string `json:"target_language"`
|
|
IncludeChildren *bool `json:"include_children"` // default true
|
|
Force bool `json:"force"`
|
|
}
|
|
|
|
// HandleTranslate enqueues a translation job for an item.
|
|
// POST /api/v1/admin/items/{id}/metadata-translation
|
|
func (h *MetadataAIHandler) HandleTranslate(w http.ResponseWriter, r *http.Request) {
|
|
contentID := chi.URLParam(r, "id")
|
|
var req translateMetadataRequest
|
|
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
|
|
writeError(w, http.StatusBadRequest, "invalid_request", "Invalid request body")
|
|
return
|
|
}
|
|
if req.TargetLanguage == "" {
|
|
writeError(w, http.StatusBadRequest, "bad_request", "target_language is required")
|
|
return
|
|
}
|
|
target, err := h.resolveTranslationTarget(r.Context(), contentID)
|
|
if err != nil {
|
|
if errors.Is(err, catalog.ErrItemNotFound) {
|
|
writeError(w, http.StatusNotFound, "not_found", "Item not found")
|
|
return
|
|
}
|
|
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to resolve item")
|
|
return
|
|
}
|
|
includeChildren := target.kind == translation.TargetItem
|
|
if req.IncludeChildren != nil {
|
|
includeChildren = *req.IncludeChildren && target.kind == translation.TargetItem
|
|
}
|
|
|
|
var requestedBy *int
|
|
if userID := apimw.GetUserID(r.Context()); userID != 0 {
|
|
requestedBy = &userID
|
|
}
|
|
|
|
job, err := h.service.Enqueue(r.Context(), translation.JobRequest{
|
|
TargetKind: target.kind,
|
|
ContentID: contentID,
|
|
TargetLanguage: req.TargetLanguage,
|
|
IncludeChildren: includeChildren,
|
|
Force: req.Force,
|
|
RequestedBy: requestedBy,
|
|
})
|
|
if err != nil {
|
|
switch {
|
|
case errors.Is(err, translation.ErrNotConfigured):
|
|
writeError(w, http.StatusServiceUnavailable, "not_configured",
|
|
"Metadata AI translation is not configured on this server")
|
|
case errors.Is(err, translation.ErrInvalidRequest):
|
|
writeError(w, http.StatusBadRequest, "bad_request", err.Error())
|
|
default:
|
|
slog.ErrorContext(r.Context(), "failed to enqueue metadata translation", "component", "api",
|
|
"content_id", contentID, "error", err)
|
|
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to start translation")
|
|
}
|
|
return
|
|
}
|
|
|
|
writeJSON(w, http.StatusAccepted, map[string]any{"job": job})
|
|
}
|
|
|
|
// HandleListJobs lists recent translation jobs for an item; the metadata
|
|
// editor polls this for progress.
|
|
// GET /api/v1/admin/items/{id}/metadata-translation/jobs
|
|
func (h *MetadataAIHandler) HandleListJobs(w http.ResponseWriter, r *http.Request) {
|
|
jobs, err := h.service.ListJobs(r.Context(), chi.URLParam(r, "id"))
|
|
if err != nil {
|
|
writeError(w, http.StatusInternalServerError, "list_error", "Failed to list jobs")
|
|
return
|
|
}
|
|
writeJSON(w, http.StatusOK, map[string]any{"jobs": jobs})
|
|
}
|
|
|
|
// HandleCancelJob cancels a job belonging to the item in the URL.
|
|
// POST /api/v1/admin/items/{id}/metadata-translation/jobs/{job_id}/cancel
|
|
func (h *MetadataAIHandler) HandleCancelJob(w http.ResponseWriter, r *http.Request) {
|
|
jobID, err := strconv.ParseInt(chi.URLParam(r, "job_id"), 10, 64)
|
|
if err != nil {
|
|
writeError(w, http.StatusBadRequest, "invalid_id", "Invalid job ID")
|
|
return
|
|
}
|
|
job, err := h.service.GetJob(r.Context(), jobID)
|
|
if err != nil {
|
|
if errors.Is(err, translation.ErrJobNotFound) {
|
|
writeError(w, http.StatusNotFound, "not_found", "Job not found")
|
|
return
|
|
}
|
|
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to load job")
|
|
return
|
|
}
|
|
// The curation guard authorized {id}; the job must belong to it.
|
|
if job.ContentID != chi.URLParam(r, "id") {
|
|
writeError(w, http.StatusNotFound, "not_found", "Job not found")
|
|
return
|
|
}
|
|
if err := h.service.Cancel(r.Context(), jobID); err != nil {
|
|
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to cancel job")
|
|
return
|
|
}
|
|
w.WriteHeader(http.StatusNoContent)
|
|
}
|