argoyle
49eedd3782
Bring the auth and logging libs up to the otelsetup/authz_client standard: golangci-lint + .editorconfig + .testcoverage.yml + cliff.toml + renovate.json + CHANGELOG + CLAUDE.md + pre-commit and Release workflows. Replace the minimal test-only CI with a cache-based coverage-regression gate (PR test job restores main's baseline from the Actions cache; a non-gating post-merge coverage-baseline job records it) mirroring the services (ADR-0010 carve-out). Job names test/vulnerabilities preserved to match branch-protection contexts.
2.1 KiB
2.1 KiB
logging
Shared Go library with logging primitives for all Shiny backend services.
Shared Documentation
@../docs/claude/architecture.md @../docs/claude/go-services.md @../docs/claude/conventions.md
Library Information
Purpose
Single home for the slog setup, context-logger helpers, request-logging
middleware and the MockLogger test helper that were previously copied (with
drift) into every backend service.
Usage
import (
"gitea.unbound.se/shiny/logging"
logmw "gitea.unbound.se/shiny/logging/middleware"
)
// Configure the slog default logger (format: text | json | otel).
logger := logging.SetupLogger(cli.LogLevel, cli.LogFormat, serviceName, buildVersion)
// Carry a logger on the request context.
ctx = logging.ContextWithLogger(ctx, logger)
logger = logging.LoggerFromContext(ctx)
// Debug-log request/response bodies.
handler = logmw.RequestLogger(logger)(handler)
In tests:
m := logging.NewMockLogger()
// ... exercise code with m.Logger() ...
m.Check(t, []string{"level=INFO msg=\"...\""})
Exported API
SetupLogger(logLevel, logFormat, serviceName, buildVersion string) *slog.LoggerContextWithLogger(ctx, *slog.Logger) context.Context/LoggerFromContext(ctx) *slog.LoggerLoggerinterface;NewMockLogger() *MockLogger(+MockLogger.Logger(),MockLogger.Check(t, want)).logging/middleware.RequestLogger(logger) func(http.Handler) http.Handler.
Notes
MockLoggercurrently lives in the main package, sotestifyis a non-test dependency of the module. Moving it to alogging/logtestsub-package is a tracked low-priority follow-up — it's a breaking import change for the ~13 services that referencelogging.NewMockLogger, so it is deferred until a coordinated bump (Ambix 019ecabc).
Conventions
Standard Shiny library scaffolding: gofumpt/goimports -local, golangci-lint,
gitleaks and conventional-commit checks via pre-commit; coverage-regression gate
in CI (.testcoverage.yml); releases auto-tagged from conventional commits by
the shared Release workflow. Bump the consuming services' go.mod after a
release.