logging

Documentation

Overview

Package logging configures a structured zerolog logger and supplies an HTTP writer for shipping log lines to an arbitrary endpoint.

Index

• Variables
• func Configure(level zerolog.Level, writers ...io.Writer) io.Closer
• func ParseLevel(s string) (zerolog.Level, error)
• type HTTPWriter
  • func NewHTTPWriter(url, headerName, headerValue string) *HTTPWriter
  • func (h *HTTPWriter) Close() error
  • func (h *HTTPWriter) Write(p []byte) (int, error)
  • func (h *HTTPWriter) WriteLevel(level zerolog.Level, p []byte) (int, error)

Variables

var Logger = zerolog.Nop()

Logger is the engine's package-level logger. Call Configure once at boot to wire the writer graph; read it from anywhere in the engine layer

Functions

func Configure

func Configure(level zerolog.Level, writers ...io.Writer) io.Closer

Configure wires the package Logger. Call once from main before any code emits. Writers are fanned in via zerolog.MultiLevelWriter; an empty list discards. The returned io.Closer aggregates Close() over every writer that implements io.Closer.

func ParseLevel

func ParseLevel(s string) (zerolog.Level, error)

ParseLevel parses a case-insensitive level name. Empty input yields InfoLevel with no error so the default boot path stays clean.

Types

type HTTPWriter

type HTTPWriter struct {
	// contains filtered or unexported fields
}

HTTPWriter posts log lines to a configured URL. Implements zerolog.LevelWriter so Fatal events block until the POST completes while everything else is fire-and-forget.

func NewHTTPWriter

func NewHTTPWriter(url, headerName, headerValue string) *HTTPWriter

NewHTTPWriter constructs a writer that POSTs each log line to url. An empty headerName disables the auth header; otherwise headerValue is sent as headerName on every request.

func (*HTTPWriter) Close

func (h *HTTPWriter) Close() error

Close waits for in-flight goroutines, bounded by httpCloseTimeout.

func (*HTTPWriter) Write

func (h *HTTPWriter) Write(p []byte) (int, error)

Write sends p in a detached goroutine. Errors are dropped; the only contract is best-effort delivery.

func (*HTTPWriter) WriteLevel

func (h *HTTPWriter) WriteLevel(level zerolog.Level, p []byte) (int, error)

WriteLevel dispatches per level. Fatal sends synchronously so the log line lands before os.Exit fires inside zerolog's Fatal path.