phuslog - High performance structured logging

Features

Dependency Free
Simple and Clean Interface
Consistent Writer
- IOWriter, io.Writer wrapper
- ConsoleWriter, colorful & formatting
- FileWriter, rotating & effective
- MultiLevelWriter, multiple level dispatch
- SyslogWriter, memory efficient syslog
- JournalWriter, linux systemd logging
- EventlogWriter, windows system event
- AsyncWriter, asynchronously writing
Stdlib Log Adapter
- Logger.Std, transform to std log instances
- Logger.Slog, transform to log/slog instances
Third-party Logger Interceptor
- logr, logr interceptor
- gin, gin logging middleware
- gorm, gorm logger interface
- fiber, fiber logging handler
- grpc, grpc logger interceptor
- grpcgateway, grpcgateway logger interceptor
Useful utility function
- Goid(), the goroutine id matches stack trace
- NewXID(), create a tracing id
- Fastrandn(n uint32), fast pseudorandom uint32 in [0,n)
- IsTerminal(fd uintptr), isatty for golang
- Printf(fmt string, a ...interface{}), printf logging
High Performance
- Significantly faster than all other json loggers.

Interfaces

Logger

// DefaultLogger is the global logger.
var DefaultLogger = Logger{
	Level:      DebugLevel,
	Caller:     0,
	TimeField:  "",
	TimeFormat: "",
	Writer:     &IOWriter{os.Stderr},
}

// A Logger represents an active logging object that generates lines of JSON output to an io.Writer.
type Logger struct {
	// Level defines log levels.
	Level Level

	// Caller determines if adds the file:line of the "caller" key.
	// If Caller is negative, adds the full /path/to/file:line of the "caller" key.
	Caller int

	// TimeField defines the time filed name in output.  It uses "time" in if empty.
	TimeField string

	// TimeFormat specifies the time format in output. It uses RFC3339 with millisecond if empty.
	// If set with `TimeFormatUnix/TimeFormatUnixMs/TimeFormatUnixWithMs`, timestamps are formated.
	TimeFormat string

	// Writer specifies the writer of output. It uses a wrapped os.Stderr Writer in if empty.
	Writer Writer
}

ConsoleWriter

// ConsoleWriter parses the JSON input and writes it in a colorized, human-friendly format to Writer.
// IMPORTANT: Don't use ConsoleWriter on critical path of a high concurrency and low latency application.
//
// Default output format:
//     {Time} {Level} {Goid} {Caller} > {Message} {Key}={Value} {Key}={Value}
type ConsoleWriter struct {
	// ColorOutput determines if used colorized output.
	ColorOutput bool

	// QuoteString determines if quoting string values.
	QuoteString bool

	// EndWithMessage determines if output message in the end of line.
	EndWithMessage bool

	// Writer is the output destination. using os.Stderr if empty.
	Writer io.Writer

	// Formatter specifies an optional text formatter for creating a customized output,
	// If it is set, ColorOutput, QuoteString and EndWithMessage will be ignored.
	Formatter func(w io.Writer, args *FormatterArgs) (n int, err error)
}

// FormatterArgs is a parsed sturct from json input
type FormatterArgs struct {
	Time      string // "2019-07-10T05:35:54.277Z"
	Message   string // "a structure message"
	Level     string // "info"
	Caller    string // "main.go:123"
	Goid      string // "1"
	Stack     string // "<stack string>"
	KeyValues []struct {
		Key       string // "foo"
		Value     string // "bar"
	}
}

FileWriter

// FileWriter is an Writer that writes to the specified filename.
type FileWriter struct {
	// Filename is the file to write logs to.  Backup log files will be retained
	// in the same directory.
	Filename string

	// FileMode represents the file's mode and permission bits.  The default
	// mode is 0644
	FileMode os.FileMode

	// MaxSize is the maximum size in bytes of the log file before it gets rotated.
	MaxSize int64

	// MaxBackups is the maximum number of old log files to retain.  The default
	// is to retain all old log files
	MaxBackups int

	// TimeFormat specifies the time format of filename, uses `2006-01-02T15-04-05` as default format.
	// If set with `TimeFormatUnix`, `TimeFormatUnixMs`, times are formated as UNIX timestamp.
	TimeFormat string

	// LocalTime determines if the time used for formatting the timestamps in
	// log files is the computer's local time.  The default is to use UTC time.
	LocalTime bool

	// HostName determines if the hostname used for formatting in log files.
	HostName bool

	// ProcessID determines if the pid used for formatting in log files.
	ProcessID bool

	// EnsureFolder ensures the file directory creation before writing.
	EnsureFolder bool

	// Header specifies an optional header function of log file after rotation,
	Header func(fileinfo os.FileInfo) []byte

	// Cleaner specifies an optional cleanup function of log backups after rotation,
	// if not set, the default behavior is to delete more than MaxBackups log files.
	Cleaner func(filename string, maxBackups int, matches []os.FileInfo)
}

