logger

package

v1.0.0 Latest Latest Go to latest Published: Nov 6, 2026 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cetrictech/go-platform-kit

Links

Open Source Insights

Documentation ¶

Overview ¶

Package logger configures native slog with recursive structured-field redaction.

Index ¶

func Context(ctx context.Context, attrs ...slog.Attr) context.Context
type Config
type Logger

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Context ¶

func Context(ctx context.Context, attrs ...slog.Attr) context.Context

Context adds correlation attributes without retaining the context in a client.

Types ¶

type Config ¶

type Config struct {
	JSON                                      bool
	Level                                     slog.Level
	Output                                    io.Writer
	OwnOutput                                 bool
	File                                      string
	MaxSizeMB, MaxBackups, MaxAgeDays         int
	Compress                                  bool
	Service, Version, Environment, TimeFormat string
	SanitizeText                              func(string) string
}

Config contains explicit constructor settings; see package documentation for defaults.

type Logger ¶

type Logger struct {
	*slog.Logger
	// contains filtered or unexported fields
}

Logger embeds native slog and owns applicable configured outputs.

func From ¶

func From(l *slog.Logger) *Logger

From wraps an existing logger. Its handler and lifecycle remain caller-owned.

func New ¶

func New(c Config) *Logger

New constructs and validates an explicitly owned instance. See package documentation for defaults and cleanup.

func Open ¶

func Open(c Config) (*Logger, error)

Open validates output settings and eagerly checks file access. New remains available for callers that deliberately use slog's lazy write error handling.

func (*Logger) Close ¶

func (l *Logger) Close() error

Close releases owned resources. See package documentation for shutdown ordering.

func (*Logger) Flush ¶

func (l *Logger) Flush(ctx context.Context) error

Flush invokes a configured writer's flush contract. Injected writers remain caller-owned unless OwnOutput is explicitly enabled. Call after producers stop.

func (*Logger) SetLevel ¶

func (l *Logger) SetLevel(v slog.Level)

SetLevel changes the shared dynamic logging threshold.

func (*Logger) With ¶

func (l *Logger) With(args ...any) *Logger

With returns a logger enriched with structured attributes.

func (*Logger) WithContext ¶

func (l *Logger) WithContext(ctx context.Context) *Logger

WithContext copies logger correlation attributes from the supplied context.

func (*Logger) WithError ¶

func (l *Logger) WithError(e error) *Logger

WithError returns a logger with an error attribute; error text must be safe for logging.

Source Files ¶

View all Source files

logger.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL