Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

logger

package module

Go to main page

Versions in this module

v0

v0.2.0

May 3, 2026

Changes in this version

+ func BuildEffectiveSuffixes(cfg RedactionConfig) []string

+ func Reset()

+ func ValidateRedactionConfig(cfg RedactionConfig) error

type ConfigureOption

+ func WithAutoInjectTraceContext(enabled bool) ConfigureOption

+ func WithRedactionConfig(cfg RedactionConfig) ConfigureOption

type Logger

+ func (l *Logger) EffectiveSecretSuffixes() []string

+ func (l *Logger) SetRedactionSuffixes(suffixes []string)

+ type RedactionConfig struct

+ ExtraSuffixes []string

+ ReplaceDefaults bool

v0.1.1

May 3, 2026

v0.1.0

Apr 28, 2026

Changes in this version

+ const RedactedPlaceholder

+ const SeverityTextDebug

+ const SeverityTextError

+ const SeverityTextFatal

+ const SeverityTextInfo

+ const SeverityTextTrace

+ const SeverityTextWarn

+ var CanonicalSeverityTexts = [6]string

+ var DefaultBaggageKeys = []string

+ var DefaultSecretSuffixes = []string

+ func ActiveTraceContext(ctx context.Context) (traceID, spanID []byte, traceFlags uint8)

+ func CanonicalJSONMarshal(v any) ([]byte, error)

+ func CanonicalJSONMarshalString(v any) (string, error)

+ func Configure(opts ...ConfigureOption)

+ func DecodeSpanID(hexStr string) ([]byte, error)

+ func DecodeTraceID(hexStr string) ([]byte, error)

+ func EncodeSpanID(spanID []byte) (string, error)

+ func EncodeTraceID(traceID []byte) (string, error)

+ func IsCanonicalSeverityText(text string) bool

+ func IsSecretKey(key string, suffixes []string) bool

+ func IsValidSeverityNumber(severityNumber int) bool

+ func SeverityTextFor(severityNumber int) (string, error)

+ func ToDagstackJSONL(record *LogRecord) (string, error)

+ func ToDagstackJSONLDict(record *LogRecord) (map[string]any, error)

+ type Attrs = map[string]any

+ func RedactAttributes(attrs Attrs, suffixes []string) Attrs

+ type ConfigureOption func(*configureState)

+ func WithPerLoggerLevels(levels map[string]any) ConfigureOption

+ func WithResourceAttributes(attrs Attrs) ConfigureOption

+ func WithRootLevel(level any) ConfigureOption

+ func WithSinks(sinks ...Sink) ConfigureOption

+ type ConsoleMode int

+ const ConsoleAuto

+ const ConsoleJSON

+ const ConsolePretty

+ func (m ConsoleMode) String() string

+ type ConsoleSink struct

+ func NewConsoleSink(mode ConsoleMode, stream io.Writer, minSeverity int) *ConsoleSink

+ func (c *ConsoleSink) Close() error

+ func (c *ConsoleSink) Emit(record *LogRecord)

+ func (c *ConsoleSink) Flush(_ float64) error

+ func (c *ConsoleSink) ID() string

+ func (c *ConsoleSink) SupportsSeverity(severityNumber int) bool

+ type FileSink struct

+ func NewFileSink(path string, maxBytes int64, keep int, minSeverity int) (*FileSink, error)

+ func (s *FileSink) Close() error

+ func (s *FileSink) Emit(record *LogRecord)

+ func (s *FileSink) Flush(_ float64) error

+ func (s *FileSink) ID() string

+ func (s *FileSink) SupportsSeverity(severityNumber int) bool

+ type FlushFailure struct

+ Err error

+ SinkID string

+ type FlushResult struct

+ FailedSinks []FlushFailure

+ Partial bool

+ Success bool

+ type InMemorySink struct

+ func NewInMemorySink(capacity int, minSeverity int) *InMemorySink

+ func (s *InMemorySink) Capacity() int

+ func (s *InMemorySink) Clear()

+ func (s *InMemorySink) Close() error