Highlights:

FileWriter implements log.Writer and io.Writer interfaces both, it is a recommended alternative to lumberjack.
FileWriter creates a symlink to the current logging file, it requires administrator privileges on Windows.
FileWriter does not rotate if you define a broad TimeFormat value(daily or monthly) then reach its MaxSize.

Getting Started

Simple Logging Example

An out of box example.

package main

import (
	"github.com/fabricatorsltd/logstack"
)

func main() {
	log.Info().Str("foo", "bar").Int("number", 42).Msg("hi, phuslog")
	log.Info().Msgf("foo=%s number=%d error=%+v", "bar", 42, "an error")
}

// Output:
//   {"time":"2020-03-22T09:58:41.828Z","level":"info","foo":"bar","number":42,"message":"hi, phuslog"}
//   {"time":"2020-03-22T09:58:41.828Z","level":"info","message":"foo=bar number=42 error=an error"}

Note: By default log writes to os.Stderr

Customize the configuration and formatting:

To customize logger filed name and format.

package main

import (
	"github.com/fabricatorsltd/logstack"
)

func main() {
	log.DefaultLogger = log.Logger{
		Level:      log.InfoLevel,
		Caller:     1,
		TimeField:  "date",
		TimeFormat: "2006-01-02",
		Writer:     &log.IOWriter{os.Stdout},
	}

	log.Info().Str("foo", "bar").Msgf("hello %s", "world")

	logger := log.Logger{
		Level:      log.InfoLevel,
		TimeField:  "ts",
		TimeFormat: log.TimeFormatUnixMs,
	}

	logger.Log().Str("foo", "bar").Msg("")
}

// Output:
//    {"date":"2019-07-04","level":"info","caller":"prog.go:16","foo":"bar","message":"hello world"}
//    {"ts":1257894000000,"foo":"bar"}

Pretty Console Writer

To log a human-friendly, colorized output, use ConsoleWriter.

if log.IsTerminal(os.Stderr.Fd()) {
	log.DefaultLogger = log.Logger{
		TimeFormat: "15:04:05",
		Caller:     1,
		Writer: &log.ConsoleWriter{
			ColorOutput:    true,
			QuoteString:    true,
			EndWithMessage: true,
		},
	}
}

log.Debug().Int("everything", 42).Str("foo", "bar").Msg("hello world")
log.Info().Int("everything", 42).Str("foo", "bar").Msg("hello world")
log.Warn().Int("everything", 42).Str("foo", "bar").Msg("hello world")
log.Error().Err(errors.New("an error")).Msg("hello world")

Note: pretty logging also works on windows console

Formatting Console Writer

To log with user-defined format(e.g. glog), using ConsoleWriter.Formatter.

package main

import (
	"fmt"
	"io"

	"github.com/fabricatorsltd/logstack"
)

type Glog struct {
	Logger log.Logger
}

func (l *Glog) Infof(fmt string, a ...any) { l.Logger.Info().Msgf(fmt, a...) }

func (l *Glog) Warnf(fmt string, a ...any) { l.Logger.Warn().Msgf(fmt, a...) }

func (l *Glog) Errorf(fmt string, a ...any) { l.Logger.Error().Msgf(fmt, a...) }

var glog = &Glog{log.Logger{
	Level:      log.InfoLevel,
	Caller:     1,
	TimeFormat: "0102 15:04:05.999999",
	Writer: &log.ConsoleWriter{Formatter: func(w io.Writer, a *log.FormatterArgs) (int, error) {
		return fmt.Fprintf(w, "%c%s %s %s] %s\n%s", a.Level[0]-32, a.Time, a.Goid, a.Caller, a.Message, a.Stack)
	}},
}}

func main() {
	glog.Infof("hello glog %s", "Info")
	glog.Warnf("hello glog %s", "Warn")
	glog.Errorf("hello glog %s", "Error")
}

// Output:
// I0725 09:59:57.503246 19 console_test.go:183] hello glog Info
// W0725 09:59:57.504247 19 console_test.go:184] hello glog Warn
// E0725 09:59:57.504247 19 console_test.go:185] hello glog Error

Formatting Logfmt output

To log with logfmt format, also using ConsoleWriter.Formatter.

package main

import (
	"io"
	"os"

	"github.com/fabricatorsltd/logstack"
)

func main() {
	log.DefaultLogger = log.Logger{
		Level:      log.InfoLevel,
		Caller:     1,
		TimeField:  "ts",
		TimeFormat: log.TimeFormatUnixWithMs,
		Writer: &log.ConsoleWriter{
			Formatter: log.LogfmtFormatter{"ts"}.Formatter,
			Writer:    io.MultiWriter(os.Stdout, os.Stderr),
		},
	}

	log.Info().Str("foo", "bar").Int("no", 42).Msgf("a logfmt %s", "info")
}

