telemetry/logging: share the slog setup every service builds by hand

Abierto
#360 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
go

Línea de trabajo

Start with the existing telemetry/logging package and the dependent work in #359, then compare the logging implementations named in the issue: openndx-core internal/logging, nsw-srilanka internal/bootstrap/logging.go, and agency backend/internal/logging. Review openndx-core#708 for its logging rules and tests. Done means a shared setup covers the listed configuration, trace IDs, optional OTLP export with level filtering, common service attributes, and the default logger and correlation ID wiring; several design decisions and consumer migrations remain.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Type/Improvement
Current Limitation

Every OpenNSW service builds its slog setup by hand. All of them build the same chain: base handler → trace ID decorator → (optional) OTLP export → slog.SetDefault → httputil.CorrelationIDFunc. Each one does it a little differently:

openndx-core internal/logging nsw-srilanka internal/bootstrap/logging.go agency backend/internal/logging
Level from config logging.level server.logLevel Not configurable
Format json or text, configurable text only json only
service / environment / version on every line Yes No No
Trace ID decorator (trace/logging) No Yes Yes
httputil.CorrelationIDFunc wired No Yes Yes
OTLP log export (otelslog + slog.NewMultiHandler) No Yes No
Level filter in front of otelslog — Yes —
AddSource at debug No Yes No

So:

  • A combined log stream can't be filtered by service, because only one of the three adds service, and its value isn't tied to the OTel service.name.
  • Fixes stay where they were found. nsw-srilanka found that otelslog reports every level as enabled, so behind slog.NewMultiHandler the multi-handler's Enabled is true for DEBUG even when the configured level is INFO. DEBUG records were exported and debug-gated payload logging turned on. Its levelFilter fixes this. Any other service that adds OTLP log export will hit the same bug.
  • Config keys and defaults differ (logging.level vs server.logLevel, json vs text), so operators configure each service differently.
Suggested Improvement

Add the logging setup to telemetry/logging, beside the trace_id / span_id decorator from #359.

package logging // github.com/OpenNSW/core/telemetry/logging

// Config is the logging section of a service's config file.
type Config struct {
	// Level is debug, info, warn or error. Default info.
	Level string `yaml:"level"`
	// Format is json or text. Default json.
	Format string `yaml:"format"`
}

// DefaultConfig returns the values used for keys the config file leaves out.
func DefaultConfig() Config

// Validate reports an unknown level or format.
func (c Config) Validate() error

// Setup builds the logger, sets it as slog's default and returns it. cfg must be valid.
func Setup(cfg Config, p *telemetry.Provider) *slog.Logger

// NewHandler adds trace_id and span_id from the span in ctx (#359).
func NewHandler(next slog.Handler) slog.Handler

Setup builds:

  1. slog.JSONHandler or slog.TextHandler on stdout, at cfg.Level, with AddSource at debug
  2. NewHandler around it, for trace_id / span_id
  3. When p exports logs over OTLP: p.SlogHandler() behind a level filter and NewHandler, fanned out with slog.NewMultiHandler
  4. service, environment and version attributes, taken from the same values as the Provider's resource (service.name, deployment.environment, service.version), so the log field and the OTel attribute can't drift
  5. slog.SetDefault, and httputil.CorrelationIDFunc = telemetry.TraceID

Each main then has:

p, err := telemetry.Start(ctx, cfg.Telemetry)
// ...
logging.Setup(cfg.Logging, p)

Service-specific behavior stays in the service, such as nsw-srilanka's warning that audit records are suppressed above info.

Consumers to migrate

  • openndx/openndx-core: internal/logging (openndx/openndx-core#708) is deleted, and cmd/<service>/main.go calls logging.Setup.
  • OpenNSW/nsw-srilanka: internal/bootstrap/logging.go, including levelFilter. server.logLevel either moves to a logging section or is mapped into logging.Config by its config code.
  • OpenNSW/agency: backend/internal/logging.

Decisions to settle in review

  1. Default format: json (openndx-core, agency) or text (nsw-srilanka). Suggest json for production, since log pipelines parse it.
  2. Config key: logging.level / logging.format as one section, or leave each service to map its own keys into Config.
  3. Is Setup usable without telemetry? For example with p == nil it writes stdout only and adds no trace IDs. Or does every service start telemetry first?
Version

github.com/OpenNSW/core/trace v0.2.0

Additional Context
  • Depends on #359 for telemetry.Provider, telemetry.TraceID and telemetry/logging.NewHandler.
  • openndx/openndx-core#708 has a description of openndx's logging rules (one setup, one global logger, ...Context calls, common fields). Its internal/logging package is the starting point for Config, Validate and the common fields.
Lenguaje dominante
Go
Estrellas
6
Forks
8
Merge medio
21 h 36 min
PR fusionados (30 d)
42

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de OpenNSW/core

Todos los issues de OpenNSW/core

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.