* 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>
195 lines
5.3 KiB
Go
195 lines
5.3 KiB
Go
package handlers
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"log/slog"
|
|
"net/http"
|
|
"sync"
|
|
|
|
"github.com/go-chi/chi/v5"
|
|
"github.com/gorilla/websocket"
|
|
|
|
apimw "github.com/Silo-Server/silo-server/internal/api/middleware"
|
|
"github.com/Silo-Server/silo-server/internal/playback"
|
|
)
|
|
|
|
type realtimeClientMessage struct {
|
|
Type playback.RealtimeMessageType `json:"type"`
|
|
}
|
|
|
|
type sessionRealtimeConn struct {
|
|
conn *websocket.Conn
|
|
writeMu sync.Mutex
|
|
}
|
|
|
|
func (c *sessionRealtimeConn) WriteJSON(v any) error {
|
|
if c == nil || c.conn == nil {
|
|
return playback.ErrRealtimeConnectionNotFound
|
|
}
|
|
|
|
c.writeMu.Lock()
|
|
defer c.writeMu.Unlock()
|
|
return writeWebSocketJSON(c.conn, v)
|
|
}
|
|
|
|
func (c *sessionRealtimeConn) WritePing() error {
|
|
if c == nil || c.conn == nil {
|
|
return playback.ErrRealtimeConnectionNotFound
|
|
}
|
|
|
|
c.writeMu.Lock()
|
|
defer c.writeMu.Unlock()
|
|
return writeWebSocketControl(c.conn, websocket.PingMessage, nil)
|
|
}
|
|
|
|
// HandleSessionWebSocket handles GET /playback/ws/{session_id}.
|
|
// It upgrades to a realtime control WebSocket. Sessions become control-ready
|
|
// only after a validated hello message. Disconnects degrade command delivery
|
|
// but do not stop an otherwise valid playback session.
|
|
func (h *PlaybackHandler) HandleSessionWebSocket(w http.ResponseWriter, r *http.Request) {
|
|
if h == nil || h.RealtimeHub == nil {
|
|
http.Error(w, "realtime unavailable", http.StatusServiceUnavailable)
|
|
return
|
|
}
|
|
|
|
userID := apimw.GetUserID(r.Context())
|
|
if userID == 0 {
|
|
http.Error(w, "unauthorized", http.StatusUnauthorized)
|
|
return
|
|
}
|
|
|
|
sessionID := chi.URLParam(r, "session_id")
|
|
if sessionID == "" {
|
|
http.Error(w, "session_id required", http.StatusBadRequest)
|
|
return
|
|
}
|
|
setPlaybackSessionLogContext(r, sessionID)
|
|
|
|
session, err := h.sessionMgr.GetSession(sessionID)
|
|
if err != nil {
|
|
writePlaybackSessionNotFound(w)
|
|
return
|
|
}
|
|
if session.UserID != userID {
|
|
http.Error(w, "forbidden", http.StatusForbidden)
|
|
return
|
|
}
|
|
|
|
conn, err := wsUpgrader.Upgrade(w, r, nil)
|
|
if err != nil {
|
|
slog.ErrorContext(r.Context(), "websocket upgrade failed", "component", "api", "error", err, "session", sessionID, "playback_session_id", sessionID)
|
|
return
|
|
}
|
|
|
|
realtimeConn := &sessionRealtimeConn{conn: conn}
|
|
registration := h.RealtimeHub.Register(sessionID, realtimeConn)
|
|
if registration == nil {
|
|
conn.Close()
|
|
slog.WarnContext(r.Context(), "failed to register realtime websocket", "component", "api", "session", sessionID, "playback_session_id", sessionID)
|
|
return
|
|
}
|
|
|
|
defer func() {
|
|
if h.setRealtimeConnectionState(sessionID, false) {
|
|
h.syncSessionsNow(context.Background(), "realtime_disconnect")
|
|
}
|
|
h.RealtimeHub.Unregister(registration)
|
|
_ = conn.Close()
|
|
}()
|
|
|
|
configureWebSocket(conn)
|
|
ctx, cancelRead := context.WithCancel(r.Context())
|
|
defer cancelRead()
|
|
startWebSocketPingLoop(ctx, realtimeConn.WritePing)
|
|
|
|
for {
|
|
_, data, err := conn.ReadMessage()
|
|
if err != nil {
|
|
break
|
|
}
|
|
if err := h.handleRealtimeClientMessage(sessionID, data); err != nil {
|
|
slog.WarnContext(r.Context(), "invalid realtime client message", "component", "api", "session", sessionID, "playback_session_id", sessionID, "error", err)
|
|
}
|
|
}
|
|
}
|
|
|
|
func (h *PlaybackHandler) handleRealtimeClientMessage(sessionID string, data []byte) error {
|
|
var base realtimeClientMessage
|
|
if err := json.Unmarshal(data, &base); err != nil {
|
|
return err
|
|
}
|
|
|
|
switch base.Type {
|
|
case playback.RealtimeMessageTypeHello:
|
|
var hello playback.HelloEnvelope
|
|
if err := json.Unmarshal(data, &hello); err != nil {
|
|
return err
|
|
}
|
|
if err := hello.Validate(); err != nil {
|
|
return err
|
|
}
|
|
if hello.SessionID != sessionID {
|
|
return playback.ErrInvalidRealtimePayload
|
|
}
|
|
if h.setRealtimeConnectionState(sessionID, true) {
|
|
h.syncSessionsNow(context.Background(), "realtime_hello")
|
|
}
|
|
h.touchSessionActivity(sessionID)
|
|
return nil
|
|
case playback.RealtimeMessageTypeAck:
|
|
var ack playback.AckEnvelope
|
|
if err := json.Unmarshal(data, &ack); err != nil {
|
|
return err
|
|
}
|
|
if err := ack.Validate(); err != nil {
|
|
return err
|
|
}
|
|
if ack.SessionID != sessionID {
|
|
return playback.ErrInvalidRealtimePayload
|
|
}
|
|
h.touchSessionActivity(sessionID)
|
|
if h.CommandTracker != nil {
|
|
h.CommandTracker.Ack(ack.CommandID)
|
|
}
|
|
return nil
|
|
case playback.RealtimeMessageTypeResult:
|
|
var result playback.ResultEnvelope
|
|
if err := json.Unmarshal(data, &result); err != nil {
|
|
return err
|
|
}
|
|
if err := result.Validate(); err != nil {
|
|
return err
|
|
}
|
|
if result.SessionID != sessionID {
|
|
return playback.ErrInvalidRealtimePayload
|
|
}
|
|
h.touchSessionActivity(sessionID)
|
|
if h.CommandTracker != nil {
|
|
h.CommandTracker.Result(result.CommandID)
|
|
}
|
|
record, ok := h.getRealtimeCommand(result.CommandID)
|
|
if !ok {
|
|
return nil
|
|
}
|
|
h.forgetRealtimeCommand(result.CommandID)
|
|
if record.SessionID != sessionID {
|
|
return playback.ErrInvalidRealtimePayload
|
|
}
|
|
if result.Status != playback.RealtimeResultStatusCompleted {
|
|
return nil
|
|
}
|
|
switch record.Name {
|
|
case playback.CommandStop, playback.CommandTerminate:
|
|
err := h.stopPlaybackSessionByID(context.Background(), sessionID, true)
|
|
if err != nil && !errors.Is(err, playback.ErrSessionNotFound) {
|
|
slog.Error("failed to stop playback after realtime completion", "session", sessionID, "playback_session_id", sessionID, "error", err)
|
|
}
|
|
}
|
|
return nil
|
|
default:
|
|
return playback.ErrInvalidRealtimePayload
|
|
}
|
|
}
|