// Output:
// ts=1257894000.000 level=info goid=1 caller="prog.go:20" foo="bar" no=42 "a logfmt info"
// ts=1257894000.000 level=info goid=1 caller="prog.go:20" foo="bar" no=42 "a logfmt info"

Rotating File Writer

To log to a daily-rotating file, use FileWriter.

package main

import (
	"os"
	"path/filepath"
	"time"

	"github.com/fabricatorsltd/logstack"
	"github.com/robfig/cron/v3"
)

func main() {
	logger := log.Logger{
		Level: log.ParseLevel("info"),
		Writer: &log.FileWriter{
			Filename:     "logs/main.log",
			FileMode:     0600,
			MaxSize:      100 * 1024 * 1024,
			MaxBackups:   7,
			EnsureFolder: true,
			LocalTime:    true,
		},
	}

	runner := cron.New(cron.WithLocation(time.Local))
	runner.AddFunc("0 0 * * *", func() { logger.Writer.(*log.FileWriter).Rotate() })
	go runner.Run()

	for {
		time.Sleep(time.Second)
		logger.Info().Msg("hello world")
	}
}

Rotating File Writer within a total size

To rotating log file hourly and keep in a total size, use FileWriter.Cleaner.

package main

import (
	"os"
	"path/filepath"
	"time"

	"github.com/fabricatorsltd/logstack"
	"github.com/robfig/cron/v3"
)

func main() {
	logger := log.Logger{
		Level: log.ParseLevel("info"),
		Writer: &log.FileWriter{
			Filename: "main.log",
			MaxSize:  500 * 1024 * 1024,
			Cleaner:  func(filename string, maxBackups int, matches []os.FileInfo) {
				var dir = filepath.Dir(filename)
				var total int64
				for i := len(matches) - 1; i >= 0; i-- {
					total += matches[i].Size()
					if total > 5*1024*1024*1024 {
						os.Remove(filepath.Join(dir, matches[i].Name()))
					}
				}
			},
		},
	}

	runner := cron.New(cron.WithLocation(time.UTC))
	runner.AddFunc("0 * * * *", func() { logger.Writer.(*log.FileWriter).Rotate() })
	go runner.Run()

	for {
		time.Sleep(time.Second)
		logger.Info().Msg("hello world")
	}
}

Rotating File Writer with compression

To rotating log file hourly and compressing after rotation, use FileWriter.Cleaner.

package main

import (
	"os"
	"os/exec"
	"path/filepath"
	"time"

	"github.com/fabricatorsltd/logstack"
	"github.com/robfig/cron/v3"
)

func main() {
	logger := log.Logger{
		Level: log.ParseLevel("info"),
		Writer: &log.FileWriter{
			Filename: "main.log",
			MaxSize:  500 * 1024 * 1024,
			Cleaner:  func(filename string, maxBackups int, matches []os.FileInfo) {
				var dir = filepath.Dir(filename)
				for i, fi := range matches {
					filename := filepath.Join(dir, fi.Name())
					switch {
					case i > maxBackups:
						os.Remove(filename)
					case !strings.HasSuffix(filename, ".gz"):
						go exec.Command("nice", "gzip", filename).Run()
					}
				}
			},
		},
	}

	runner := cron.New(cron.WithLocation(time.UTC))
	runner.AddFunc("0 * * * *", func() { logger.Writer.(*log.FileWriter).Rotate() })
	go runner.Run()

	for {
		time.Sleep(time.Second)
		logger.Info().Msg("hello world")
	}
}

Random Sample Logger:

To logging only 5% logs, use below idiom.

if log.Fastrandn(100) < 5 {
	log.Log().Msg("hello world")
}

Multiple Dispatching Writer

To log to different writers by different levels, use MultiLevelWriter.

log.DefaultLogger.Writer = &log.MultiLevelWriter{
	InfoWriter:    &log.FileWriter{Filename: "main.INFO", MaxSize: 100<<20},
	WarnWriter:    &log.FileWriter{Filename: "main.WARNING", MaxSize: 100<<20},
	ErrorWriter:   &log.FileWriter{Filename: "main.ERROR", MaxSize: 100<<20},
	ConsoleWriter: &log.ConsoleWriter{ColorOutput: true},
	ConsoleLevel:  log.ErrorLevel,
}

log.Info().Int("number", 42).Str("foo", "bar").Msg("a info log")
log.Warn().Int("number", 42).Str("foo", "bar").Msg("a warn log")
log.Error().Int("number", 42).Str("foo", "bar").Msg("a error log")

