pax_global_header 0000666 0000000 0000000 00000000064 14643530430 0014514 g ustar 00root root 0000000 0000000 52 comment=368de753ea2a714981dac3bed7390460b9ae4a93
golang-github-lmittmann-tint-1.0.5/ 0000775 0000000 0000000 00000000000 14643530430 0017223 5 ustar 00root root 0000000 0000000 golang-github-lmittmann-tint-1.0.5/.github/ 0000775 0000000 0000000 00000000000 14643530430 0020563 5 ustar 00root root 0000000 0000000 golang-github-lmittmann-tint-1.0.5/.github/workflows/ 0000775 0000000 0000000 00000000000 14643530430 0022620 5 ustar 00root root 0000000 0000000 golang-github-lmittmann-tint-1.0.5/.github/workflows/go.yml 0000664 0000000 0000000 00000001456 14643530430 0023756 0 ustar 00root root 0000000 0000000 name: Go
on:
push:
branches:
- main
pull_request:
jobs:
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-go@v5
with:
go-version: "1.21"
- name: go fmt
run: |
output=$(gofmt -s -d .)
echo "$output"
test -z "$output"
- name: go vet
run: go vet ./...
- name: install staticcheck
run: go install honnef.co/go/tools/cmd/staticcheck@latest
- name: staticcheck
run: staticcheck ./...
test:
name: Test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-go@v5
with:
go-version: "1.21"
- name: go test
run: TZ="" go test ./... -tags=faketime
golang-github-lmittmann-tint-1.0.5/LICENSE 0000664 0000000 0000000 00000002052 14643530430 0020227 0 ustar 00root root 0000000 0000000 MIT License
Copyright (c) 2023 lmittmann
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
golang-github-lmittmann-tint-1.0.5/README.md 0000664 0000000 0000000 00000005367 14643530430 0020515 0 ustar 00root root 0000000 0000000 # `tint`: 🌈 **slog.Handler** that writes tinted logs
[](https://pkg.go.dev/github.com/lmittmann/tint#section-documentation)
[](https://goreportcard.com/report/github.com/lmittmann/tint)
Package `tint` implements a zero-dependency [`slog.Handler`](https://pkg.go.dev/log/slog#Handler)
that writes tinted (colorized) logs. Its output format is inspired by the `zerolog.ConsoleWriter` and
[`slog.TextHandler`](https://pkg.go.dev/log/slog#TextHandler).
The output format can be customized using [`Options`](https://pkg.go.dev/github.com/lmittmann/tint#Options)
which is a drop-in replacement for [`slog.HandlerOptions`](https://pkg.go.dev/log/slog#HandlerOptions).
```
go get github.com/lmittmann/tint
```
## Usage
```go
w := os.Stderr
// create a new logger
logger := slog.New(tint.NewHandler(w, nil))
// set global logger with custom options
slog.SetDefault(slog.New(
tint.NewHandler(w, &tint.Options{
Level: slog.LevelDebug,
TimeFormat: time.Kitchen,
}),
))
```
### Customize Attributes
`ReplaceAttr` can be used to alter or drop attributes. If set, it is called on
each non-group attribute before it is logged. See [`slog.HandlerOptions`](https://pkg.go.dev/log/slog#HandlerOptions)
for details.
```go
// create a new logger that doesn't write the time
w := os.Stderr
logger := slog.New(
tint.NewHandler(w, &tint.Options{
ReplaceAttr: func(groups []string, a slog.Attr) slog.Attr {
if a.Key == slog.TimeKey && len(groups) == 0 {
return slog.Attr{}
}
return a
},
}),
)
```
### Automatically Enable Colors
Colors are enabled by default and can be disabled using the `Options.NoColor`
attribute. To automatically enable colors based on the terminal capabilities,
use e.g. the [`go-isatty`](https://github.com/mattn/go-isatty) package.
```go
w := os.Stderr
logger := slog.New(
tint.NewHandler(w, &tint.Options{
NoColor: !isatty.IsTerminal(w.Fd()),
}),
)
```
### Windows Support
Color support on Windows can be added by using e.g. the
[`go-colorable`](https://github.com/mattn/go-colorable) package.
```go
w := os.Stderr
logger := slog.New(
tint.NewHandler(colorable.NewColorable(w), nil),
)
```
golang-github-lmittmann-tint-1.0.5/buffer.go 0000664 0000000 0000000 00000001502 14643530430 0021021 0 ustar 00root root 0000000 0000000 package tint
import "sync"
type buffer []byte
var bufPool = sync.Pool{
New: func() any {
b := make(buffer, 0, 1024)
return (*buffer)(&b)
},
}
func newBuffer() *buffer {
return bufPool.Get().(*buffer)
}
func (b *buffer) Free() {
// To reduce peak allocation, return only smaller buffers to the pool.
const maxBufferSize = 16 << 10
if cap(*b) <= maxBufferSize {
*b = (*b)[:0]
bufPool.Put(b)
}
}
func (b *buffer) Write(bytes []byte) (int, error) {
*b = append(*b, bytes...)
return len(bytes), nil
}
func (b *buffer) WriteByte(char byte) error {
*b = append(*b, char)
return nil
}
func (b *buffer) WriteString(str string) (int, error) {
*b = append(*b, str...)
return len(str), nil
}
func (b *buffer) WriteStringIf(ok bool, str string) (int, error) {
if !ok {
return 0, nil
}
return b.WriteString(str)
}
golang-github-lmittmann-tint-1.0.5/go.mod 0000664 0000000 0000000 00000000052 14643530430 0020326 0 ustar 00root root 0000000 0000000 module github.com/lmittmann/tint
go 1.21
golang-github-lmittmann-tint-1.0.5/handler.go 0000664 0000000 0000000 00000025043 14643530430 0021173 0 ustar 00root root 0000000 0000000 /*
Package tint implements a zero-dependency [slog.Handler] that writes tinted
(colorized) logs. The output format is inspired by the [zerolog.ConsoleWriter]
and [slog.TextHandler].
The output format can be customized using [Options], which is a drop-in
replacement for [slog.HandlerOptions].
# Customize Attributes
Options.ReplaceAttr can be used to alter or drop attributes. If set, it is
called on each non-group attribute before it is logged.
See [slog.HandlerOptions] for details.
w := os.Stderr
logger := slog.New(
tint.NewHandler(w, &tint.Options{
ReplaceAttr: func(groups []string, a slog.Attr) slog.Attr {
if a.Key == slog.TimeKey && len(groups) == 0 {
return slog.Attr{}
}
return a
},
}),
)
# Automatically Enable Colors
Colors are enabled by default and can be disabled using the Options.NoColor
attribute. To automatically enable colors based on the terminal capabilities,
use e.g. the [go-isatty] package.
w := os.Stderr
logger := slog.New(
tint.NewHandler(w, &tint.Options{
NoColor: !isatty.IsTerminal(w.Fd()),
}),
)
# Windows Support
Color support on Windows can be added by using e.g. the [go-colorable] package.
w := os.Stderr
logger := slog.New(
tint.NewHandler(colorable.NewColorable(w), nil),
)
[zerolog.ConsoleWriter]: https://pkg.go.dev/github.com/rs/zerolog#ConsoleWriter
[go-isatty]: https://pkg.go.dev/github.com/mattn/go-isatty
[go-colorable]: https://pkg.go.dev/github.com/mattn/go-colorable
*/
package tint
import (
"context"
"encoding"
"fmt"
"io"
"log/slog"
"path/filepath"
"runtime"
"strconv"
"sync"
"time"
"unicode"
)
// ANSI modes
const (
ansiReset = "\033[0m"
ansiFaint = "\033[2m"
ansiResetFaint = "\033[22m"
ansiBrightRed = "\033[91m"
ansiBrightGreen = "\033[92m"
ansiBrightYellow = "\033[93m"
ansiBrightRedFaint = "\033[91;2m"
)
const errKey = "err"
var (
defaultLevel = slog.LevelInfo
defaultTimeFormat = time.StampMilli
)
// Options for a slog.Handler that writes tinted logs. A zero Options consists
// entirely of default values.
//
// Options can be used as a drop-in replacement for [slog.HandlerOptions].
type Options struct {
// Enable source code location (Default: false)
AddSource bool
// Minimum level to log (Default: slog.LevelInfo)
Level slog.Leveler
// ReplaceAttr is called to rewrite each non-group attribute before it is logged.
// See https://pkg.go.dev/log/slog#HandlerOptions for details.
ReplaceAttr func(groups []string, attr slog.Attr) slog.Attr
// Time format (Default: time.StampMilli)
TimeFormat string
// Disable color (Default: false)
NoColor bool
}
// NewHandler creates a [slog.Handler] that writes tinted logs to Writer w,
// using the default options. If opts is nil, the default options are used.
func NewHandler(w io.Writer, opts *Options) slog.Handler {
h := &handler{
w: w,
level: defaultLevel,
timeFormat: defaultTimeFormat,
}
if opts == nil {
return h
}
h.addSource = opts.AddSource
if opts.Level != nil {
h.level = opts.Level
}
h.replaceAttr = opts.ReplaceAttr
if opts.TimeFormat != "" {
h.timeFormat = opts.TimeFormat
}
h.noColor = opts.NoColor
return h
}
// handler implements a [slog.Handler].
type handler struct {
attrsPrefix string
groupPrefix string
groups []string
mu sync.Mutex
w io.Writer
addSource bool
level slog.Leveler
replaceAttr func([]string, slog.Attr) slog.Attr
timeFormat string
noColor bool
}
func (h *handler) clone() *handler {
return &handler{
attrsPrefix: h.attrsPrefix,
groupPrefix: h.groupPrefix,
groups: h.groups,
w: h.w,
addSource: h.addSource,
level: h.level,
replaceAttr: h.replaceAttr,
timeFormat: h.timeFormat,
noColor: h.noColor,
}
}
func (h *handler) Enabled(_ context.Context, level slog.Level) bool {
return level >= h.level.Level()
}
func (h *handler) Handle(_ context.Context, r slog.Record) error {
// get a buffer from the sync pool
buf := newBuffer()
defer buf.Free()
rep := h.replaceAttr
// write time
if !r.Time.IsZero() {
val := r.Time.Round(0) // strip monotonic to match Attr behavior
if rep == nil {
h.appendTime(buf, r.Time)
buf.WriteByte(' ')
} else if a := rep(nil /* groups */, slog.Time(slog.TimeKey, val)); a.Key != "" {
if a.Value.Kind() == slog.KindTime {
h.appendTime(buf, a.Value.Time())
} else {
h.appendValue(buf, a.Value, false)
}
buf.WriteByte(' ')
}
}
// write level
if rep == nil {
h.appendLevel(buf, r.Level)
buf.WriteByte(' ')
} else if a := rep(nil /* groups */, slog.Any(slog.LevelKey, r.Level)); a.Key != "" {
h.appendValue(buf, a.Value, false)
buf.WriteByte(' ')
}
// write source
if h.addSource {
fs := runtime.CallersFrames([]uintptr{r.PC})
f, _ := fs.Next()
if f.File != "" {
src := &slog.Source{
Function: f.Function,
File: f.File,
Line: f.Line,
}
if rep == nil {
h.appendSource(buf, src)
buf.WriteByte(' ')
} else if a := rep(nil /* groups */, slog.Any(slog.SourceKey, src)); a.Key != "" {
h.appendValue(buf, a.Value, false)
buf.WriteByte(' ')
}
}
}
// write message
if rep == nil {
buf.WriteString(r.Message)
buf.WriteByte(' ')
} else if a := rep(nil /* groups */, slog.String(slog.MessageKey, r.Message)); a.Key != "" {
h.appendValue(buf, a.Value, false)
buf.WriteByte(' ')
}
// write handler attributes
if len(h.attrsPrefix) > 0 {
buf.WriteString(h.attrsPrefix)
}
// write attributes
r.Attrs(func(attr slog.Attr) bool {
h.appendAttr(buf, attr, h.groupPrefix, h.groups)
return true
})
if len(*buf) == 0 {
return nil
}
(*buf)[len(*buf)-1] = '\n' // replace last space with newline
h.mu.Lock()
defer h.mu.Unlock()
_, err := h.w.Write(*buf)
return err
}
func (h *handler) WithAttrs(attrs []slog.Attr) slog.Handler {
if len(attrs) == 0 {
return h
}
h2 := h.clone()
buf := newBuffer()
defer buf.Free()
// write attributes to buffer
for _, attr := range attrs {
h.appendAttr(buf, attr, h.groupPrefix, h.groups)
}
h2.attrsPrefix = h.attrsPrefix + string(*buf)
return h2
}
func (h *handler) WithGroup(name string) slog.Handler {
if name == "" {
return h
}
h2 := h.clone()
h2.groupPrefix += name + "."
h2.groups = append(h2.groups, name)
return h2
}
func (h *handler) appendTime(buf *buffer, t time.Time) {
buf.WriteStringIf(!h.noColor, ansiFaint)
*buf = t.AppendFormat(*buf, h.timeFormat)
buf.WriteStringIf(!h.noColor, ansiReset)
}
func (h *handler) appendLevel(buf *buffer, level slog.Level) {
switch {
case level < slog.LevelInfo:
buf.WriteString("DBG")
appendLevelDelta(buf, level-slog.LevelDebug)
case level < slog.LevelWarn:
buf.WriteStringIf(!h.noColor, ansiBrightGreen)
buf.WriteString("INF")
appendLevelDelta(buf, level-slog.LevelInfo)
buf.WriteStringIf(!h.noColor, ansiReset)
case level < slog.LevelError:
buf.WriteStringIf(!h.noColor, ansiBrightYellow)
buf.WriteString("WRN")
appendLevelDelta(buf, level-slog.LevelWarn)
buf.WriteStringIf(!h.noColor, ansiReset)
default:
buf.WriteStringIf(!h.noColor, ansiBrightRed)
buf.WriteString("ERR")
appendLevelDelta(buf, level-slog.LevelError)
buf.WriteStringIf(!h.noColor, ansiReset)
}
}
func appendLevelDelta(buf *buffer, delta slog.Level) {
if delta == 0 {
return
} else if delta > 0 {
buf.WriteByte('+')
}
*buf = strconv.AppendInt(*buf, int64(delta), 10)
}
func (h *handler) appendSource(buf *buffer, src *slog.Source) {
dir, file := filepath.Split(src.File)
buf.WriteStringIf(!h.noColor, ansiFaint)
buf.WriteString(filepath.Join(filepath.Base(dir), file))
buf.WriteByte(':')
buf.WriteString(strconv.Itoa(src.Line))
buf.WriteStringIf(!h.noColor, ansiReset)
}
func (h *handler) appendAttr(buf *buffer, attr slog.Attr, groupsPrefix string, groups []string) {
attr.Value = attr.Value.Resolve()
if rep := h.replaceAttr; rep != nil && attr.Value.Kind() != slog.KindGroup {
attr = rep(groups, attr)
attr.Value = attr.Value.Resolve()
}
if attr.Equal(slog.Attr{}) {
return
}
if attr.Value.Kind() == slog.KindGroup {
if attr.Key != "" {
groupsPrefix += attr.Key + "."
groups = append(groups, attr.Key)
}
for _, groupAttr := range attr.Value.Group() {
h.appendAttr(buf, groupAttr, groupsPrefix, groups)
}
} else if err, ok := attr.Value.Any().(tintError); ok {
// append tintError
h.appendTintError(buf, err, attr.Key, groupsPrefix)
buf.WriteByte(' ')
} else {
h.appendKey(buf, attr.Key, groupsPrefix)
h.appendValue(buf, attr.Value, true)
buf.WriteByte(' ')
}
}
func (h *handler) appendKey(buf *buffer, key, groups string) {
buf.WriteStringIf(!h.noColor, ansiFaint)
appendString(buf, groups+key, true)
buf.WriteByte('=')
buf.WriteStringIf(!h.noColor, ansiReset)
}
func (h *handler) appendValue(buf *buffer, v slog.Value, quote bool) {
switch v.Kind() {
case slog.KindString:
appendString(buf, v.String(), quote)
case slog.KindInt64:
*buf = strconv.AppendInt(*buf, v.Int64(), 10)
case slog.KindUint64:
*buf = strconv.AppendUint(*buf, v.Uint64(), 10)
case slog.KindFloat64:
*buf = strconv.AppendFloat(*buf, v.Float64(), 'g', -1, 64)
case slog.KindBool:
*buf = strconv.AppendBool(*buf, v.Bool())
case slog.KindDuration:
appendString(buf, v.Duration().String(), quote)
case slog.KindTime:
appendString(buf, v.Time().String(), quote)
case slog.KindAny:
switch cv := v.Any().(type) {
case slog.Level:
h.appendLevel(buf, cv)
case encoding.TextMarshaler:
data, err := cv.MarshalText()
if err != nil {
break
}
appendString(buf, string(data), quote)
case *slog.Source:
h.appendSource(buf, cv)
default:
appendString(buf, fmt.Sprintf("%+v", v.Any()), quote)
}
}
}
func (h *handler) appendTintError(buf *buffer, err error, attrKey, groupsPrefix string) {
buf.WriteStringIf(!h.noColor, ansiBrightRedFaint)
appendString(buf, groupsPrefix+attrKey, true)
buf.WriteByte('=')
buf.WriteStringIf(!h.noColor, ansiResetFaint)
appendString(buf, err.Error(), true)
buf.WriteStringIf(!h.noColor, ansiReset)
}
func appendString(buf *buffer, s string, quote bool) {
if quote && needsQuoting(s) {
*buf = strconv.AppendQuote(*buf, s)
} else {
buf.WriteString(s)
}
}
func needsQuoting(s string) bool {
if len(s) == 0 {
return true
}
for _, r := range s {
if unicode.IsSpace(r) || r == '"' || r == '=' || !unicode.IsPrint(r) {
return true
}
}
return false
}
type tintError struct{ error }
// Err returns a tinted (colorized) [slog.Attr] that will be written in red color
// by the [tint.Handler]. When used with any other [slog.Handler], it behaves as
//
// slog.Any("err", err)
func Err(err error) slog.Attr {
if err != nil {
err = tintError{err}
}
return slog.Any(errKey, err)
}
golang-github-lmittmann-tint-1.0.5/handler_test.go 0000664 0000000 0000000 00000036063 14643530430 0022236 0 ustar 00root root 0000000 0000000 package tint_test
import (
"bytes"
"context"
"errors"
"io"
"log/slog"
"os"
"slices"
"strconv"
"strings"
"testing"
"time"
"github.com/lmittmann/tint"
)
var faketime = time.Date(2009, time.November, 10, 23, 0, 0, 0, time.UTC)
func Example() {
slog.SetDefault(slog.New(tint.NewHandler(os.Stderr, &tint.Options{
Level: slog.LevelDebug,
TimeFormat: time.Kitchen,
})))
slog.Info("Starting server", "addr", ":8080", "env", "production")
slog.Debug("Connected to DB", "db", "myapp", "host", "localhost:5432")
slog.Warn("Slow request", "method", "GET", "path", "/users", "duration", 497*time.Millisecond)
slog.Error("DB connection lost", tint.Err(errors.New("connection reset")), "db", "myapp")
// Output:
}
// Run test with "faketime" tag:
//
// TZ="" go test -tags=faketime
func TestHandler(t *testing.T) {
if !faketime.Equal(time.Now()) {
t.Skip(`skipping test; run with "-tags=faketime"`)
}
tests := []struct {
Opts *tint.Options
F func(l *slog.Logger)
Want string
}{
{
F: func(l *slog.Logger) {
l.Info("test", "key", "val")
},
Want: `Nov 10 23:00:00.000 INF test key=val`,
},
{
F: func(l *slog.Logger) {
l.Error("test", tint.Err(errors.New("fail")))
},
Want: `Nov 10 23:00:00.000 ERR test err=fail`,
},
{
F: func(l *slog.Logger) {
l.Info("test", slog.Group("group", slog.String("key", "val"), tint.Err(errors.New("fail"))))
},
Want: `Nov 10 23:00:00.000 INF test group.key=val group.err=fail`,
},
{
F: func(l *slog.Logger) {
l.WithGroup("group").Info("test", "key", "val")
},
Want: `Nov 10 23:00:00.000 INF test group.key=val`,
},
{
F: func(l *slog.Logger) {
l.With("key", "val").Info("test", "key2", "val2")
},
Want: `Nov 10 23:00:00.000 INF test key=val key2=val2`,
},
{
F: func(l *slog.Logger) {
l.Info("test", "k e y", "v a l")
},
Want: `Nov 10 23:00:00.000 INF test "k e y"="v a l"`,
},
{
F: func(l *slog.Logger) {
l.WithGroup("g r o u p").Info("test", "key", "val")
},
Want: `Nov 10 23:00:00.000 INF test "g r o u p.key"=val`,
},
{
F: func(l *slog.Logger) {
l.Info("test", "slice", []string{"a", "b", "c"}, "map", map[string]int{"a": 1, "b": 2, "c": 3})
},
Want: `Nov 10 23:00:00.000 INF test slice="[a b c]" map="map[a:1 b:2 c:3]"`,
},
{
Opts: &tint.Options{
AddSource: true,
},
F: func(l *slog.Logger) {
l.Info("test", "key", "val")
},
Want: `Nov 10 23:00:00.000 INF tint/handler_test.go:100 test key=val`,
},
{
Opts: &tint.Options{
TimeFormat: time.Kitchen,
},
F: func(l *slog.Logger) {
l.Info("test", "key", "val")
},
Want: `11:00PM INF test key=val`,
},
{
Opts: &tint.Options{
ReplaceAttr: drop(slog.TimeKey),
},
F: func(l *slog.Logger) {
l.Info("test", "key", "val")
},
Want: `INF test key=val`,
},
{
Opts: &tint.Options{
ReplaceAttr: drop(slog.LevelKey),
},
F: func(l *slog.Logger) {
l.Info("test", "key", "val")
},
Want: `Nov 10 23:00:00.000 test key=val`,
},
{
Opts: &tint.Options{
ReplaceAttr: drop(slog.MessageKey),
},
F: func(l *slog.Logger) {
l.Info("test", "key", "val")
},
Want: `Nov 10 23:00:00.000 INF key=val`,
},
{
Opts: &tint.Options{
ReplaceAttr: drop(slog.TimeKey, slog.LevelKey, slog.MessageKey),
},
F: func(l *slog.Logger) {
l.Info("test", "key", "val")
},
Want: `key=val`,
},
{
Opts: &tint.Options{
ReplaceAttr: drop("key"),
},
F: func(l *slog.Logger) {
l.Info("test", "key", "val")
},
Want: `Nov 10 23:00:00.000 INF test`,
},
{
Opts: &tint.Options{
ReplaceAttr: drop("key"),
},
F: func(l *slog.Logger) {
l.WithGroup("group").Info("test", "key", "val", "key2", "val2")
},
Want: `Nov 10 23:00:00.000 INF test group.key=val group.key2=val2`,
},
{
Opts: &tint.Options{
ReplaceAttr: func(groups []string, a slog.Attr) slog.Attr {
if a.Key == "key" && len(groups) == 1 && groups[0] == "group" {
return slog.Attr{}
}
return a
},
},
F: func(l *slog.Logger) {
l.WithGroup("group").Info("test", "key", "val", "key2", "val2")
},
Want: `Nov 10 23:00:00.000 INF test group.key2=val2`,
},
{
Opts: &tint.Options{
ReplaceAttr: replace(slog.IntValue(42), slog.TimeKey),
},
F: func(l *slog.Logger) {
l.Info("test", "key", "val")
},
Want: `42 INF test key=val`,
},
{
Opts: &tint.Options{
ReplaceAttr: replace(slog.StringValue("INFO"), slog.LevelKey),
},
F: func(l *slog.Logger) {
l.Info("test", "key", "val")
},
Want: `Nov 10 23:00:00.000 INFO test key=val`,
},
{
Opts: &tint.Options{
ReplaceAttr: replace(slog.IntValue(42), slog.MessageKey),
},
F: func(l *slog.Logger) {
l.Info("test", "key", "val")
},
Want: `Nov 10 23:00:00.000 INF 42 key=val`,
},
{
Opts: &tint.Options{
ReplaceAttr: replace(slog.IntValue(42), "key"),
},
F: func(l *slog.Logger) {
l.With("key", "val").Info("test", "key2", "val2")
},
Want: `Nov 10 23:00:00.000 INF test key=42 key2=val2`,
},
{
Opts: &tint.Options{
ReplaceAttr: func(groups []string, a slog.Attr) slog.Attr {
return slog.Attr{}
},
},
F: func(l *slog.Logger) {
l.Info("test", "key", "val")
},
Want: ``,
},
{
F: func(l *slog.Logger) {
l.Info("test", "key", "")
},
Want: `Nov 10 23:00:00.000 INF test key=""`,
},
{
F: func(l *slog.Logger) {
l.Info("test", "", "val")
},
Want: `Nov 10 23:00:00.000 INF test ""=val`,
},
{
F: func(l *slog.Logger) {
l.Info("test", "", "")
},
Want: `Nov 10 23:00:00.000 INF test ""=""`,
},
{ // https://github.com/lmittmann/tint/issues/8
F: func(l *slog.Logger) {
l.Log(context.TODO(), slog.LevelInfo+1, "test")
},
Want: `Nov 10 23:00:00.000 INF+1 test`,
},
{
Opts: &tint.Options{
Level: slog.LevelDebug - 1,
},
F: func(l *slog.Logger) {
l.Log(context.TODO(), slog.LevelDebug-1, "test")
},
Want: `Nov 10 23:00:00.000 DBG-1 test`,
},
{ // https://github.com/lmittmann/tint/issues/12
F: func(l *slog.Logger) {
l.Error("test", slog.Any("error", errors.New("fail")))
},
Want: `Nov 10 23:00:00.000 ERR test error=fail`,
},
{ // https://github.com/lmittmann/tint/issues/15
F: func(l *slog.Logger) {
l.Error("test", tint.Err(nil))
},
Want: `Nov 10 23:00:00.000 ERR test err=`,
},
{ // https://github.com/lmittmann/tint/pull/26
Opts: &tint.Options{
ReplaceAttr: func(groups []string, a slog.Attr) slog.Attr {
if a.Key == slog.TimeKey && len(groups) == 0 {
return slog.Time(slog.TimeKey, a.Value.Time().Add(24*time.Hour))
}
return a
},
},
F: func(l *slog.Logger) {
l.Error("test")
},
Want: `Nov 11 23:00:00.000 ERR test`,
},
{ // https://github.com/lmittmann/tint/pull/27
F: func(l *slog.Logger) {
l.Info("test", "a", "b", slog.Group("", slog.String("c", "d")), "e", "f")
},
Want: `Nov 10 23:00:00.000 INF test a=b c=d e=f`,
},
{ // https://github.com/lmittmann/tint/pull/30
// drop built-in attributes in a grouped log
Opts: &tint.Options{
ReplaceAttr: drop(slog.TimeKey, slog.LevelKey, slog.MessageKey, slog.SourceKey),
AddSource: true,
},
F: func(l *slog.Logger) {
l.WithGroup("group").Info("test", "key", "val")
},
Want: `group.key=val`,
},
{ // https://github.com/lmittmann/tint/issues/36
Opts: &tint.Options{
ReplaceAttr: func(g []string, a slog.Attr) slog.Attr {
if len(g) == 0 && a.Key == slog.LevelKey {
_ = a.Value.Any().(slog.Level)
}
return a
},
},
F: func(l *slog.Logger) {
l.Info("test")
},
Want: `Nov 10 23:00:00.000 INF test`,
},
{ // https://github.com/lmittmann/tint/issues/37
Opts: &tint.Options{
AddSource: true,
ReplaceAttr: func(g []string, a slog.Attr) slog.Attr {
return a
},
},
F: func(l *slog.Logger) {
l.Info("test")
},
Want: `Nov 10 23:00:00.000 INF tint/handler_test.go:327 test`,
},
{ // https://github.com/lmittmann/tint/issues/44
F: func(l *slog.Logger) {
l = l.WithGroup("group")
l.Error("test", tint.Err(errTest))
},
Want: `Nov 10 23:00:00.000 ERR test group.err=fail`,
},
{ // https://github.com/lmittmann/tint/issues/55
F: func(l *slog.Logger) {
l.Info("test", "key", struct {
A int
B *string
}{A: 123})
},
Want: `Nov 10 23:00:00.000 INF test key="{A:123 B:}"`,
},
{ // https://github.com/lmittmann/tint/pull/66
F: func(l *slog.Logger) {
errAttr := tint.Err(errors.New("fail"))
errAttr.Key = "error"
l.Error("test", errAttr)
},
Want: `Nov 10 23:00:00.000 ERR test error=fail`,
},
}
for i, test := range tests {
t.Run(strconv.Itoa(i), func(t *testing.T) {
var buf bytes.Buffer
if test.Opts == nil {
test.Opts = &tint.Options{}
}
test.Opts.NoColor = true
l := slog.New(tint.NewHandler(&buf, test.Opts))
test.F(l)
got := strings.TrimRight(buf.String(), "\n")
if test.Want != got {
t.Fatalf("(-want +got)\n- %s\n+ %s", test.Want, got)
}
})
}
}
// drop returns a ReplaceAttr that drops the given keys.
func drop(keys ...string) func([]string, slog.Attr) slog.Attr {
return func(groups []string, a slog.Attr) slog.Attr {
if len(groups) > 0 {
return a
}
for _, key := range keys {
if a.Key == key {
a = slog.Attr{}
}
}
return a
}
}
func replace(new slog.Value, keys ...string) func([]string, slog.Attr) slog.Attr {
return func(groups []string, a slog.Attr) slog.Attr {
if len(groups) > 0 {
return a
}
for _, key := range keys {
if a.Key == key {
a.Value = new
}
}
return a
}
}
func TestReplaceAttr(t *testing.T) {
tests := [][]any{
{},
{"key", "val"},
{"key", "val", slog.Group("group", "key2", "val2")},
{"key", "val", slog.Group("group", "key2", "val2", slog.Group("group2", "key3", "val3"))},
}
type replaceAttrParams struct {
Groups []string
Attr slog.Attr
}
replaceAttrRecorder := func(record *[]replaceAttrParams) func([]string, slog.Attr) slog.Attr {
return func(groups []string, a slog.Attr) slog.Attr {
*record = append(*record, replaceAttrParams{groups, a})
return a
}
}
for i, test := range tests {
t.Run(strconv.Itoa(i), func(t *testing.T) {
slogRecord := make([]replaceAttrParams, 0)
slogLogger := slog.New(slog.NewTextHandler(io.Discard, &slog.HandlerOptions{
ReplaceAttr: replaceAttrRecorder(&slogRecord),
}))
slogLogger.Log(context.TODO(), slog.LevelInfo, "", test...)
tintRecord := make([]replaceAttrParams, 0)
tintLogger := slog.New(tint.NewHandler(io.Discard, &tint.Options{
ReplaceAttr: replaceAttrRecorder(&tintRecord),
}))
tintLogger.Log(context.TODO(), slog.LevelInfo, "", test...)
if !slices.EqualFunc(slogRecord, tintRecord, func(a, b replaceAttrParams) bool {
return slices.Equal(a.Groups, b.Groups) && a.Attr.Equal(b.Attr)
}) {
t.Fatalf("(-want +got)\n- %v\n+ %v", slogRecord, tintRecord)
}
})
}
}
// See https://github.com/golang/exp/blob/master/slog/benchmarks/benchmarks_test.go#L25
//
// Run e.g.:
//
// go test -bench=. -count=10 | benchstat -col /h /dev/stdin
func BenchmarkLogAttrs(b *testing.B) {
handler := []struct {
Name string
H slog.Handler
}{
{"tint", tint.NewHandler(io.Discard, nil)},
{"text", slog.NewTextHandler(io.Discard, nil)},
{"json", slog.NewJSONHandler(io.Discard, nil)},
{"discard", new(discarder)},
}
benchmarks := []struct {
Name string
F func(*slog.Logger)
}{
{
"5 args",
func(logger *slog.Logger) {
logger.LogAttrs(context.TODO(), slog.LevelInfo, testMessage,
slog.String("string", testString),
slog.Int("status", testInt),
slog.Duration("duration", testDuration),
slog.Time("time", testTime),
slog.Any("error", errTest),
)
},
},
{
"5 args custom level",
func(logger *slog.Logger) {
logger.LogAttrs(context.TODO(), slog.LevelInfo+1, testMessage,
slog.String("string", testString),
slog.Int("status", testInt),
slog.Duration("duration", testDuration),
slog.Time("time", testTime),
slog.Any("error", errTest),
)
},
},
{
"10 args",
func(logger *slog.Logger) {
logger.LogAttrs(context.TODO(), slog.LevelInfo, testMessage,
slog.String("string", testString),
slog.Int("status", testInt),
slog.Duration("duration", testDuration),
slog.Time("time", testTime),
slog.Any("error", errTest),
slog.String("string", testString),
slog.Int("status", testInt),
slog.Duration("duration", testDuration),
slog.Time("time", testTime),
slog.Any("error", errTest),
)
},
},
{
"40 args",
func(logger *slog.Logger) {
logger.LogAttrs(context.TODO(), slog.LevelInfo, testMessage,
slog.String("string", testString),
slog.Int("status", testInt),
slog.Duration("duration", testDuration),
slog.Time("time", testTime),
slog.Any("error", errTest),
slog.String("string", testString),
slog.Int("status", testInt),
slog.Duration("duration", testDuration),
slog.Time("time", testTime),
slog.Any("error", errTest),
slog.String("string", testString),
slog.Int("status", testInt),
slog.Duration("duration", testDuration),
slog.Time("time", testTime),
slog.Any("error", errTest),
slog.String("string", testString),
slog.Int("status", testInt),
slog.Duration("duration", testDuration),
slog.Time("time", testTime),
slog.Any("error", errTest),
slog.String("string", testString),
slog.Int("status", testInt),
slog.Duration("duration", testDuration),
slog.Time("time", testTime),
slog.Any("error", errTest),
slog.String("string", testString),
slog.Int("status", testInt),
slog.Duration("duration", testDuration),
slog.Time("time", testTime),
slog.Any("error", errTest),
slog.String("string", testString),
slog.Int("status", testInt),
slog.Duration("duration", testDuration),
slog.Time("time", testTime),
slog.Any("error", errTest),
slog.String("string", testString),
slog.Int("status", testInt),
slog.Duration("duration", testDuration),
slog.Time("time", testTime),
slog.Any("error", errTest),
)
},
},
}
for _, h := range handler {
b.Run("h="+h.Name, func(b *testing.B) {
for _, bench := range benchmarks {
b.Run(bench.Name, func(b *testing.B) {
b.ReportAllocs()
logger := slog.New(h.H)
for i := 0; i < b.N; i++ {
bench.F(logger)
}
})
}
})
}
}
// discarder is a slog.Handler that discards all records.
type discarder struct{}
func (*discarder) Enabled(context.Context, slog.Level) bool { return true }
func (*discarder) Handle(context.Context, slog.Record) error { return nil }
func (d *discarder) WithAttrs(attrs []slog.Attr) slog.Handler { return d }
func (d *discarder) WithGroup(name string) slog.Handler { return d }
var (
testMessage = "Test logging, but use a somewhat realistic message length."
testTime = time.Date(2022, time.May, 1, 0, 0, 0, 0, time.UTC)
testString = "7e3b3b2aaeff56a7108fe11e154200dd/7819479873059528190"
testInt = 32768
testDuration = 23 * time.Second
errTest = errors.New("fail")
)