(refactor): prepare breaking v2 API
- rename package to sneklog and move module to /v2 - replace text output flags with writer formatters - remove external color dependencies - update migration notes and coverage
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
// Package slog provides a small structured logger that can write the same
|
||||
// Package sneklog provides a small structured logger that can write the same
|
||||
// record to text and JSON outputs.
|
||||
//
|
||||
// A Logger can fan out records to stdout, files, or any external io.Writer.
|
||||
@@ -8,21 +8,20 @@
|
||||
// CreateLogger uses the following defaults:
|
||||
// - prefix: "LOG"
|
||||
// - level: FATAL, which enables info, warn, error, and fatal records
|
||||
// - text timestamps: enabled
|
||||
// - text traceback: disabled
|
||||
// - pretty JSON: disabled
|
||||
// - text formatter: DefaultTextFormatter
|
||||
// - JSON formatter: DefaultJsonFormatter
|
||||
//
|
||||
// Call Level(DEBUG) to enable all records, including debug messages.
|
||||
// AddReplacer can be used to mask or normalize message text before records are
|
||||
// passed to writers.
|
||||
// passed to writers. Call SetFormatter on a writer to customize timestamps,
|
||||
// traceback fields, colors, and message layout.
|
||||
//
|
||||
// Basic usage:
|
||||
//
|
||||
// logger := slog.CreateLogger().
|
||||
// logger := sneklog.CreateLogger().
|
||||
// Prefix("API").
|
||||
// Level(slog.DEBUG).
|
||||
// PrintTraceback(true).
|
||||
// JsonPretty(true).
|
||||
// Level(sneklog.DEBUG).
|
||||
// AddReplacer("secret-token", "<redacted>")
|
||||
//
|
||||
// text := logger.CreateTextStdoutWriter()
|
||||
@@ -42,4 +41,4 @@
|
||||
// the logger and are closed by Logger.Close. Writers created from existing
|
||||
// io.Writer values through CreateTextWriter or CreateJsonWriter remain owned by
|
||||
// the caller and are not closed by the logger.
|
||||
package slog
|
||||
package sneklog
|
||||
|
||||
Reference in New Issue
Block a user