* 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>
168 lines
5.5 KiB
Go
168 lines
5.5 KiB
Go
package abs
|
|
|
|
import (
|
|
"errors"
|
|
"log/slog"
|
|
"net/http"
|
|
"net/url"
|
|
|
|
"github.com/go-chi/chi/v5"
|
|
)
|
|
|
|
func (h *Handler) handleAuthorDetail(w http.ResponseWriter, r *http.Request) {
|
|
a, ok := absAuthFrom(r)
|
|
if !ok || a.UserID == "" {
|
|
http.Error(w, "unauthorized", http.StatusUnauthorized)
|
|
return
|
|
}
|
|
id := chi.URLParam(r, "id")
|
|
access, err := h.accessFilterForAuth(r.Context(), a)
|
|
if err != nil {
|
|
slog.WarnContext(r.Context(), "abs author access resolution failed", "component", "audiobooks", "err", err, "id", id)
|
|
http.Error(w, "forbidden", http.StatusForbidden)
|
|
return
|
|
}
|
|
author, err := h.deps.MediaStore.GetAuthorByID(r.Context(), id, access)
|
|
if errors.Is(err, ErrNotFound) {
|
|
http.Error(w, "author not found", http.StatusNotFound)
|
|
return
|
|
}
|
|
if err != nil {
|
|
slog.ErrorContext(r.Context(), "abs author detail failed", "component", "audiobooks", "err", err, "id", id)
|
|
http.Error(w, "author get failed", http.StatusInternalServerError)
|
|
return
|
|
}
|
|
lib := h.resolveDefaultLibrary(r.Context(), access)
|
|
writeJSON(w, http.StatusOK, authorToABS(author, lib, h.absBaseURL(r)))
|
|
}
|
|
|
|
func (h *Handler) handleSeriesDetail(w http.ResponseWriter, r *http.Request) {
|
|
a, ok := absAuthFrom(r)
|
|
if !ok || a.UserID == "" {
|
|
http.Error(w, "unauthorized", http.StatusUnauthorized)
|
|
return
|
|
}
|
|
idRaw := chi.URLParam(r, "id")
|
|
id, err := url.PathUnescape(idRaw)
|
|
if err != nil {
|
|
id = idRaw
|
|
}
|
|
access, err := h.accessFilterForAuth(r.Context(), a)
|
|
if err != nil {
|
|
slog.WarnContext(r.Context(), "abs series access resolution failed", "component", "audiobooks", "err", err, "id", id)
|
|
http.Error(w, "forbidden", http.StatusForbidden)
|
|
return
|
|
}
|
|
series, err := h.deps.MediaStore.GetSeriesByName(r.Context(), id, access)
|
|
if errors.Is(err, ErrNotFound) {
|
|
http.Error(w, "series not found", http.StatusNotFound)
|
|
return
|
|
}
|
|
if err != nil {
|
|
slog.ErrorContext(r.Context(), "abs series detail failed", "component", "audiobooks", "err", err, "id", id)
|
|
http.Error(w, "series get failed", http.StatusInternalServerError)
|
|
return
|
|
}
|
|
lib := h.resolveDefaultLibrary(r.Context(), access)
|
|
writeJSON(w, http.StatusOK, seriesToABS(series, lib, h.absBaseURL(r)))
|
|
}
|
|
|
|
// authorObjectABS builds the real ABS Author.toOldJSON(+numBooks) shape
|
|
// (server/models/Author.js). silo does not track asin/description/timestamps,
|
|
// so those are emitted as null/0 — nullable in real ABS, and a present key
|
|
// (not its value) is what keeps strict clients from crashing. imagePath is
|
|
// a server-local filesystem path in real ABS; clients treat any non-null
|
|
// value as "this author has a photo" and fetch it via
|
|
// GET /api/authors/{id}/image rather than dereferencing the path, so a
|
|
// synthetic ABS-shaped path is emitted when silo has a photo for the person.
|
|
func authorObjectABS(id, name, libraryID string, numBooks int, hasPhoto bool) map[string]any {
|
|
var imagePath any
|
|
if hasPhoto {
|
|
imagePath = "/metadata/authors/" + id + ".jpg"
|
|
}
|
|
return map[string]any{
|
|
"id": id,
|
|
"asin": nil,
|
|
"name": name,
|
|
"description": nil,
|
|
"imagePath": imagePath,
|
|
"libraryId": libraryID,
|
|
"addedAt": 0,
|
|
"updatedAt": 0,
|
|
"numBooks": numBooks,
|
|
}
|
|
}
|
|
|
|
func authorToABS(a Author, lib AudiobookLibrary, baseURL string) map[string]any {
|
|
libID := audiobookLibraryID(lib)
|
|
obj := authorObjectABS(a.ID, a.Name, libID, len(a.Books), a.PosterPath != "")
|
|
// Author-detail books are full minified library items (not thin stubs) so
|
|
// any strict client decodes them with its LibraryItem model.
|
|
books := make([]MinifiedLibraryItem, 0, len(a.Books))
|
|
for _, b := range a.Books {
|
|
books = append(books, Minify(siloItemToLibraryItem(b, lib, baseURL)))
|
|
}
|
|
obj["libraryItems"] = books
|
|
return obj
|
|
}
|
|
|
|
// seriesObjectABS builds the real ABS Series.toOldJSON shape
|
|
// (server/models/Series.js). description/timestamps are absent in silo's
|
|
// catalog → null/0.
|
|
func seriesObjectABS(id, name, libraryID string, numBooks int) map[string]any {
|
|
return map[string]any{
|
|
"id": id,
|
|
"name": name,
|
|
"nameIgnorePrefix": titleIgnorePrefix(name),
|
|
"description": nil,
|
|
"addedAt": 0,
|
|
"updatedAt": 0,
|
|
"libraryId": libraryID,
|
|
"numBooks": numBooks,
|
|
}
|
|
}
|
|
|
|
func seriesToABS(s Series, lib AudiobookLibrary, baseURL string) map[string]any {
|
|
libID := audiobookLibraryID(lib)
|
|
obj := seriesObjectABS(s.ID, s.Name, libID, len(s.Books))
|
|
books := make([]MinifiedLibraryItem, 0, len(s.Books))
|
|
for _, b := range s.Books {
|
|
books = append(books, Minify(siloItemToLibraryItem(b, lib, baseURL)))
|
|
}
|
|
obj["books"] = books
|
|
return obj
|
|
}
|
|
|
|
// seriesBookMinified builds a full real-ABS minified library item from the
|
|
// limited fields the series-LIST query carries (no full MediaItem). Every
|
|
// required minified key is present with a safe placeholder so strict clients
|
|
// (Plappa) decode the series card's books[] without crashing.
|
|
func seriesBookMinified(contentID, title, libID, baseURL string, updatedAtMs int64) MinifiedLibraryItem {
|
|
return MinifiedLibraryItem{
|
|
ID: contentID,
|
|
Ino: contentID,
|
|
LibraryID: libID,
|
|
FolderID: VirtualFolderID,
|
|
IsFile: true,
|
|
MtimeMs: updatedAtMs,
|
|
CtimeMs: updatedAtMs,
|
|
BirthtimeMs: updatedAtMs,
|
|
AddedAt: updatedAtMs,
|
|
UpdatedAt: updatedAtMs,
|
|
MediaType: LibraryMediaType,
|
|
Media: minifiedMedia{
|
|
ID: contentID,
|
|
Metadata: minifiedMetadata{
|
|
Title: title,
|
|
TitleIgnorePrefix: titleIgnorePrefix(title),
|
|
Genres: []string{},
|
|
},
|
|
CoverPath: baseURL + "/api/items/" + contentID + "/cover",
|
|
Tags: []string{},
|
|
NumTracks: 1,
|
|
NumAudioFiles: 1,
|
|
},
|
|
NumFiles: 1,
|
|
}
|
|
}
|