Multiple Entry Writer

To log to different writers, use MultiEntryWriter.

log.DefaultLogger.Writer = &log.MultiEntryWriter{
	&log.ConsoleWriter{ColorOutput: true},
	&log.FileWriter{Filename: "main.log", MaxSize: 100<<20},
	&log.EventlogWriter{Source: ".NET Runtime", ID: 1000},
}

log.Info().Int("number", 42).Str("foo", "bar").Msg("a info log")

Multiple IO Writer

To log to multiple io writers like io.MultiWriter, use below idiom.

log.DefaultLogger.Writer = &log.MultiIOWriter{
	os.Stdout,
	&log.FileWriter{Filename: "main.log", MaxSize: 100<<20},
}

log.Info().Int("number", 42).Str("foo", "bar").Msg("a info log")

Multiple Combined Logger:

To logging to different logger as you want, use below idiom.

package main

import (
	"github.com/fabricatorsltd/logstack"
)

var logger = struct {
	Console log.Logger
	Access  log.Logger
	Data    log.Logger
}{
	Console: log.Logger{
		TimeFormat: "15:04:05",
		Caller:     1,
		Writer: &log.ConsoleWriter{
			ColorOutput:    true,
			EndWithMessage: true,
		},
	},
	Access: log.Logger{
		Level: log.InfoLevel,
		Writer: &log.FileWriter{
			Filename:   "access.log",
			MaxSize:    50 * 1024 * 1024,
			MaxBackups: 7,
			LocalTime:  false,
		},
	},
	Data: log.Logger{
		Level: log.InfoLevel,
		Writer: &log.FileWriter{
			Filename:   "data.log",
			MaxSize:    50 * 1024 * 1024,
			MaxBackups: 7,
			LocalTime:  false,
		},
	},
}

func main() {
	logger.Console.Info().Msgf("hello world")
	logger.Access.Log().Msgf("handle request")
	logger.Data.Log().Msgf("some data")
}

SyslogWriter

SyslogWriter is a memory-efficient, cross-platform, dependency-free syslog writer, outperforms all other structured logging libraries.

package main

import (
	"net"
	"time"

	"github.com/fabricatorsltd/logstack"
)

func main() {
	go func() {
		ln, _ := net.Listen("tcp", "127.0.0.1:1601")
		for {
			conn, _ := ln.Accept()
			go func(c net.Conn) {
				b := make([]byte, 8192)
				n, _ := conn.Read(b)
				println(string(b[:n]))
			}(conn)
		}
	}()

	syslog := log.Logger{
		Level:      log.InfoLevel,
		TimeField:  "ts",
		TimeFormat: log.TimeFormatUnixMs,
		Writer: &log.SyslogWriter{
			Network: "tcp",            // "unixgram",
			Address: "127.0.0.1:1601", // "/run/systemd/journal/syslog",
			Tag:     "",
			Marker:  "@cee:",
			Dial:    net.Dial,
		},
	}

	syslog.Info().Str("foo", "bar").Int("an", 42).Msg("a syslog info")
	syslog.Warn().Str("foo", "bar").Int("an", 42).Msg("a syslog warn")
	time.Sleep(2)
}

// Output:
// <6>2022-07-24T18:48:15+08:00 127.0.0.1:59277 [11516]: @cee:{"ts":1658659695428,"level":"info","foo":"bar","an":42,"message":"a syslog info"}
// <4>2022-07-24T18:48:15+08:00 127.0.0.1:59277 [11516]: @cee:{"ts":1658659695429,"level":"warn","foo":"bar","an":42,"message":"a syslog warn"}

JournalWriter

To log to linux systemd journald, using JournalWriter.

log.DefaultLogger.Writer = &log.JournalWriter{
	JournalSocket: "/run/systemd/journal/socket",
}

log.Info().Int("number", 42).Str("foo", "bar").Msg("hello world")

EventlogWriter

To log to windows system event, using EventlogWriter.

log.DefaultLogger.Writer = &log.EventlogWriter{
	Source: ".NET Runtime",
	ID:     1000,
}

log.Info().Int("number", 42).Str("foo", "bar").Msg("hello world")

AsyncWriter

To logging asynchronously for performance stability, use AsyncWriter.

logger := log.Logger{
	Level:  log.InfoLevel,
	Writer: &log.AsyncWriter{
		ChannelSize: 100,
		Writer:      &log.FileWriter{
			Filename:   "main.log",
			FileMode:   0600,
			MaxSize:    50*1024*1024,
			MaxBackups: 7,
			LocalTime:  false,
		},
	},
}

logger.Info().Int("number", 42).Str("foo", "bar").Msg("a async info log")
logger.Warn().Int("number", 42).Str("foo", "bar").Msg("a async warn log")
logger.Writer.(io.Closer).Close()

