* 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>
97 lines
2.5 KiB
Go
97 lines
2.5 KiB
Go
package adminjob
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"log/slog"
|
|
)
|
|
|
|
const JobTypeImageCacheCleanup = "image_cache_cleanup"
|
|
|
|
type ImageCacheCleanupRequest struct {
|
|
LibraryID int `json:"library_id"`
|
|
LibraryName string `json:"library_name"`
|
|
Prefixes []string `json:"prefixes"`
|
|
}
|
|
|
|
type ImageCacheCleanupResult struct {
|
|
LibraryID int `json:"library_id"`
|
|
LibraryName string `json:"library_name"`
|
|
DeletedPrefixes int `json:"deleted_prefixes"`
|
|
DeletedS3Objects int `json:"deleted_s3_objects"`
|
|
}
|
|
|
|
type imageCacheCleanupExecutor interface {
|
|
Execute(ctx context.Context, req ImageCacheCleanupRequest, progress func(current, total int, message string)) (*ImageCacheCleanupResult, error)
|
|
}
|
|
|
|
type ImageCacheCleanupExecutor struct {
|
|
s3 S3PrefixDeleter
|
|
}
|
|
|
|
func NewImageCacheCleanupExecutor(s3 S3PrefixDeleter) *ImageCacheCleanupExecutor {
|
|
if s3 == nil {
|
|
return nil
|
|
}
|
|
return &ImageCacheCleanupExecutor{s3: s3}
|
|
}
|
|
|
|
func (e *ImageCacheCleanupExecutor) Execute(
|
|
ctx context.Context,
|
|
req ImageCacheCleanupRequest,
|
|
progress func(current, total int, message string),
|
|
) (*ImageCacheCleanupResult, error) {
|
|
if e == nil || e.s3 == nil {
|
|
return nil, fmt.Errorf("image cache cleanup executor is not configured")
|
|
}
|
|
if len(req.Prefixes) == 0 {
|
|
return &ImageCacheCleanupResult{
|
|
LibraryID: req.LibraryID,
|
|
LibraryName: req.LibraryName,
|
|
DeletedPrefixes: 0,
|
|
DeletedS3Objects: 0,
|
|
}, nil
|
|
}
|
|
|
|
total := len(req.Prefixes)
|
|
deletedPrefixes := 0
|
|
deletedObjects := 0
|
|
bucket := e.s3.Bucket()
|
|
|
|
for index, prefix := range req.Prefixes {
|
|
if progress != nil {
|
|
progress(index, total, fmt.Sprintf("Cleaning cached images %d/%d", index+1, total))
|
|
}
|
|
n, err := e.s3.DeletePrefix(ctx, bucket, prefix)
|
|
if err != nil {
|
|
slog.WarnContext(ctx, "image cache cleanup: s3 delete failed", "component", "adminjob", "prefix", prefix, "error", err)
|
|
continue
|
|
}
|
|
deletedPrefixes++
|
|
deletedObjects += n
|
|
}
|
|
|
|
if progress != nil {
|
|
progress(total, total, "Cached image cleanup completed")
|
|
}
|
|
|
|
return &ImageCacheCleanupResult{
|
|
LibraryID: req.LibraryID,
|
|
LibraryName: req.LibraryName,
|
|
DeletedPrefixes: deletedPrefixes,
|
|
DeletedS3Objects: deletedObjects,
|
|
}, nil
|
|
}
|
|
|
|
func decodeImageCacheCleanupRequest(data json.RawMessage) (ImageCacheCleanupRequest, error) {
|
|
var req ImageCacheCleanupRequest
|
|
if len(data) == 0 {
|
|
return req, fmt.Errorf("missing image cache cleanup payload")
|
|
}
|
|
if err := json.Unmarshal(data, &req); err != nil {
|
|
return req, fmt.Errorf("invalid image cache cleanup request payload: %w", err)
|
|
}
|
|
return req, nil
|
|
}
|