+ func (s *InMemorySink) Emit(record *LogRecord)

+ func (s *InMemorySink) Flush(_ float64) error

+ func (s *InMemorySink) ID() string

+ func (s *InMemorySink) Records() []*LogRecord

+ func (s *InMemorySink) SupportsSeverity(severityNumber int) bool

+ type InstrumentationScope struct

+ Attributes Attrs

+ Name string

+ Version string

+ type LogRecord struct

+ Attributes Attrs

+ Body any

+ InstrumentationScope *InstrumentationScope

+ ObservedTimeUnixNano int64

+ Resource *Resource

+ SeverityNumber int

+ SeverityText string

+ SpanID []byte

+ TimeUnixNano int64

+ TraceFlags uint8

+ TraceID []byte

+ type Logger struct

+ func Get(name string) *Logger

+ func GetVersioned(name, version string) *Logger

+ func (l *Logger) AppendSinks(extra ...Sink) *Logger

+ func (l *Logger) Child(attrs Attrs) *Logger

+ func (l *Logger) Close() error

+ func (l *Logger) Debug(body any, attrs Attrs)

+ func (l *Logger) DebugCtx(ctx context.Context, body any, attrs Attrs)

+ func (l *Logger) EffectiveMinSeverity() int

+ func (l *Logger) EffectiveResource() *Resource

+ func (l *Logger) EffectiveSinks() []Sink

+ func (l *Logger) Error(body any, attrs Attrs)

+ func (l *Logger) ErrorCtx(ctx context.Context, body any, attrs Attrs)

+ func (l *Logger) Exception(err error, body any, attrs Attrs)

+ func (l *Logger) ExceptionCtx(ctx context.Context, err error, body any, attrs Attrs)

+ func (l *Logger) Fatal(body any, attrs Attrs)

+ func (l *Logger) FatalCtx(ctx context.Context, body any, attrs Attrs)

+ func (l *Logger) Flush(timeoutSeconds float64) (*FlushResult, error)

+ func (l *Logger) Info(body any, attrs Attrs)

+ func (l *Logger) InfoCtx(ctx context.Context, body any, attrs Attrs)

+ func (l *Logger) Log(severityNumber int, body any, attrs Attrs)

+ func (l *Logger) LogCtx(ctx context.Context, severityNumber int, body any, attrs Attrs)

+ func (l *Logger) Name() string

+ func (l *Logger) OnReconfigure(_ func()) *Subscription

+ func (l *Logger) ScopeSinks(ctx context.Context, sinks []Sink, fn func(context.Context) error) error

+ func (l *Logger) SetMinSeverity(severityNumber int)

+ func (l *Logger) SetResource(r *Resource)

+ func (l *Logger) SetSinks(sinks []Sink)

+ func (l *Logger) Trace(body any, attrs Attrs)

+ func (l *Logger) TraceCtx(ctx context.Context, body any, attrs Attrs)

+ func (l *Logger) Version() string

+ func (l *Logger) Warn(body any, attrs Attrs)

+ func (l *Logger) WarnCtx(ctx context.Context, body any, attrs Attrs)

+ func (l *Logger) WithSinks(sinks ...Sink) *Logger

+ func (l *Logger) WithoutSinks() *Logger

+ type Resource struct

+ Attributes Attrs

+ type Severity int

+ const SeverityDebug

+ const SeverityError

+ const SeverityFatal

+ const SeverityInfo

+ const SeverityTrace

+ const SeverityWarn

+ type Sink interface

+ Close func() error

+ Emit func(record *LogRecord)

+ Flush func(timeoutSeconds float64) error

+ ID func() string

+ SupportsSeverity func(severityNumber int) bool

+ type Subscription struct

+ Active bool

+ InactiveReason string

+ Path string

+ func NewInactiveSubscription(path, reason string) *Subscription

+ func NewSubscription(path string, unsubscribe func()) *Subscription

+ func (s *Subscription) Unsubscribe()

v0.1.0-rc.1

Apr 27, 2026