Note: To flush data and quit safely, call AsyncWriter.Close() explicitly.

Stdlib Log Adapter

Using wrapped loggers for stdlog.

package main

import (
	stdlog "log"
	"os"

	"github.com/fabricatorsltd/logstack"
)

func main() {
	var logger *stdlog.Logger = (&log.Logger{
		Level:      log.InfoLevel,
		TimeField:  "date",
		TimeFormat: "2006-01-02",
		Caller:     1,
		Context:    log.NewContext(nil).Str("logger", "mystdlog").Int("myid", 42).Value(),
		Writer:     &log.IOWriter{os.Stdout},
	}).Std("", 0)

	logger.Print("hello from stdlog Print")
	logger.Println("hello from stdlog Println")
	logger.Printf("hello from stdlog %s", "Printf")
}

log/slog Adapter

Using wrapped loggers for log/slog.

package main

import (
	"log/slog"

	"github.com/fabricatorsltd/logstack"
)

func main() {
	slog.SetDefault((&log.Logger{
		Level:      log.InfoLevel,
		TimeField:  "date",
		TimeFormat: "2006-01-02",
		Caller:     1,
		Context:    log.NewContext(nil).Str("logger", "my_slog").Int("myid", 42).Value(),
	}).Slog())

	slog.Debug("hello from slog Info")
	slog.Info("hello from slog Info")
	slog.Warn("hello from slog Warn")
	slog.Error("hello from slog Error")
}

Third-party Logger Interceptor

Logger	Interceptor
logr	https://github.com/fabricatorsltd/logstack-contrib/tree/master/logr
gin	https://github.com/fabricatorsltd/logstack-contrib/tree/master/gin
fiber	https://github.com/fabricatorsltd/logstack-contrib/tree/master/fiber
gorm	https://github.com/fabricatorsltd/logstack-contrib/tree/master/gorm
grpc	https://github.com/fabricatorsltd/logstack-contrib/tree/master/grpc
grpcgateway	https://github.com/fabricatorsltd/logstack-contrib/tree/master/grpcgateway

User-defined Data Structure

To log with user-defined struct effectively, implements MarshalObject.

package main

import (
	"github.com/fabricatorsltd/logstack"
)

type User struct {
	ID   int
	Name string
	Pass string
}

func (u *User) MarshalObject(e *log.Entry) {
	e.Int("id", u.ID).Str("name", u.Name).Str("password", "***")
}

func main() {
	log.Info().Object("user", &User{1, "neo", "123456"}).Msg("")
	log.Info().EmbedObject(&User{2, "john", "abc"}).Msg("")
}

// Output:
//   {"time":"2020-07-12T05:03:43.949Z","level":"info","user":{"id":1,"name":"neo","password":"***"}}
//   {"time":"2020-07-12T05:03:43.949Z","level":"info","id":2,"name":"john","password":"***"}

Contextual Fields

To add preserved key:value pairs to each entry, use NewContext.

logger := log.Logger{
	Level:   log.InfoLevel,
	Context: log.NewContext(nil).Str("ctx", "some_ctx").Value(),
}

logger.Debug().Int("no0", 0).Msg("zero")
logger.Info().Int("no1", 1).Msg("first")
logger.Info().Int("no2", 2).Msg("second")

// Output:
//   {"time":"2020-07-12T05:03:43.949Z","level":"info","ctx":"some_ctx","no1":1,"message":"first"}
//   {"time":"2020-07-12T05:03:43.949Z","level":"info","ctx":"some_ctx","no2":2,"message":"second"}

You can make a copy of log and add contextual fields.

package main

import (
	"github.com/fabricatorsltd/logstack"
)

func main() {
	sublogger := log.DefaultLogger
	sublogger.Level = log.InfoLevel
	sublogger.Context = log.NewContext(nil).Str("ctx", "some_ctx").Value()

	sublogger.Debug().Int("no0", 0).Msg("zero")
	sublogger.Info().Int("no1", 1).Msg("first")
	sublogger.Info().Int("no2", 2).Msg("second")
	log.Debug().Int("no3", 3).Msg("no context")
}

// Output:
//   {"time":"2021-06-14T06:36:42.904+02:00","level":"info","ctx":"some_ctx","no1":1,"message":"first"}
//   {"time":"2021-06-14T06:36:42.905+02:00","level":"info","ctx":"some_ctx","no2":2,"message":"second"}
//   {"time":"2021-06-14T06:36:42.906+02:00","level":"debug","no3":3,"message":"no context"}

High Performance

The most common benchmarks(disable/normal/interface/printf/caller) with zap/zerolog, which runs on github actions:

// go test -v -cpu=4 -run=none -bench=. -benchtime=10s -benchmem log_test.go
package main

