Refactor zap around Faclity (uber-go#201)

Pivot the zap API significantly to make `Facility` the central extension point. This greatly reduces the surface area for extension authors to implement, and it alters some APIs to make composition more straightforward.
drgrib · Feb 15, 2017 · e5bfe32 · e5bfe32
1 parent 61159f0
commit e5bfe32
Show file tree

Hide file tree

Showing 47 changed files with 1,095 additions and 1,511 deletions.
diff --git a/benchmarks/logrus_bench_test.go b/benchmarks/logrus_bench_test.go
@@ -63,11 +63,11 @@ func BenchmarkLogrusAddingFields(b *testing.B) {
 }
 
 func BenchmarkZapBarkifyAddingFields(b *testing.B) {
-	logger := zbark.Barkify(zap.New(
+	logger := zbark.Barkify(zap.New(zap.WriterFacility(
 		zap.NewJSONEncoder(),
+		zap.Discard,
 		zap.DebugLevel,
-		zap.DiscardOutput,
-	))
+	)))
 	b.ResetTimer()
 	b.RunParallel(func(pb *testing.PB) {
 		for pb.Next() {
@@ -110,11 +110,11 @@ func BenchmarkLogrusWithAccumulatedContext(b *testing.B) {
 }
 
 func BenchmarkZapBarkifyWithAccumulatedContext(b *testing.B) {
-	baseLogger := zbark.Barkify(zap.New(
+	baseLogger := zbark.Barkify(zap.New(zap.WriterFacility(
 		zap.NewJSONEncoder(),
+		zap.Discard,
 		zap.DebugLevel,
-		zap.DiscardOutput,
-	))
+	)))
 	logger := baseLogger.WithFields(bark.Fields{
 		"int":               1,
 		"int64":             int64(1),

diff --git a/benchmarks/stdlib_bench_test.go b/benchmarks/stdlib_bench_test.go
@@ -41,11 +41,11 @@ func BenchmarkStandardLibraryWithoutFields(b *testing.B) {
 
 func BenchmarkZapStandardizeWithoutFields(b *testing.B) {
 	logger, err := zwrap.Standardize(
-		zap.New(
+		zap.New(zap.WriterFacility(
 			zap.NewJSONEncoder(),
+			zap.Discard,
 			zap.DebugLevel,
-			zap.DiscardOutput,
-		),
+		)),
 		zap.InfoLevel,
 	)
 	if err != nil {

diff --git a/benchmarks/zap_bench_test.go b/benchmarks/zap_bench_test.go
@@ -75,7 +75,11 @@ func fakeMessages(n int) []string {
 }
 
 func BenchmarkZapDisabledLevelsWithoutFields(b *testing.B) {
-	logger := zap.New(zap.NewJSONEncoder(), zap.ErrorLevel, zap.DiscardOutput)
+	logger := zap.New(zap.WriterFacility(
+		zap.NewJSONEncoder(),
+		zap.Discard,
+		zap.ErrorLevel,
+	))
 	b.ResetTimer()
 	b.RunParallel(func(pb *testing.PB) {
 		for pb.Next() {
@@ -87,9 +91,11 @@ func BenchmarkZapDisabledLevelsWithoutFields(b *testing.B) {
 func BenchmarkZapDisabledLevelsAccumulatedContext(b *testing.B) {
 	context := fakeFields()
 	logger := zap.New(
-		zap.NewJSONEncoder(),
-		zap.ErrorLevel,
-		zap.DiscardOutput,
+		zap.WriterFacility(
+			zap.NewJSONEncoder(),
+			zap.Discard,
+			zap.ErrorLevel,
+		),
 		zap.Fields(context...),
 	)
 	b.ResetTimer()
@@ -101,11 +107,11 @@ func BenchmarkZapDisabledLevelsAccumulatedContext(b *testing.B) {
 }
 
 func BenchmarkZapDisabledLevelsAddingFields(b *testing.B) {
-	logger := zap.New(
+	logger := zap.New(zap.WriterFacility(
 		zap.NewJSONEncoder(),
+		zap.Discard,
 		zap.ErrorLevel,
-		zap.DiscardOutput,
-	)
+	))
 	b.ResetTimer()
 	b.RunParallel(func(pb *testing.PB) {
 		for pb.Next() {
@@ -115,27 +121,27 @@ func BenchmarkZapDisabledLevelsAddingFields(b *testing.B) {
 }
 
 func BenchmarkZapDisabledLevelsCheckAddingFields(b *testing.B) {
-	logger := zap.New(
+	logger := zap.New(zap.WriterFacility(
 		zap.NewJSONEncoder(),
+		zap.Discard,
 		zap.ErrorLevel,
-		zap.DiscardOutput,
-	)
+	))
 	b.ResetTimer()
 	b.RunParallel(func(pb *testing.PB) {
 		for pb.Next() {
-			if m := logger.Check(zap.InfoLevel, "Should be discarded."); m.OK() {
+			if m := logger.Check(zap.InfoLevel, "Should be discarded."); m != nil {
 				m.Write(fakeFields()...)
 			}
 		}
 	})
 }
 
 func BenchmarkZapAddingFields(b *testing.B) {
-	logger := zap.New(
+	logger := zap.New(zap.WriterFacility(
 		zap.NewJSONEncoder(),
+		zap.Discard,
 		zap.DebugLevel,
-		zap.DiscardOutput,
-	)
+	))
 	b.ResetTimer()
 	b.RunParallel(func(pb *testing.PB) {
 		for pb.Next() {
@@ -147,9 +153,11 @@ func BenchmarkZapAddingFields(b *testing.B) {
 func BenchmarkZapWithAccumulatedContext(b *testing.B) {
 	context := fakeFields()
 	logger := zap.New(
-		zap.NewJSONEncoder(),
-		zap.DebugLevel,
-		zap.DiscardOutput,
+		zap.WriterFacility(
+			zap.NewJSONEncoder(),
+			zap.Discard,
+			zap.DebugLevel,
+		),
 		zap.Fields(context...),
 	)
 	b.ResetTimer()
@@ -161,11 +169,11 @@ func BenchmarkZapWithAccumulatedContext(b *testing.B) {
 }
 
 func BenchmarkZapWithoutFields(b *testing.B) {
-	logger := zap.New(
+	logger := zap.New(zap.WriterFacility(
 		zap.NewJSONEncoder(),
+		zap.Discard,
 		zap.DebugLevel,
-		zap.DiscardOutput,
-	)
+	))
 	b.ResetTimer()
 	b.RunParallel(func(pb *testing.PB) {
 		for pb.Next() {
@@ -176,12 +184,11 @@ func BenchmarkZapWithoutFields(b *testing.B) {
 
 func BenchmarkZapSampleWithoutFields(b *testing.B) {
 	messages := fakeMessages(1000)
-	base := zap.New(
+	logger := zap.New(zwrap.Sample(zap.WriterFacility(
 		zap.NewJSONEncoder(),
+		zap.Discard,
 		zap.DebugLevel,
-		zap.DiscardOutput,
-	)
-	logger := zwrap.Sample(base, time.Second, 10, 10000)
+	), time.Second, 10, 10000))
 	b.ResetTimer()
 	b.RunParallel(func(pb *testing.PB) {
 		i := 0
@@ -194,12 +201,11 @@ func BenchmarkZapSampleWithoutFields(b *testing.B) {
 
 func BenchmarkZapSampleAddingFields(b *testing.B) {
 	messages := fakeMessages(1000)
-	base := zap.New(
+	logger := zap.New(zwrap.Sample(zap.WriterFacility(
 		zap.NewJSONEncoder(),
+		zap.Discard,
 		zap.DebugLevel,
-		zap.DiscardOutput,
-	)
-	logger := zwrap.Sample(base, time.Second, 10, 10000)
+	), time.Second, 10, 10000))
 	b.ResetTimer()
 	b.RunParallel(func(pb *testing.PB) {
 		i := 0
@@ -212,18 +218,17 @@ func BenchmarkZapSampleAddingFields(b *testing.B) {
 
 func BenchmarkZapSampleCheckWithoutFields(b *testing.B) {
 	messages := fakeMessages(1000)
-	base := zap.New(
+	logger := zap.New(zwrap.Sample(zap.WriterFacility(
 		zap.NewJSONEncoder(),
+		zap.Discard,
 		zap.DebugLevel,
-		zap.DiscardOutput,
-	)
-	logger := zwrap.Sample(base, time.Second, 10, 10000)
+	), time.Second, 10, 10000))
 	b.ResetTimer()
 	b.RunParallel(func(pb *testing.PB) {
 		i := 0
 		for pb.Next() {
 			i++
-			if cm := logger.Check(zap.InfoLevel, messages[i%1000]); cm.OK() {
+			if cm := logger.Check(zap.InfoLevel, messages[i%1000]); cm != nil {
 				cm.Write()
 			}
 		}
@@ -232,18 +237,17 @@ func BenchmarkZapSampleCheckWithoutFields(b *testing.B) {
 
 func BenchmarkZapSampleCheckAddingFields(b *testing.B) {
 	messages := fakeMessages(1000)
-	base := zap.New(
+	logger := zap.New(zwrap.Sample(zap.WriterFacility(
 		zap.NewJSONEncoder(),
+		zap.Discard,
 		zap.DebugLevel,
-		zap.DiscardOutput,
-	)
-	logger := zwrap.Sample(base, time.Second, 10, 10000)
+	), time.Second, 10, 10000))
 	b.ResetTimer()
 	b.RunParallel(func(pb *testing.PB) {
 		i := 0
 		for pb.Next() {
 			i++
-			if m := logger.Check(zap.InfoLevel, messages[i%1000]); m.OK() {
+			if m := logger.Check(zap.InfoLevel, messages[i%1000]); m != nil {
 				m.Write(fakeFields()...)
 			}
 		}

diff --git a/checked_message.go b/checked_message.go