* 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>
145 lines
4.0 KiB
Go
145 lines
4.0 KiB
Go
package handlers
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"log/slog"
|
|
"net/http"
|
|
"time"
|
|
|
|
"github.com/google/uuid"
|
|
|
|
"github.com/Silo-Server/silo-server/internal/playback"
|
|
)
|
|
|
|
var ErrServerRestartAlreadyRequested = errors.New("server restart already requested")
|
|
|
|
type ServerControlHandler struct {
|
|
requestRestart func(ctx context.Context) error
|
|
commands *playback.CommandDispatcher
|
|
restartStatus *ServerRestartStatusTracker
|
|
}
|
|
|
|
type serverRestartRequest struct {
|
|
Reason string `json:"reason"`
|
|
Title string `json:"title"`
|
|
Message string `json:"message"`
|
|
}
|
|
|
|
type serverRestartResponse struct {
|
|
Status string `json:"status"`
|
|
Message string `json:"message"`
|
|
NotifiedSessions int `json:"notified_sessions"`
|
|
}
|
|
|
|
func NewServerControlHandler(
|
|
requestRestart func(ctx context.Context) error,
|
|
commands *playback.CommandDispatcher,
|
|
restartStatus *ServerRestartStatusTracker,
|
|
) *ServerControlHandler {
|
|
return &ServerControlHandler{
|
|
requestRestart: requestRestart,
|
|
commands: commands,
|
|
restartStatus: restartStatus,
|
|
}
|
|
}
|
|
|
|
// HandleRestart handles POST /admin/server/restart.
|
|
func (h *ServerControlHandler) HandleRestart(w http.ResponseWriter, r *http.Request) {
|
|
if h == nil || h.requestRestart == nil {
|
|
writeError(w, http.StatusServiceUnavailable, "service_unavailable", "Server restart is unavailable")
|
|
return
|
|
}
|
|
|
|
var req serverRestartRequest
|
|
if err := decodeOptionalJSONBody(r, &req); err != nil {
|
|
writeError(w, http.StatusBadRequest, "bad_request", "Invalid request body")
|
|
return
|
|
}
|
|
|
|
notifiedSessions := h.notifyPlaybackSessions(req)
|
|
|
|
if err := h.requestRestart(context.Background()); err != nil {
|
|
if errors.Is(err, ErrServerRestartAlreadyRequested) {
|
|
h.restartStatus.MarkRestartRequested()
|
|
writeJSON(w, http.StatusAccepted, serverRestartResponse{
|
|
Status: "already_requested",
|
|
Message: "Server restart is already in progress.",
|
|
NotifiedSessions: notifiedSessions,
|
|
})
|
|
return
|
|
}
|
|
slog.ErrorContext(r.Context(), "server restart request failed", "component", "api", "error", err)
|
|
writeError(w, http.StatusInternalServerError, "internal_error", "Failed to request server restart")
|
|
return
|
|
}
|
|
|
|
h.restartStatus.MarkRestartRequested()
|
|
writeJSON(w, http.StatusAccepted, serverRestartResponse{
|
|
Status: "restart_requested",
|
|
Message: "Server restart requested. The process will shut down gracefully.",
|
|
NotifiedSessions: notifiedSessions,
|
|
})
|
|
}
|
|
|
|
func (h *ServerControlHandler) notifyPlaybackSessions(req serverRestartRequest) int {
|
|
if h == nil || h.commands == nil {
|
|
return 0
|
|
}
|
|
|
|
title := req.Title
|
|
if title == "" {
|
|
title = "Server restarting"
|
|
}
|
|
message := req.Message
|
|
if message == "" {
|
|
message = "The server is restarting now. Playback may reconnect shortly."
|
|
}
|
|
|
|
payload, err := json.Marshal(map[string]string{
|
|
"title": title,
|
|
"message": message,
|
|
})
|
|
if err != nil {
|
|
slog.Warn("server restart: failed to build realtime payload", "error", err)
|
|
return 0
|
|
}
|
|
|
|
results := h.commands.DispatchToAll(func(session *playback.Session) (playback.CommandEnvelope, time.Duration, func(), error) {
|
|
if session == nil {
|
|
return playback.CommandEnvelope{}, 0, nil, playback.ErrCommandDispatchUnavailable
|
|
}
|
|
command, err := playback.NewCommandEnvelope(
|
|
session.ID,
|
|
uuid.NewString(),
|
|
playback.CommandServerRestarting,
|
|
payload,
|
|
)
|
|
if err != nil {
|
|
return playback.CommandEnvelope{}, 0, nil, err
|
|
}
|
|
command.Reason = req.Reason
|
|
if command.Reason == "" {
|
|
command.Reason = "server_restart_requested"
|
|
}
|
|
command.IssuedBy = &playback.CommandIssuedBy{Kind: "admin"}
|
|
return command, 0, nil, nil
|
|
})
|
|
|
|
delivered := 0
|
|
for _, result := range results {
|
|
if result.Delivered {
|
|
delivered++
|
|
continue
|
|
}
|
|
if result.DispatchErr != nil && !errors.Is(result.DispatchErr, playback.ErrRealtimeConnectionNotFound) {
|
|
slog.Warn("server restart: failed to notify playback session",
|
|
"session_id", result.SessionID,
|
|
"error", result.DispatchErr,
|
|
)
|
|
}
|
|
}
|
|
return delivered
|
|
}
|