import (
  "io"
  "os"
  "testing"

  log "github.com/fabricatorsltd/logstack"
  "github.com/rs/zerolog"
  "go.uber.org/zap"
  "go.uber.org/zap/zapcore"
)

const msg = "The quick brown fox jumps over the lazy dog"

var obj = struct {
  Rate string
  Low  int
  High float32
}{"15", 16, 123.2}

func BenchmarkDisableZap(b *testing.B) {
  logger := zap.New(zapcore.NewCore(
    zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig()),
    zapcore.AddSync(io.Discard),
    zapcore.InfoLevel,
  ))
  tokenErr := setBSToken(&logger)
  if tokenErr != "" {
    b.Fatal(tokenErr)
  }
  for i := 0; i < b.N; i++ {
    logger.Debug(msg, zap.String("rate", "15"), zap.Int("low", 16), zap.Float32("high", 123.2))
  }
}

func BenchmarkDisableZeroLog(b *testing.B) {
  zerolog.SetGlobalLevel(zerolog.InfoLevel)
  logger := zerolog.New(io.Discard).With().Timestamp().Logger()
  tokenErr := setBSToken(&logger)
  if tokenErr != "" {
    b.Fatal(tokenErr)
  }
  for i := 0; i < b.N; i++ {
    logger.Debug().Str("rate", "15").Int("low", 16).Float32("high", 123.2).Msg(msg)
  }
}

func BenchmarkDisablePhusLog(b *testing.B) {
  logger := log.Logger{Level: log.InfoLevel, Writer: log.IOWriter{io.Discard}}
  tokenErr := setBSToken(&logger)
  if tokenErr != "" {
    b.Fatal(tokenErr)
  }
  for i := 0; i < b.N; i++ {
    logger.Debug().Str("rate", "15").Int("low", 16).Float32("high", 123.2).Msg(msg)
  }
}

func BenchmarkNormalZap(b *testing.B) {
  logger := zap.New(zapcore.NewCore(
    zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig()),
    zapcore.AddSync(io.Discard),
    zapcore.InfoLevel,
  ))
  tokenErr := setBSToken(&logger)
  if tokenErr != "" {
    b.Fatal(tokenErr)
  }
  for i := 0; i < b.N; i++ {
    logger.Info(msg, zap.String("rate", "15"), zap.Int("low", 16), zap.Float32("high", 123.2))
  }
}

func BenchmarkNormalZeroLog(b *testing.B) {
  logger := zerolog.New(io.Discard).With().Timestamp().Logger()
  tokenErr := setBSToken(&logger)
  if tokenErr != "" {
    b.Fatal(tokenErr)
  }
  for i := 0; i < b.N; i++ {
    logger.Info().Str("rate", "15").Int("low", 16).Float32("high", 123.2).Msg(msg)
  }
}

func BenchmarkNormalPhusLog(b *testing.B) {
  logger := log.Logger{Writer: log.IOWriter{io.Discard}}
  tokenErr := setBSToken(&logger)
  if tokenErr != "" {
    b.Fatal(tokenErr)
  }
  for i := 0; i < b.N; i++ {
    logger.Info().Str("rate", "15").Int("low", 16).Float32("high", 123.2).Msg(msg)
  }
}

func BenchmarkInterfaceZap(b *testing.B) {
  logger := zap.New(zapcore.NewCore(
    zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig()),
    zapcore.AddSync(io.Discard),
    zapcore.InfoLevel,
  )).Sugar()
  tokenErr := setBSToken(&logger)
  if tokenErr != "" {
    b.Fatal(tokenErr)
  }
  for i := 0; i < b.N; i++ {
    logger.Infow(msg, "object", &obj)
  }
}

func BenchmarkInterfaceZeroLog(b *testing.B) {
  logger := zerolog.New(io.Discard).With().Timestamp().Logger()
  tokenErr := setBSToken(&logger)
  if tokenErr != "" {
    b.Fatal(tokenErr)
  }
  for i := 0; i < b.N; i++ {
    logger.Info().Interface("object", &obj).Msg(msg)
  }
}

func BenchmarkInterfacePhusLog(b *testing.B) {
  logger := log.Logger{Writer: log.IOWriter{io.Discard}}
  tokenErr := setBSToken(&logger)
  if tokenErr != "" {
    b.Fatal(tokenErr)
  }
  for i := 0; i < b.N; i++ {
    logger.Info().Interface("object", &obj).Msg(msg)
  }
}

func BenchmarkPrintfZap(b *testing.B) {
  logger := zap.New(zapcore.NewCore(
    zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig()),
    zapcore.AddSync(io.Discard),
    zapcore.InfoLevel,
  )).Sugar()
  tokenErr := setBSToken(&logger)
  if tokenErr != "" {
    b.Fatal(tokenErr)
  }
  for i := 0; i < b.N; i++ {
    logger.Infof("rate=%s low=%d high=%f msg=%s", "15", 16, 123.2, msg)
  }
}

