uber-go/zap


Blazing fast, structured, leveled logging in Go.

https://godoc.org/go.uber.org/zap

License: Other

Language: Go

Keywords: golang, logging, structured-logging, zap


⚡️ zap GoDoc Build Status Coverage Status

Blazing fast, structured, leveled logging in Go.

Installation

go get -u go.uber.org/zap

Note that zap only supports the two most recent minor versions of Go.

Quick Start

In contexts where performance is nice, but not critical, use the SugaredLogger. It's 4-10x faster than than other structured logging libraries and includes both structured and printf-style APIs.

logger, _ := zap.NewProduction()
defer logger.Sync() // flushes buffer, if any
sugar := logger.Sugar()
sugar.Infow("Failed to fetch URL.",
  // Structured context as loosely-typed key-value pairs.
  "url", url,
  "attempt", 3,
  "backoff", time.Second,
)
sugar.Infof("Failed to fetch URL: %s", url)

When performance and type safety are critical, use the Logger. It's even faster than the SugaredLogger and allocates far less, but it only supports structured logging.

logger, _ := zap.NewProduction()
defer logger.Sync()
logger.Info("Failed to fetch URL.",
  // Structured context as strongly-typed Field values.
  zap.String("url", url),
  zap.Int("attempt", 3),
  zap.Duration("backoff", time.Second),
)

Performance

For applications that log in the hot path, reflection-based serialization and string formatting are prohibitively expensive — they're CPU-intensive and make many small allocations. Put differently, using encoding/json and fmt.Fprintf to log tons of interface{}s makes your application slow.

Zap takes a different approach. It includes a reflection-free, zero-allocation JSON encoder, and the base Logger strives to avoid serialization overhead and allocations wherever possible. By building the high-level SugaredLogger on that foundation, zap lets users choose when they need to count every allocation and when they'd prefer a more familiar, loosely-typed API.

As measured by its own benchmarking suite, not only is zap more performant than comparable structured logging libraries — it's also faster than the standard library. Like all benchmarks, take these with a grain of salt.1

Log a message and 10 fields:

Library Time Bytes Allocated Objects Allocated
⚡️ zap 1526 ns/op 704 B/op 2 allocs/op
⚡️ zap (sugared) 2274 ns/op 1610 B/op 20 allocs/op
go-kit 5854 ns/op 2895 B/op 66 allocs/op
logrus 9117 ns/op 6092 B/op 78 allocs/op
lion 9408 ns/op 5807 B/op 63 allocs/op
apex/log 17007 ns/op 3832 B/op 65 allocs/op
log15 21290 ns/op 5632 B/op 93 allocs/op

Log a message with a logger that already has 10 fields of context:

Library Time Bytes Allocated Objects Allocated
⚡️ zap 446 ns/op 0 B/op 0 allocs/op
⚡️ zap (sugared) 599 ns/op 80 B/op 2 allocs/op
lion 5231 ns/op 4074 B/op 38 allocs/op
go-kit 6424 ns/op 3046 B/op 52 allocs/op
logrus 7578 ns/op 4564 B/op 63 allocs/op
apex/log 15697 ns/op 2898 B/op 51 allocs/op
log15 15879 ns/op 2642 B/op 44 allocs/op

Log a static string, without any context or printf-style templating:

Library Time Bytes Allocated Objects Allocated
⚡️ zap 418 ns/op 0 B/op 0 allocs/op
standard library 524 ns/op 80 B/op 2 allocs/op
⚡️ zap (sugared) 628 ns/op 80 B/op 2 allocs/op
go-kit 1011 ns/op 656 B/op 13 allocs/op
lion 1382 ns/op 1224 B/op 10 allocs/op
logrus 2263 ns/op 1505 B/op 27 allocs/op
apex/log 3198 ns/op 584 B/op 11 allocs/op
log15 5787 ns/op 1592 B/op 26 allocs/op

Development Status: Stable

All APIs are finalized, and no breaking changes will be made in the 1.x series of releases. Users of semver-aware dependency management systems should pin zap to ^1.


Released under the MIT License.

1 In particular, keep in mind that we may be benchmarking against slightly older versions of other libraries. Versions are pinned in zap's glide.lock file.

Project Statistics

Sourcerank 11
Repository Size 895 KB
Stars 6,397
Forks 480
Watchers 201
Open issues 65
Dependencies 2
Contributors 33
Tags 11
Created
Last updated
Last pushed

Top Contributors See all

Akshay Shah Prashant Varanasi Joshua T Corbin bill fumerola Vladimir Skipor ZymoticB Will Hughes Aiden Scandella Suyash 尹吉峰 Pravendra Singh Mikhail Lukyanchenko Erno Hopearuoho Osamu TONOMORI Chuck Thier oibe Glib Smaga Matias Lahti Arthur Lee htrendev

Packages Referencing this Repo

github.com/uber-go/zap/zbark
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
go.uber.org/zap
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
github.com/uber-go/zap/benchmarks
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
github.com/uber-go/zap/buffer
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
go.uber.org/zap/zwrap
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
go.uber.org/zap/zbark
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
go.uber.org/zap/testutils
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
github.com/uber-common/zap/testutils
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
github.com/uber-go/zap/testutils
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
github.com/uber-go/zap/spywrite
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
github.com/uber-go/zap/zwrap
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
github.com/uber-common/zap/spywrite
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
github.com/uber-common/zap/zwrap
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
github.com/uber-common/zap/spy
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
go.uber.org/zap/spy
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
go.uber.org/zap/spywrite
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
github.com/uber-go/zap/spy
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
github.com/uber-common/zap
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
github.com/uber-go/zap
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars
github.com/uber-common/zap/zbark
Blazing fast, structured, leveled logging in Go.
Latest release v1.5.0 - Published - 6.4K stars

Recent Tags See all

v1.5.0 July 23, 2017
v1.4.1 June 08, 2017
v1.4.0 May 12, 2017
v1.3.0 April 25, 2017
v1.2.0 April 14, 2017
v1.1.0 March 31, 2017
v1.0.0 March 15, 2017
v1.0.0-rc.3 March 07, 2017
v1.0.0-rc.2 February 23, 2017
v1.0.0-rc.1 February 15, 2017
v0.1.0-beta.1 February 07, 2017

Interesting Forks See all

Laisky/zap
Blazing fast, structured, leveled logging in Go.
Go - Other - Last pushed - 1 stars
CNXTEoE/zap
Fast, structured, leveled logging in Go.
Go - Updated - 1 stars
imkira/zap
Fast, structured, leveled logging in Go
Go - Last pushed - 1 stars - 1 forks
dmreiland/zap
Fast, structured, leveled logging in Go.
Go - Updated - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2017-05-12 21:15:39 UTC

Login to resync this repository