Add more examples

Author: nhooyr

example_force_json_test.go renamed to example_forcejson_test.go

@@ -1,16 +1,54 @@
 package slog_test
 
 import (
+	"context"
 	"io"
+	"os"
 	"testing"
 
 	"golang.org/x/xerrors"
 
 	"cdr.dev/slog"
+	"cdr.dev/slog/sloggers/sloghuman"
+	"cdr.dev/slog/sloggers/slogstackdriver"
 	"cdr.dev/slog/sloggers/slogtest"
 )
 
-func Example_slogtest() {
+func ExampleWith() {
+	ctx := slog.With(context.Background(), slog.F("field", 1))
+
+	l := sloghuman.Make(os.Stdout)
+	l.Info(ctx, "msg")
+
+	// 2019-12-07 20:54:23.986 [INFO]	<example_test.go:20>	msg	{"field": 1}
+}
+
+func ExampleStdlib() {
+	ctx := slog.With(context.Background(), slog.F("field", 1))
+	l := slog.Stdlib(ctx, sloghuman.Make(os.Stdout))
+
+	l.Print("msg")
+
+	// 2019-12-07 20:54:23.986 [INFO]	(stdlib)	<example_test.go:29>	msg	{"field": 1}
+}
+
+func ExampleTee() {
+	ctx := context.Background()
+	l := sloghuman.Make(os.Stdout)
+
+	f, err := os.OpenFile("stackdriver", os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0644)
+	if err != nil {
+		l.Fatal(ctx, "failed to open stackdriver log file", slog.Error(err))
+	}
+
+	l = slog.Tee(l, slogstackdriver.Make(f, nil))
+
+	l.Info(ctx, "log to stdout and stackdriver")
+
+	// 2019-12-07 20:59:55.790 [INFO]	<example_test.go:46>	log to stdout and stackdriver
+}
+
+func Example() {
 	// Would be provided by the testing framework.
 	var t testing.TB
 
@@ -37,21 +75,3 @@ func Example_slogtest() {
 	//            /Users/nhooyr/src/cdr/slog/examples_test.go:49
 	//      - EOF
 }
-
-func TestExample(t *testing.T) {
-	t.Parallel()
-
-	slogtest.Info(t, "my message here",
-		slog.F("field_name", "something or the other"),
-		slog.F("some_map", slog.M(
-			slog.F("nested_fields", "wowow"),
-		)),
-		slog.Error(
-			xerrors.Errorf("wrap1: %w",
-				xerrors.Errorf("wrap2: %w",
-					io.EOF,
-				),
-			),
-		),
-	)
-}

example_test.go

@@ -0,0 +1,32 @@
+package slog_test
+
+import (
+	"context"
+	"os"
+
+	"cdr.dev/slog"
+	"cdr.dev/slog/sloggers/sloghuman"
+)
+
+type vals struct {
+	first  int
+	second int
+}
+
+func (s *vals) SlogValue() interface{} {
+	return slog.M(
+		slog.F("total", s.first+s.second),
+		slog.F("first", s.first),
+		slog.F("second", s.second),
+	)
+}
+
+func ExampleValue() {
+	l := sloghuman.Make(os.Stdout)
+	l.Info(context.Background(), "hello", slog.F("val", &vals{
+		first:  3,
+		second: 6,
+	}))
+
+	// 2019-12-07 21:06:14.636 [INFO]	<example_value_test.go:26>	hello	{"val": {"total": 9, "first": 3, "second": 6}}
+}

example_value_test.go

@@ -56,11 +56,11 @@ func fieldsFromContext(ctx context.Context) Map {
 	return l
 }
 
-// Context returns a context that contains the given fields.
+// With returns a context that contains the given fields.
 // Any logs written with the provided context will have
 // the given logs prepended.
 // It will append to any fields already in ctx.
-func Context(ctx context.Context, fields ...Field) context.Context {
+func With(ctx context.Context, fields ...Field) context.Context {
 	f1 := fieldsFromContext(ctx)
 	f2 := combineFields(f1, fields)
 	return fieldsWithContext(ctx, f2)

slog.go

@@ -65,7 +65,7 @@ func TestLogger(t *testing.T) {
 			l.Debug(ctx, "logging in helper")
 		}
 
-		ctx := slog.Context(bg, slog.F(
+		ctx := slog.With(bg, slog.F(
 			"ctx", 1024),
 		)
 		h(ctx)
@@ -96,7 +96,7 @@ func TestLogger(t *testing.T) {
 		l = l.Named("hello2")
 
 		ctx, span := trace.StartSpan(bg, "trace")
-		ctx = slog.Context(ctx, slog.F("ctx", io.EOF))
+		ctx = slog.With(ctx, slog.F("ctx", io.EOF))
 		l = l.With(slog.F("with", 2))
 
 		l.Info(ctx, "meow", slog.F("hi", "xd"))