Files
silo-server/internal/audiobooks/abs/rss_feeds_handler.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

240 lines
7.7 KiB
Go

package abs
import (
"crypto/rand"
"encoding/json"
"errors"
"io"
"log/slog"
"net/http"
"regexp"
"strconv"
"strings"
"time"
"github.com/go-chi/chi/v5"
"github.com/oklog/ulid/v2"
"github.com/Silo-Server/silo-server/internal/models"
)
var slugRe = regexp.MustCompile(`^[a-z0-9-]{4,64}$`)
type feedOpenBody struct {
Slug string `json:"slug"`
Minified bool `json:"minified"`
}
func (h *Handler) handleListRSSFeeds(w http.ResponseWriter, r *http.Request) {
a, ok := absAuthFrom(r)
if !ok || a.UserID == "" {
http.Error(w, "unauthorized", http.StatusUnauthorized)
return
}
if h.deps.RSSFeedStore == nil {
writeJSON(w, http.StatusOK, map[string]any{"feeds": []any{}})
return
}
rows, err := h.deps.RSSFeedStore.ListUserFeeds(r.Context(), a.UserID, a.ProfileID)
if err != nil {
slog.ErrorContext(r.Context(), "abs feed list failed", "component", "audiobooks", "err", err, "user", a.UserID)
http.Error(w, "feed list failed", http.StatusInternalServerError)
return
}
base := h.absBaseURL(r)
out := make([]map[string]any, 0, len(rows))
for _, f := range rows {
out = append(out, rssFeedToABS(f, base))
}
writeJSON(w, http.StatusOK, map[string]any{"feeds": out})
}
func (h *Handler) handleOpenItemFeed(w http.ResponseWriter, r *http.Request) {
a, ok := absAuthFrom(r)
if !ok || a.UserID == "" {
http.Error(w, "unauthorized", http.StatusUnauthorized)
return
}
if h.deps.RSSFeedStore == nil {
http.Error(w, "feed store unavailable", http.StatusServiceUnavailable)
return
}
itemID := chi.URLParam(r, "itemId")
access, err := h.accessFilterForAuth(r.Context(), a)
if err != nil {
http.Error(w, "resolve access: "+err.Error(), http.StatusForbidden)
return
}
item, err := h.deps.MediaStore.GetAudiobookByID(r.Context(), itemID, access)
if err != nil || item == nil {
http.Error(w, "item not found", http.StatusNotFound)
return
}
var body feedOpenBody
_ = json.NewDecoder(io.LimitReader(r.Body, 1<<20)).Decode(&body)
slug := strings.ToLower(strings.TrimSpace(body.Slug))
if slug == "" {
slug = randomSlug()
} else if !slugRe.MatchString(slug) {
http.Error(w, "invalid slug", http.StatusBadRequest)
return
}
f := RSSFeed{
ID: ulid.Make().String(),
UserID: a.UserID,
ProfileID: a.ProfileID,
LibraryItemID: itemID,
Slug: slug,
Minified: body.Minified,
}
if err := h.deps.RSSFeedStore.CreateFeed(r.Context(), f); err != nil {
if strings.Contains(err.Error(), "duplicate key") || strings.Contains(err.Error(), "unique") {
http.Error(w, "slug taken", http.StatusConflict)
return
}
slog.ErrorContext(r.Context(), "abs feed create failed", "component", "audiobooks", "err", err, "user", a.UserID)
http.Error(w, "feed persist failed", http.StatusInternalServerError)
return
}
persisted, err := h.deps.RSSFeedStore.GetFeed(r.Context(), f.ID)
if errors.Is(err, ErrNotFound) || err != nil {
f.CreatedAt = time.Now()
persisted = f
}
writeJSON(w, http.StatusOK, rssFeedToABS(persisted, h.absBaseURL(r)))
}
func (h *Handler) handleCloseFeed(w http.ResponseWriter, r *http.Request) {
a, ok := absAuthFrom(r)
if !ok || a.UserID == "" {
http.Error(w, "unauthorized", http.StatusUnauthorized)
return
}
if h.deps.RSSFeedStore == nil {
http.Error(w, "feed not found", http.StatusNotFound)
return
}
id := chi.URLParam(r, "id")
f, err := h.deps.RSSFeedStore.GetFeed(r.Context(), id)
if errors.Is(err, ErrNotFound) || (err == nil && !sameABSPrincipal(a, f.UserID, f.ProfileID)) {
http.Error(w, "feed not found", http.StatusNotFound)
return
}
if err != nil {
slog.ErrorContext(r.Context(), "abs feed get-for-close failed", "component", "audiobooks", "err", err, "id", id)
http.Error(w, "feed get failed", http.StatusInternalServerError)
return
}
if err := h.deps.RSSFeedStore.CloseFeed(r.Context(), id); err != nil {
slog.ErrorContext(r.Context(), "abs feed close failed", "component", "audiobooks", "err", err, "id", id)
http.Error(w, "feed close failed", http.StatusInternalServerError)
return
}
w.WriteHeader(http.StatusNoContent)
}
func randomSlug() string {
const alphabet = "abcdefghijklmnopqrstuvwxyz0123456789"
buf := make([]byte, 16)
_, _ = rand.Read(buf)
for i, b := range buf {
buf[i] = alphabet[int(b)%len(alphabet)]
}
return string(buf)
}
// handlePublicFeed — GET /feed/{slug}.xml and GET /feed/{slug}.
// Public, no auth. The slug is the capability token.
func (h *Handler) handlePublicFeed(w http.ResponseWriter, r *http.Request) {
if h.deps.RSSFeedStore == nil {
http.Error(w, "feed not found", http.StatusNotFound)
return
}
slug := strings.TrimSuffix(chi.URLParam(r, "slug"), ".xml")
f, err := h.deps.RSSFeedStore.GetFeedBySlug(r.Context(), slug)
if errors.Is(err, ErrNotFound) || (err == nil && f.ClosedAt != nil) {
http.Error(w, "feed not found", http.StatusNotFound)
return
}
if err != nil {
slog.ErrorContext(r.Context(), "abs public feed get failed", "component", "audiobooks", "err", err, "slug", slug)
http.Error(w, "feed get failed", http.StatusInternalServerError)
return
}
item, err := h.deps.MediaStore.GetAudiobookByID(r.Context(), f.LibraryItemID, emptyAccessFilter())
if err != nil || item == nil {
http.Error(w, "feed item not found", http.StatusNotFound)
return
}
files, _ := h.deps.MediaStore.GetMediaFiles(r.Context(), f.LibraryItemID, emptyAccessFilter())
base := h.absBaseURL(r)
xml := renderFeedXML(f, item, files, base)
w.Header().Set("Content-Type", "application/rss+xml; charset=utf-8")
_, _ = w.Write([]byte(xml))
}
// renderFeedXML builds a minimal RSS 2.0 + iTunes document.
func renderFeedXML(f RSSFeed, item *models.MediaItem, files []*models.MediaFile, baseURL string) string {
var b strings.Builder
b.WriteString(`<?xml version="1.0" encoding="UTF-8"?>` + "\n")
b.WriteString(`<rss version="2.0" xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd">` + "\n")
b.WriteString("<channel>\n")
b.WriteString("<title>" + xmlEscape(item.Title) + "</title>\n")
b.WriteString("<link>" + xmlEscape(baseURL+"/feed/"+f.Slug+".xml") + "</link>\n")
b.WriteString("<description>silo audiobook feed</description>\n")
for _, mf := range files {
enc := baseURL + "/feed/" + f.Slug + "/file/" + strconv.Itoa(mf.ID)
b.WriteString("<item>\n")
b.WriteString("<title>" + xmlEscape(item.Title) + "</title>\n")
b.WriteString(`<enclosure url="` + xmlEscape(enc) + `" type="audio/mpeg" length="0"/>` + "\n")
b.WriteString("<guid>" + xmlEscape(f.Slug+"-"+strconv.Itoa(mf.ID)) + "</guid>\n")
b.WriteString("</item>\n")
}
b.WriteString("</channel>\n")
b.WriteString("</rss>\n")
return b.String()
}
func xmlEscape(s string) string {
r := strings.NewReplacer("&", "&amp;", "<", "&lt;", ">", "&gt;", `"`, "&quot;")
return r.Replace(s)
}
// handlePublicFeedFile — GET /feed/{slug}/file/{ino}. Streams the
// media file when the slug is valid + open and the ino belongs to
// the underlying library item.
func (h *Handler) handlePublicFeedFile(w http.ResponseWriter, r *http.Request) {
if h.deps.RSSFeedStore == nil {
http.Error(w, "feed not found", http.StatusNotFound)
return
}
slug := chi.URLParam(r, "slug")
f, err := h.deps.RSSFeedStore.GetFeedBySlug(r.Context(), slug)
if errors.Is(err, ErrNotFound) || (err == nil && f.ClosedAt != nil) {
http.Error(w, "feed not found", http.StatusNotFound)
return
}
if err != nil {
http.Error(w, "feed get failed", http.StatusInternalServerError)
return
}
inoStr := chi.URLParam(r, "ino")
ino, parseErr := strconv.Atoi(inoStr)
if parseErr != nil {
http.Error(w, "invalid ino", http.StatusBadRequest)
return
}
mf, mfErr := h.deps.MediaStore.GetMediaFileByID(r.Context(), ino)
if mfErr != nil || mf == nil || mf.ContentID != f.LibraryItemID {
http.Error(w, "file not found", http.StatusNotFound)
return
}
http.ServeFile(w, r, mf.FilePath)
}