* 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>
183 lines
5.9 KiB
Go
183 lines
5.9 KiB
Go
package abs
|
|
|
|
import (
|
|
"encoding/json"
|
|
"io"
|
|
"log/slog"
|
|
"math"
|
|
"net/http"
|
|
"strconv"
|
|
|
|
"github.com/go-chi/chi/v5"
|
|
)
|
|
|
|
// bookmarkBody is the JSON body for POST and PATCH
|
|
// /me/item/{itemId}/bookmark. Time is a pointer so we can distinguish
|
|
// missing (→ 400) from the literal 0.0.
|
|
type bookmarkBody struct {
|
|
Title string `json:"title"`
|
|
Time *float64 `json:"time"`
|
|
}
|
|
|
|
// handleUpsertBookmark backs both POST (reason="bookmark_created") and
|
|
// PATCH (reason="bookmark_updated") /me/item/{itemId}/bookmark. Both
|
|
// share the exact same upsert semantics — only the realtime event
|
|
// reason differs.
|
|
func (h *Handler) handleUpsertBookmark(reason string) http.HandlerFunc {
|
|
return func(w http.ResponseWriter, r *http.Request) {
|
|
a, ok := absAuthFrom(r)
|
|
if !ok || a.UserID == "" {
|
|
http.Error(w, "unauthorized", http.StatusUnauthorized)
|
|
return
|
|
}
|
|
if h.deps.BookmarkStore == nil {
|
|
http.Error(w, "bookmark store unavailable", http.StatusServiceUnavailable)
|
|
return
|
|
}
|
|
|
|
itemID := chi.URLParam(r, "itemId")
|
|
if itemID == "" {
|
|
http.Error(w, "itemId required", http.StatusBadRequest)
|
|
return
|
|
}
|
|
|
|
// 1 MiB body cap — matches handleStandaloneLogin.
|
|
var body bookmarkBody
|
|
dec := json.NewDecoder(io.LimitReader(r.Body, 1<<20))
|
|
if err := dec.Decode(&body); err != nil {
|
|
http.Error(w, "invalid body", http.StatusBadRequest)
|
|
return
|
|
}
|
|
if body.Time == nil || math.IsNaN(*body.Time) {
|
|
http.Error(w, "time required", http.StatusBadRequest)
|
|
return
|
|
}
|
|
|
|
// Item validation: avoid orphan bookmark rows whose item no
|
|
// longer exists. Skipped on DELETE (see handleDeleteBookmark).
|
|
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 {
|
|
slog.ErrorContext(r.Context(), "abs bookmark item lookup failed", "component", "audiobooks", "err", err, "user", a.UserID, "item", itemID)
|
|
http.Error(w, "item lookup failed", http.StatusInternalServerError)
|
|
return
|
|
}
|
|
if item == nil {
|
|
http.Error(w, "item not found", http.StatusNotFound)
|
|
return
|
|
}
|
|
|
|
bm, err := h.deps.BookmarkStore.Upsert(r.Context(), a.UserID, a.ProfileID, itemID, *body.Time, body.Title)
|
|
if err != nil {
|
|
slog.ErrorContext(r.Context(), "abs bookmark upsert failed", "component", "audiobooks", "err", err, "user", a.UserID, "item", itemID)
|
|
http.Error(w, "bookmark persist failed", http.StatusInternalServerError)
|
|
return
|
|
}
|
|
|
|
h.publish(a.UserID, "user_updated", map[string]any{
|
|
"reason": reason,
|
|
"bookmark": bookmarkToABS(bm),
|
|
})
|
|
|
|
writeBookmarkList(w, r, h, a.UserID, a.ProfileID, itemID)
|
|
}
|
|
}
|
|
|
|
// handleDeleteBookmark — DELETE /me/item/{itemId}/bookmark/{time}.
|
|
//
|
|
// Idempotent: returns 200 with the caller's current bookmark list,
|
|
// whether or not the (item, time) row existed. Crucially, this means
|
|
// a DELETE against another user's bookmark returns the caller's own
|
|
// (empty-or-other) list — no enumeration vector.
|
|
//
|
|
// Item validation is intentionally skipped: a bookmark whose item was
|
|
// just deleted should still be removable. (Upsert keeps validation
|
|
// because it would create a new orphan row.)
|
|
func (h *Handler) handleDeleteBookmark(w http.ResponseWriter, r *http.Request) {
|
|
a, ok := absAuthFrom(r)
|
|
if !ok || a.UserID == "" {
|
|
http.Error(w, "unauthorized", http.StatusUnauthorized)
|
|
return
|
|
}
|
|
if h.deps.BookmarkStore == nil {
|
|
http.Error(w, "bookmark store unavailable", http.StatusServiceUnavailable)
|
|
return
|
|
}
|
|
|
|
itemID := chi.URLParam(r, "itemId")
|
|
if itemID == "" {
|
|
http.Error(w, "itemId required", http.StatusBadRequest)
|
|
return
|
|
}
|
|
t, ok := parseBookmarkTime(chi.URLParam(r, "time"))
|
|
if !ok {
|
|
http.Error(w, "time required", http.StatusBadRequest)
|
|
return
|
|
}
|
|
|
|
// Snapshot the pre-delete row so the realtime payload carries the
|
|
// title that just got removed (clients prefer this over a bare ID).
|
|
var pre Bookmark
|
|
if rows, err := h.deps.BookmarkStore.List(r.Context(), a.UserID, a.ProfileID, itemID); err == nil {
|
|
for _, b := range rows {
|
|
if b.Time == t {
|
|
pre = b
|
|
break
|
|
}
|
|
}
|
|
}
|
|
|
|
if err := h.deps.BookmarkStore.Delete(r.Context(), a.UserID, a.ProfileID, itemID, t); err != nil {
|
|
slog.ErrorContext(r.Context(), "abs bookmark delete failed", "component", "audiobooks", "err", err, "user", a.UserID, "item", itemID)
|
|
http.Error(w, "bookmark delete failed", http.StatusInternalServerError)
|
|
return
|
|
}
|
|
|
|
// Only publish when the row actually existed (pre.ID is empty
|
|
// otherwise). Avoids notifying other devices about a phantom delete.
|
|
if pre.ID != "" {
|
|
h.publish(a.UserID, "user_updated", map[string]any{
|
|
"reason": "bookmark_deleted",
|
|
"bookmark": bookmarkToABS(pre),
|
|
})
|
|
}
|
|
|
|
writeBookmarkList(w, r, h, a.UserID, a.ProfileID, itemID)
|
|
}
|
|
|
|
// parseBookmarkTime parses the {time} URL parameter on DELETE
|
|
// /me/item/{itemId}/bookmark/{time}. Returns (0, false) on parse
|
|
// failure.
|
|
func parseBookmarkTime(s string) (float64, bool) {
|
|
if s == "" {
|
|
return 0, false
|
|
}
|
|
v, err := strconv.ParseFloat(s, 64)
|
|
if err != nil || math.IsNaN(v) || math.IsInf(v, 0) {
|
|
return 0, false
|
|
}
|
|
return v, true
|
|
}
|
|
|
|
// writeBookmarkList re-fetches the item's bookmarks and writes them as
|
|
// the JSON response. On list-fetch failure after a successful mutation,
|
|
// degrade to 200 + empty list + slog.Warn (the mutation already
|
|
// committed; failing the response would mis-report the state).
|
|
func writeBookmarkList(w http.ResponseWriter, r *http.Request, h *Handler, userID, profileID, itemID string) {
|
|
rows, err := h.deps.BookmarkStore.List(r.Context(), userID, profileID, itemID)
|
|
if err != nil {
|
|
slog.WarnContext(r.Context(), "abs bookmark list after mutation failed", "component", "audiobooks", "err", err, "user", userID, "item", itemID)
|
|
writeJSON(w, http.StatusOK, []any{})
|
|
return
|
|
}
|
|
out := make([]map[string]any, 0, len(rows))
|
|
for _, b := range rows {
|
|
out = append(out, bookmarkToABS(b))
|
|
}
|
|
writeJSON(w, http.StatusOK, out)
|
|
}
|