* 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>
122 lines
3.4 KiB
Go
122 lines
3.4 KiB
Go
package abs
|
|
|
|
import (
|
|
"bufio"
|
|
"errors"
|
|
"log/slog"
|
|
"net"
|
|
"net/http"
|
|
"strings"
|
|
"time"
|
|
)
|
|
|
|
// accessLog is a minimal chi middleware that emits one structured line
|
|
// per request. The 2xx/3xx path logs at Debug so a default-Info runtime
|
|
// stays quiet during normal playback; non-2xx escalates to Warn so
|
|
// failures still surface without an explicit log-level flip. Path is
|
|
// captured query-less; the query is logged separately with
|
|
// credential-bearing params redacted (see sanitizedQuery) so ?token=
|
|
// and refresh tokens never land in logs.
|
|
// sanitizedQuery renders the request query string with credential-bearing
|
|
// params redacted, so pagination/sort/filter params are visible in debug
|
|
// logs without ever landing tokens there.
|
|
func sanitizedQuery(r *http.Request) string {
|
|
q := r.URL.Query()
|
|
if len(q) == 0 {
|
|
return ""
|
|
}
|
|
for k := range q {
|
|
switch strings.ToLower(k) {
|
|
case "token", "apikey", "api_key":
|
|
q.Set(k, "REDACTED")
|
|
}
|
|
}
|
|
return q.Encode()
|
|
}
|
|
|
|
func (h *Handler) accessLog(next http.Handler) http.Handler {
|
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
start := time.Now()
|
|
sw := &statusRecorder{ResponseWriter: w, status: 200}
|
|
next.ServeHTTP(sw, r)
|
|
|
|
auth := r.Header.Get("Authorization")
|
|
authKind := "none"
|
|
switch {
|
|
case strings.HasPrefix(auth, "Bearer "):
|
|
authKind = "bearer"
|
|
case auth != "":
|
|
authKind = "other"
|
|
case r.URL.Query().Get("token") != "":
|
|
authKind = "qtok"
|
|
}
|
|
|
|
// Short-circuit asset requests the mobile app never hits to keep
|
|
// the signal-to-noise high.
|
|
path := r.URL.Path
|
|
if strings.HasPrefix(path, "/assets/") {
|
|
return
|
|
}
|
|
|
|
args := []any{
|
|
"method", r.Method,
|
|
"path", path,
|
|
"auth", authKind,
|
|
"status", sw.status,
|
|
"dur_ms", time.Since(start).Milliseconds(),
|
|
}
|
|
if q := sanitizedQuery(r); q != "" {
|
|
args = append(args, "query", q)
|
|
}
|
|
if ua := r.Header.Get("User-Agent"); ua != "" {
|
|
args = append(args, "ua", ua)
|
|
}
|
|
if sw.status >= 400 {
|
|
slog.WarnContext(r.Context(), "abs req failed", append([]any{"component", "audiobooks"}, args...)...)
|
|
return
|
|
}
|
|
slog.DebugContext(r.Context(), "abs req", append([]any{"component", "audiobooks"}, append(args, "bytes", sw.bytes)...)...)
|
|
})
|
|
}
|
|
|
|
// statusRecorder lets the access log read the status code + bytes
|
|
// written without re-implementing http.ResponseWriter.
|
|
type statusRecorder struct {
|
|
http.ResponseWriter
|
|
status int
|
|
bytes int
|
|
}
|
|
|
|
func (s *statusRecorder) WriteHeader(code int) {
|
|
s.status = code
|
|
s.ResponseWriter.WriteHeader(code)
|
|
}
|
|
|
|
func (s *statusRecorder) Write(b []byte) (int, error) {
|
|
n, err := s.ResponseWriter.Write(b)
|
|
s.bytes += n
|
|
return n, err
|
|
}
|
|
|
|
// Hijack passes through to the wrapped ResponseWriter so socket.io
|
|
// WebSocket upgrades can take ownership of the raw connection.
|
|
// Without this, the underlying engine.io transport sees a
|
|
// ResponseWriter that doesn't satisfy http.Hijacker and rejects the
|
|
// upgrade with `{"code":3,"message":"Bad request"}`.
|
|
func (s *statusRecorder) Hijack() (net.Conn, *bufio.ReadWriter, error) {
|
|
h, ok := s.ResponseWriter.(http.Hijacker)
|
|
if !ok {
|
|
return nil, nil, errors.New("ResponseWriter does not implement http.Hijacker")
|
|
}
|
|
return h.Hijack()
|
|
}
|
|
|
|
// Flush passes through to the wrapped ResponseWriter so chunked /
|
|
// server-sent-events responses (engine.io polling long-poll) flush
|
|
// promptly.
|
|
func (s *statusRecorder) Flush() {
|
|
if f, ok := s.ResponseWriter.(http.Flusher); ok {
|
|
f.Flush()
|
|
}
|
|
}
|