Files
silo-server/internal/historyimport/service_admin.go
203a18ae83 feat(observability): OpenTelemetry logs+traces with secret redaction and slog standardization (#290)
* 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>
2026-07-09 08:53:52 -04:00

269 lines
8.2 KiB
Go

package historyimport
import (
"context"
"fmt"
"log/slog"
"github.com/google/uuid"
)
// AuthenticatePlex exchanges Plex username/password for an auth token via plex.tv.
func (s *Service) AuthenticatePlex(ctx context.Context, username, password string) (string, error) {
if username == "" || password == "" {
return "", fmt.Errorf("username and password are required")
}
return s.plex.Authenticate(ctx, username, password)
}
// SetSourceAdminToken stores an admin token for the given source.
func (s *Service) SetSourceAdminToken(ctx context.Context, sourceID int, token string) error {
if token == "" {
return fmt.Errorf("token must not be empty")
}
return s.repo.SetSourceAdminToken(ctx, sourceID, token)
}
// ClearSourceAdminToken removes the stored admin token from the given source.
func (s *Service) ClearSourceAdminToken(ctx context.Context, sourceID int) error {
return s.repo.ClearSourceAdminToken(ctx, sourceID)
}
// DiscoverExternalUsers queries the external server for its user list using the
// source's stored admin token.
func (s *Service) DiscoverExternalUsers(ctx context.Context, sourceID int) ([]ExternalUser, error) {
source, token, err := s.repo.GetSourceWithAdminToken(ctx, sourceID)
if err != nil {
return nil, err
}
if token == "" {
return nil, ErrNoAdminToken
}
switch source.SourceType {
case SourceTypeEmby:
return s.emby.ListUsers(ctx, source.BaseURL, token)
case SourceTypeJellyfin:
return s.jellyfin.ListUsers(ctx, source.BaseURL, token)
case SourceTypePlex:
return s.plex.ListAccounts(ctx, source.BaseURL, token)
default:
return nil, fmt.Errorf("unsupported source type: %s", source.SourceType)
}
}
// CreateMapping persists a new (source user → Silo user + profile) mapping.
func (s *Service) CreateMapping(ctx context.Context, input CreateMappingInput) (*UserMapping, error) {
if input.ExternalUserID == "" {
return nil, fmt.Errorf("external_user_id is required")
}
if input.SiloUserID == 0 {
return nil, fmt.Errorf("silo_user_id is required")
}
if input.SiloProfileID == "" {
return nil, fmt.Errorf("silo_profile_id is required")
}
exists, err := s.repo.ProfileExistsForUser(ctx, input.SiloUserID, input.SiloProfileID)
if err != nil {
return nil, err
}
if !exists {
return nil, ErrProfileNotFound
}
return s.repo.CreateMapping(ctx, input)
}
// ListMappings returns all mappings for a source, enriched with Silo user/profile names.
func (s *Service) ListMappings(ctx context.Context, sourceID int) ([]UserMapping, error) {
return s.repo.ListMappingsForSource(ctx, sourceID)
}
// UpdateMapping changes the Silo target of an existing mapping.
func (s *Service) UpdateMapping(ctx context.Context, id int, input UpdateMappingInput) (*UserMapping, error) {
if input.SiloUserID != nil && input.SiloProfileID != nil {
exists, err := s.repo.ProfileExistsForUser(ctx, *input.SiloUserID, *input.SiloProfileID)
if err != nil {
return nil, err
}
if !exists {
return nil, ErrProfileNotFound
}
}
return s.repo.UpdateMapping(ctx, id, input)
}
// DeleteMapping removes a mapping.
func (s *Service) DeleteMapping(ctx context.Context, id int) error {
return s.repo.DeleteMapping(ctx, id)
}
// GetMapping returns a single mapping by ID.
func (s *Service) GetMapping(ctx context.Context, id int) (*UserMapping, error) {
return s.repo.GetMappingByID(ctx, id)
}
// CreateAdminRun triggers an import for a single mapping using the source's admin token.
func (s *Service) CreateAdminRun(ctx context.Context, mappingID int) (*Run, error) {
mapping, err := s.repo.GetMappingByID(ctx, mappingID)
if err != nil {
return nil, err
}
// Prevent duplicate active runs for the same mapping.
active, err := s.repo.HasActiveRunForMapping(ctx, mappingID)
if err != nil {
return nil, err
}
if active {
return nil, ErrActiveRunExists
}
source, token, err := s.repo.GetSourceWithAdminToken(ctx, mapping.SourceID)
if err != nil {
return nil, err
}
if token == "" {
return nil, ErrNoAdminToken
}
if !source.Enabled {
return nil, fmt.Errorf("source is disabled")
}
provider, err := s.buildAdminProvider(source, token, mapping.ExternalUserID)
if err != nil {
return nil, err
}
run := Run{
ID: uuid.NewString(),
UserID: mapping.SiloUserID,
ProfileID: mapping.SiloProfileID,
SourceType: source.SourceType,
ConnectionMode: ConnectionModeAdminToken,
Status: RunStatusQueued,
MappingID: &mappingID,
Warnings: []string{},
UnmatchedSamples: []UnmatchedSample{},
}
created, err := s.repo.CreateRun(ctx, run)
if err != nil {
return nil, err
}
s.notifyRun(created)
go s.executeRun(created, provider)
return created, nil
}
// BulkCreateAdminRuns triggers imports for all eligible mappings on a source.
// Mappings that already have an active run are skipped. Errors on individual
// mappings are logged but do not abort the bulk operation.
func (s *Service) BulkCreateAdminRuns(ctx context.Context, sourceID int) (*BulkRunResult, error) {
source, token, err := s.repo.GetSourceWithAdminToken(ctx, sourceID)
if err != nil {
return nil, err
}
if token == "" {
return nil, ErrNoAdminToken
}
if !source.Enabled {
return nil, fmt.Errorf("source is disabled")
}
mappings, err := s.repo.ListMappingsForBulkRun(ctx, sourceID)
if err != nil {
return nil, err
}
result := &BulkRunResult{}
for _, mapping := range mappings {
mappingID := mapping.ID
provider, err := s.buildAdminProvider(source, token, mapping.ExternalUserID)
if err != nil {
slog.ErrorContext(ctx, "history import bulk: failed to build provider", "component", "historyimport", "mapping_id", mappingID, "error", err)
result.Errors++
continue
}
run := Run{
ID: uuid.NewString(),
UserID: mapping.SiloUserID,
ProfileID: mapping.SiloProfileID,
SourceType: source.SourceType,
ConnectionMode: ConnectionModeAdminToken,
Status: RunStatusQueued,
MappingID: &mappingID,
Warnings: []string{},
UnmatchedSamples: []UnmatchedSample{},
}
created, err := s.repo.CreateRun(ctx, run)
if err != nil {
slog.ErrorContext(ctx, "history import bulk: failed to create run", "component", "historyimport", "mapping_id", mappingID, "error", err)
result.Errors++
continue
}
s.notifyRun(created)
go s.executeRun(created, provider)
result.Runs = append(result.Runs, created)
}
return result, nil
}
// ListAdminRuns returns recent runs across all users. If sourceID is non-nil, only
// runs linked to that source (via mapping) are returned.
func (s *Service) ListAdminRuns(ctx context.Context, sourceID *int, limit int) ([]Run, error) {
if limit <= 0 {
limit = 25
}
if limit > 200 {
limit = 200
}
return s.repo.ListAllRuns(ctx, sourceID, limit)
}
func (s *Service) ListAdminActiveRuns(ctx context.Context, sourceID *int) ([]Run, error) {
return s.repo.ListActiveRuns(ctx, sourceID)
}
// GetAdminRun returns any run by ID regardless of which user owns it.
func (s *Service) GetAdminRun(ctx context.Context, runID string) (*Run, error) {
return s.repo.GetRunByID(ctx, runID)
}
// CancelAdminRun marks a queued or running run as failed and signals any in-process goroutine.
func (s *Service) CancelAdminRun(ctx context.Context, runID string) error {
if err := s.repo.CancelRunIfActive(ctx, runID); err != nil {
return err
}
// Signal in-process goroutine if it's running on this instance.
s.cancelRunInProcess(runID)
s.notifyRunByID(ctx, runID)
return nil
}
// buildAdminProvider constructs the appropriate Provider for an admin-initiated run.
func (s *Service) buildAdminProvider(source *Source, adminToken, externalUserID string) (Provider, error) {
switch source.SourceType {
case SourceTypeEmby:
auth := embyLocalAuth{
BaseURL: source.BaseURL,
UserID: externalUserID,
AccessToken: adminToken,
}
return NewEmbyProvider(s.emby, auth), nil
case SourceTypeJellyfin:
auth := jellyfinLocalAuth{
BaseURL: source.BaseURL,
UserID: externalUserID,
AccessToken: adminToken,
}
return NewJellyfinProvider(s.jellyfin, auth), nil
case SourceTypePlex:
return NewPlexAdminProvider(s.plex, source.BaseURL, adminToken, externalUserID), nil
default:
return nil, fmt.Errorf("unsupported source type: %s", source.SourceType)
}
}