func BenchmarkPrintfZeroLog(b *testing.B) {
  logger := zerolog.New(io.Discard).With().Timestamp().Logger()
  tokenErr := setBSToken(&logger)
  if tokenErr != "" {
    b.Fatal(tokenErr)
  }
  for i := 0; i < b.N; i++ {
    logger.Info().Msgf("rate=%s low=%d high=%f msg=%s", "15", 16, 123.2, msg)
  }
}

func BenchmarkPrintfPhusLog(b *testing.B) {
  logger := log.Logger{Writer: log.IOWriter{io.Discard}}
  tokenErr := setBSToken(&logger)
  if tokenErr != "" {
    b.Fatal(tokenErr)
  }
  for i := 0; i < b.N; i++ {
    logger.Info().Msgf("rate=%s low=%d high=%f msg=%s", "15", 16, 123.2, msg)
  }
}

func BenchmarkCallerZap(b *testing.B) {
  logger := zap.New(zapcore.NewCore(
    zapcore.NewJSONEncoder(zap.NewProductionEncoderConfig()),
    zapcore.AddSync(io.Discard),
    zapcore.InfoLevel),
    zap.AddCaller(),
  )
  tokenErr := setBSToken(&logger)
  if tokenErr != "" {
    b.Fatal(tokenErr)
  }
  for i := 0; i < b.N; i++ {
    logger.Info(msg, zap.String("rate", "15"), zap.Int("low", 16), zap.Float32("high", 123.2))
  }
}

func BenchmarkCallerZeroLog(b *testing.B) {
  logger := zerolog.New(io.Discard).With().Caller().Timestamp().Logger()
  tokenErr := setBSToken(&logger)
  if tokenErr != "" {
    b.Fatal(tokenErr)
  }
  for i := 0; i < b.N; i++ {
    logger.Info().Str("rate", "15").Int("low", 16).Float32("high", 123.2).Msg(msg)
  }
}

func BenchmarkCallerPhusLog(b *testing.B) {
  logger := log.Logger{Caller: 1, Writer: log.IOWriter{io.Discard}}
  tokenErr := setBSToken(&logger)
  if tokenErr != "" {
    b.Fatal(tokenErr)
  }
  for i := 0; i < b.N; i++ {
    logger.Info().Str("rate", "15").Int("low", 16).Float32("high", 123.2).Msg(msg)
  }
}

func setBSToken(l *log.Logger) string {
  bsToken := os.Getenv("BETTERSTACK_TOKEN")
  if bsToken == "" {
    return "please set BETTERSTACK_TOKEN env"
  }

  l.SetToken(bsToken)
  l.GoSync = true

  return ""
}

A Performance result as below, for daily benchmark results see github actions

BenchmarkDisableZap-4         	86193418	       142.8 ns/op	     192 B/op	       1 allocs/op
BenchmarkDisableZeroLog-4     	1000000000	        11.58 ns/op	       0 B/op	       0 allocs/op
BenchmarkDisablePhusLog-4     	1000000000	        11.93 ns/op	       0 B/op	       0 allocs/op

BenchmarkNormalZap-4          	 9152504	      1331 ns/op	     192 B/op	       1 allocs/op
BenchmarkNormalZeroLog-4      	14775375	       812.3 ns/op	       0 B/op	       0 allocs/op
BenchmarkNormalPhusLog-4      	27574824	       435.5 ns/op	       0 B/op	       0 allocs/op

BenchmarkInterfaceZap-4       	 6488127	      1850 ns/op	     208 B/op	       2 allocs/op
BenchmarkInterfaceZeroLog-4   	10102683	      1199 ns/op	      48 B/op	       1 allocs/op
BenchmarkInterfacePhusLog-4   	13968078	       858.7 ns/op	       0 B/op	       0 allocs/op

BenchmarkPrintfZap-4          	 7066578	      1687 ns/op	      80 B/op	       1 allocs/op
BenchmarkPrintfZeroLog-4      	 9119858	      1317 ns/op	      80 B/op	       1 allocs/op
BenchmarkPrintfPhusLog-4      	14854870	       808.7 ns/op	       0 B/op	       0 allocs/op

BenchmarkCallerZap-4          	 2931970	      4038 ns/op	     424 B/op	       3 allocs/op
BenchmarkCallerZeroLog-4      	 3029824	      3947 ns/op	     272 B/op	       4 allocs/op
BenchmarkCallerPhusLog-4      	 8405709	      1406 ns/op	     216 B/op	       2 allocs/op

This library uses the following special techniques to achieve better performance,

