golog is a simple, fast and easy-to-use level-based logger written in the Go Programming Language. Its only dependency is golang.org/x/sys, for terminal detection.
The only requirement is the Go Programming Language, version 1.27 or later.
Go modules
$ go get github.com/kataras/golog@latestOr edit your project's go.mod file and execute $ go build.
module your_project_name
go 1.27
require (
github.com/kataras/golog v0.2.0
)
$ go build
$ go get github.com/kataras/golog@latestpackage main
import (
"github.com/kataras/golog"
)
func main() {
// Default Output is `os.Stdout`,
// but you can change it:
// golog.SetOutput(os.Stderr)
// Time Format defaults to: "2006/01/02 15:04"
// you can change it to something else or disable it with:
// golog.SetTimeFormat("")
// Level defaults to "info",
// but you can change it:
golog.SetLevel("debug")
golog.Println("This is a raw message, no levels, no colors.")
golog.Info("This is an info message, with colors (if the output is terminal)")
golog.Warn("This is a warning message")
golog.Error("This is an error message")
golog.Debug("This is a debug message")
golog.Fatal(`Fatal will exit no matter what,
but it will also print the log message if logger's Level is >=FatalLevel`)
// Use any other supported logger through golog, e.g. the new "log/slog":
// golog.Install(slog.Default())
}| Name | Method | Text | Color |
|---|---|---|---|
"fatal" |
Fatal, Fatalf |
[FTAL] |
Red background |
"error" |
Error, Errorf |
[ERRO] |
Red foreground |
"warn" |
Warn, Warnf, Warningf |
[WARN] |
Magenta foreground |
"info" |
Info, Infof |
[INFO] |
Cyan foreground |
"debug" |
Debug, Debugf |
[DBUG] |
Yellow foreground |
On debug level the logger will store stacktrace information to the log instance, which is not printed but can be accessed through a
Handler(see below).
// GetTextForLevel returns the level's (rich) text.
fatalRichText := golog.GetTextForLevel(golog.FatalLevel, true)
// fatalRichText == "\x1b[41m[FTAL]\x1b[0m"// ParseLevel returns a Level based on its string name.
level := golog.ParseLevel("debug")
// level == golog.DebugLevelYou can customize the log level attributes.
func init() {
// Levels contains a map of the log levels and their attributes.
errorAttrs := golog.Levels[golog.ErrorLevel]
// Change a log level's text.
customColorCode := 156
errorAttrs.SetText("custom text", customColorCode)
// Get (rich) text per log level.
enableColors := true
errorRichText := errorAttrs.Text(enableColors)
}Alternatively, to change a specific text on a known log level, you can just call:
golog.ErrorText("custom text", 156)The golog.Logger is using common, expected log methods, therefore you can integrate it with ease.
Take for example the badger database. You want to add a prefix of [badger] in your logs when badger wants to print something.
- Create a child logger with a prefix text using the
Childfunction, - disable new lines (because they are managed by badger itself) and you are ready to GO:
opts := badger.DefaultOptions("./data")
opts.Logger = golog.Child("[badger]").DisableNewLine()
db, err := badger.Open(opts)
// [...]You can put golog in front of your existing loggers using the Install method.
Supported loggers:
- log
- slog
- logrus
Example for log/slog standard package:
// Simulate an slog.Logger preparation.
var myLogger = slog.New(slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{
Level: slog.LevelDebug,
}))
func main() {
golog.SetLevel("error")
golog.Install(myLogger)
golog.Error("error message")
}Example for log standard package:
// Simulate a log.Logger preparation.
myLogger := log.New(os.Stdout, "", 0)
golog.SetLevel("error")
golog.Install(myLogger)
golog.Error("error message")Example for sirupsen/logrus:
// Simulate a logrus logger preparation.
logrus.SetLevel(logrus.InfoLevel)
logrus.SetFormatter(&logrus.JSONFormatter{})
golog.Install(logrus.StandardLogger())
golog.Debug(`this debug message will not be shown,
because the logrus level is InfoLevel`)
golog.Error(`this error message will be visible as JSON,
because of logrus.JSONFormatter`)Every log entry can carry a unique identifier, generated with the standard library's uuid package (Go 1.27). It is off by default: no id appears anywhere until you install a generator.
import "uuid"
// NewV7 is the one to reach for in logs: v7 UUIDs carry a timestamp in their
// leading bits, so the identifiers sort in the order the lines were written.
golog.SetIDGenerator(uuid.NewV7)
golog.Info("this line has an id of its own")
// [INFO] 2026/08/21 16:04 01a0248d-c937-7ab9-aca1-d9a78c76325d this line has an id of its ownReturning a fixed value instead tags every line of a logger with the same identifier, so one request's lines can be picked back out of the stream. Derive that logger with Clone, which nothing else shares (Child caches one logger per key, so two requests on the same route would be setting each other's id):
requestID := uuid.NewV7()
reqLogger := golog.Default.Clone().
SetIDGenerator(func() uuid.UUID { return requestID })
reqLogger.Info("started") // both lines
reqLogger.Info("finished") // carry the same idThe identifier shows up as an "id" member in the JSON formatter, and as an id attribute when a log/slog logger is installed.
A Handler or Formatter reads a log's data out of its Fields, which is a map[string]any. Fields.Get and its Log.Field shorthand do the type assertion for you:
golog.Handle(func(log *golog.Log) bool {
username, ok := log.Field[string]("username")
if ok {
// [...]
}
return false
})Any value that completes the Formatter interface can be used to write to the (leveled) output writer. By default the "json" formatter is available.
import "github.com/kataras/golog"
func main() {
golog.SetLevel("debug")
golog.SetFormat("json", " ") // < --
// main.go#29
golog.Debugf("This is a %s with data (debug prints the stacktrace too)", "message", golog.Fields{
"username": "kataras",
})
}Output
{
"timestamp": 1591423477,
"level": "debug",
"message": "This is a message with data (debug prints the stacktrace too)",
"fields": {
"username": "kataras"
},
"stacktrace": [
{
"function": "main.main",
"source": "C:/example/main.go:29"
}
]
}golog.RegisterFormatter(new(myFormatter))
golog.SetFormat("myformat", options...)The Formatter interface looks like this:
// Formatter is responsible to print a log to the logger's writer.
type Formatter interface {
// The name of the formatter.
String() string
// Set any options and return a clone,
// generic. See `Logger.SetFormat`.
Options(opts ...any) Formatter
// Writes the "log" to "dest" logger.
Format(dest io.Writer, log *Log) bool
}The Logger can accept functions to handle (and print) each Log through its Handle method. The Handle method accepts a Handler.
type Handler func(value *Log) (handled bool)This method can be used to alter Log's fields based on custom logic or to change the output destination and its output format.
Create a JSON handler
import "encoding/json"
func jsonOutput(l *golog.Log) bool {
enc := json.NewEncoder(l.Logger.GetLevelOutput(l.Level.String()))
enc.SetIndent("", " ")
err := enc.Encode(l)
return err == nil
}Register the handler and log something
import "github.com/kataras/golog"
func main() {
golog.SetLevel("debug")
golog.Handle(jsonOutput)
// main.go#29
golog.Debugf("This is a %s with data (debug prints the stacktrace too)", "message", golog.Fields{
"username": "kataras",
})
}- basic
- output per level
- child
- add new level
- change text and color
- customize output
- multi output
- log rotation
- log identifiers NEW
- logrus integration
- log.Logger std integration
- log/slog integration
- postgres integration
- new instance
Each operation writes three log lines (error, warning, info) to a nop output, except BenchmarkGologPrintFile, which writes them to a real file so that the syscalls count too.
| test | ns/op (small is better) | B/op (small is better) | allocs/op (small is better) |
|---|---|---|---|
| BenchmarkGologPrint | 923 ns/op | 154 B/op | 5 allocs/op |
| BenchmarkGologPrintJSON | 2805 ns/op | 148 B/op | 5 allocs/op |
| BenchmarkGologPrintFile | 9067 ns/op | 139 B/op | 5 allocs/op |
| BenchmarkLogrusPrint | 7243 ns/op | 1742 B/op | 54 allocs/op |
| BenchmarkStdPrint | 1130 ns/op | 72 B/op | 5 allocs/op |
go1.27.0, windows/amd64.
BenchmarkStdPrintis the standard library'slog, which has no levels, no fields and no formatter to run: it is the floor, not a competitor. A plain golog line is a singleWrite; v0.1.15 issued up to nine per line, which is why the file benchmark was 3.5 times slower there (31 µs).
Click here for details.
If you find that something is not working as expected please open an issue.