handwriting time formatting
manual inlining
unrolled functions

A Real World Example

The example starts a geoip http server which supports change log level dynamically

package main

import (
	"encoding/json"
	"fmt"
	"net"
	"net/http"
	"os"

	"github.com/phuslu/iploc"
	"github.com/fabricatorsltd/logstack"
)

type Config struct {
	Listen struct {
		Tcp string
	}
	Log struct {
		Level   string
		Maxsize int64
		Backups int
	}
}

type Handler struct {
	Config       *Config
	AccessLogger log.Logger
}

func (h *Handler) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
	reqID := log.NewXID()
	remoteIP, _, _ := net.SplitHostPort(req.RemoteAddr)
	geo := iploc.Country(net.ParseIP(remoteIP))

	h.AccessLogger.Log().
		Xid("req_id", reqID).
		Str("host", req.Host).
		Bytes("geo", geo).
		Str("remote_ip", remoteIP).
		Str("request_uri", req.RequestURI).
		Str("user_agent", req.UserAgent()).
		Str("referer", req.Referer()).
		Msg("access log")

	switch req.RequestURI {
	case "/debug", "/info", "/warn", "/error":
		log.DefaultLogger.SetLevel(log.ParseLevel(req.RequestURI[1:]))
	default:
		fmt.Fprintf(rw, `{"req_id":"%s","ip":"%s","geo":"%s"}`, reqID, remoteIP, geo)
	}
}

func main() {
	config := new(Config)
	err := json.Unmarshal([]byte(`{
		"listen": {
			"tcp": ":8080"
		},
		"log": {
			"level": "debug",
			"maxsize": 1073741824,
			"backups": 5
		}
	}`), config)
	if err != nil {
		log.Fatal().Msgf("json.Unmarshal error: %+v", err)
	}

	handler := &Handler{
		Config: config,
		AccessLogger: log.Logger{
			Writer: &log.FileWriter{
				Filename:   "access.log",
				MaxSize:    config.Log.Maxsize,
				MaxBackups: config.Log.Backups,
				LocalTime:  true,
			},
		},
	}

	if log.IsTerminal(os.Stderr.Fd()) {
		log.DefaultLogger = log.Logger{
			Level:      log.ParseLevel(config.Log.Level),
			Caller:     1,
			TimeFormat: "15:04:05",
			Writer: &log.ConsoleWriter{
				ColorOutput:    true,
				EndWithMessage: true,
			},
		}
		handler.AccessLogger = log.DefaultLogger
	} else {
		log.DefaultLogger = log.Logger{
			Level: log.ParseLevel(config.Log.Level),
			Writer: &log.FileWriter{
				Filename:   "main.log",
				MaxSize:    config.Log.Maxsize,
				MaxBackups: config.Log.Backups,
				LocalTime:  true,
			},
		}
	}

	server := &http.Server{
		Addr:     config.Listen.Tcp,
		ErrorLog: log.DefaultLogger.Std(log.ErrorLevel, nil, "", 0),
		Handler:  handler,
	}

	log.Fatal().Err(server.ListenAndServe()).Msg("listen failed")
}

Acknowledgment

This log is heavily inspired by zerolog, glog, gjson and lumberjack.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

phuslog - High performance structured logging

Features

Interfaces

Logger

ConsoleWriter

FileWriter

Getting Started

Simple Logging Example

Customize the configuration and formatting:

Pretty Console Writer

Formatting Console Writer

Formatting Logfmt output

Rotating File Writer

Rotating File Writer within a total size

Rotating File Writer with compression

Random Sample Logger:

Multiple Dispatching Writer

Multiple Entry Writer

Multiple IO Writer

Multiple Combined Logger:

SyslogWriter

JournalWriter

EventlogWriter

AsyncWriter

Stdlib Log Adapter

log/slog Adapter

Third-party Logger Interceptor

User-defined Data Structure

Contextual Fields

High Performance

A Real World Example

Acknowledgment

Files

README.md

Latest commit

History

README.md

File metadata and controls

phuslog - High performance structured logging

Features

Interfaces

Logger

ConsoleWriter

FileWriter

Getting Started

Simple Logging Example

Customize the configuration and formatting:

Pretty Console Writer

Formatting Console Writer

Formatting Logfmt output

Rotating File Writer

Rotating File Writer within a total size

Rotating File Writer with compression

Random Sample Logger:

Multiple Dispatching Writer

Multiple Entry Writer

Multiple IO Writer

Multiple Combined Logger:

SyslogWriter

JournalWriter

EventlogWriter

AsyncWriter

Stdlib Log Adapter

log/slog Adapter

Third-party Logger Interceptor

User-defined Data Structure

Contextual Fields

High Performance

A Real World Example

Acknowledgment