Merge pull request #63 from cdr/examples

Add more examples

Author: nhooyr

.github/workflows/ci.yml

@@ -6,12 +6,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
-      - uses: actions/cache@v1
-        with:
-          path: ~/go/pkg/mod
-          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-          restore-keys: |
-            ${{ runner.os }}-go-
       - name: make fmt
         uses: ./ci/image
         with:
@@ -21,12 +15,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
-      - uses: actions/cache@v1
-        with:
-          path: ~/go/pkg/mod
-          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-          restore-keys: |
-            ${{ runner.os }}-go-
       - name: make lint
         uses: ./ci/image
         with:
@@ -36,12 +24,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
-      - uses: actions/cache@v1
-        with:
-          path: ~/go/pkg/mod
-          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-          restore-keys: |
-            ${{ runner.os }}-go-
       - name: make test
         uses: ./ci/image
         with:

example_force_json_test.go renamed to example_forcejson_test.go

@@ -0,0 +1,27 @@
+package slog_test
+
+import (
+	"context"
+	"net/http"
+	"os"
+
+	"cdr.dev/slog"
+	"cdr.dev/slog/sloggers/sloghuman"
+)
+
+func httpLogHelper(ctx context.Context, status int) {
+	slog.Helper()
+
+	l.Info(ctx, "sending HTTP response",
+		slog.F("status", status),
+	)
+}
+
+var l = sloghuman.Make(os.Stdout)
+
+func ExampleHelper() {
+	ctx := context.Background()
+	httpLogHelper(ctx, http.StatusBadGateway)
+
+	// 2019-12-07 21:18:42.567 [INFO]	<example_helper_test.go:24>	sending HTTP response	{"status": 502}
+}

example_helper_test.go

@@ -1,16 +1,21 @@
 package slog_test
 
 import (
+	"context"
 	"io"
+	"net"
+	"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 Example() {
 	// Would be provided by the testing framework.
 	var t testing.TB
 
@@ -38,20 +43,61 @@ func Example_slogtest() {
 	//      - EOF
 }
 
-func TestExample(t *testing.T) {
-	t.Parallel()
+func ExampleWith() {
+	ctx := slog.With(context.Background(), slog.F("field", 1))
 
-	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,
-				),
-			),
-		),
-	)
+	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 ExampleLogger_Named() {
+	ctx := context.Background()
+
+	l := sloghuman.Make(os.Stdout)
+	l = l.Named("http")
+	l.Info(ctx, "received request", slog.F("remote address", net.IPv4(127, 0, 0, 1)))
+
+	// 2019-12-07 21:20:56.974 [INFO]	(http)	<example_test.go:85>	received request	{"remote address": "127.0.0.1"}
+}
+
+func ExampleLogger_SetLevel() {
+	ctx := context.Background()
+
+	l := sloghuman.Make(os.Stdout)
+	l.Debug(ctx, "testing1")
+	l.Info(ctx, "received request")
+
+	l.SetLevel(slog.LevelDebug)
+
+	l.Debug(ctx, "testing2")
+
+	// 2019-12-07 21:26:20.945 [INFO]	<example_test.go:95>	received request
+	// 2019-12-07 21:26:20.945 [DEBUG]	<example_test.go:99>	testing2
 }

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

@@ -67,7 +67,7 @@ func Len(t testing.TB, n int, a interface{}, name string) {
 	t.Helper()
 	act := reflect.ValueOf(a).Len()
 	if n != act {
-		t.Fatalf("unexpected length %v of %v: %v", act, name, act)
+		t.Fatalf("expected len(%v) == %v but got %v", name, n, act)
 	}
 }
 

internal/assert/assert.go

@@ -1,5 +1,6 @@
-// Package slogfmt contains the code to format slog.SinkEntry.
-package slogfmt
+// Package entryhuman contains the code to format slog.SinkEntry
+// for humans.
+package entryhuman
 
 import (
 	"bytes"
@@ -8,7 +9,6 @@ import (
 	"io"
 	"os"
 	"path/filepath"
-	"regexp"
 	"strconv"
 	"strings"
 	"time"
@@ -21,11 +21,6 @@ import (
 	"cdr.dev/slog"
 )
 
-// FilterJSONField filters the json field f from j.
-func FilterJSONField(j, f string) string {
-	return regexp.MustCompile(`"`+f+`":[^,]+,`).ReplaceAllString(j, "")
-}
-
 // StripTimestamp strips the timestamp from entry and returns
 // it and the rest of the entry.
 func StripTimestamp(ent string) (time.Time, string, error) {
@@ -47,14 +42,14 @@ func c(w io.Writer, attrs ...color.Attribute) *color.Color {
 	return c
 }
 
-// HumanEntry returns a human readable format for ent.
+// Fmt returns a human readable format for ent.
 //
 // We never return with a trailing newline because Go's testing framework adds one
 // automatically and if we include one, then we'll get two newlines.
 // We also do not indent the fields as go's test does that automatically
 // for extra lines in a log so if we did it here, the fields would be indented
 // twice in test logs. So the Stderr logger indents all the fields itself.
-func HumanEntry(w io.Writer, ent slog.SinkEntry) string {
+func Fmt(w io.Writer, ent slog.SinkEntry) string {
 	var ents string
 	ts := ent.Time.Format(TimeFormat)
 	ents += ts + " "

internal/slogfmt/humanfmt.go renamed to internal/entryhuman/entry.go

@@ -1,4 +1,4 @@
-package slogfmt_test
+package entryhuman_test
 
 import (
 	"io/ioutil"
@@ -9,7 +9,7 @@ import (
 
 	"cdr.dev/slog"
 	"cdr.dev/slog/internal/assert"
-	"cdr.dev/slog/internal/slogfmt"
+	"cdr.dev/slog/internal/entryhuman"
 )
 
 var kt = time.Date(2000, time.February, 5, 4, 4, 4, 4, time.UTC)
@@ -18,7 +18,7 @@ func TestEntry(t *testing.T) {
 	t.Parallel()
 
 	test := func(t *testing.T, in slog.SinkEntry, exp string) {
-		act := slogfmt.HumanEntry(ioutil.Discard, in)
+		act := entryhuman.Fmt(ioutil.Discard, in)
 		assert.Equal(t, exp, act, "entry")
 	}
 
@@ -71,7 +71,7 @@ line2`)
 	t.Run("color", func(t *testing.T) {
 		t.Parallel()
 
-		act := slogfmt.HumanEntry(slogfmt.ForceColorWriter, slog.SinkEntry{
+		act := entryhuman.Fmt(entryhuman.ForceColorWriter, slog.SinkEntry{
 			Level: slog.LevelCritical,
 			Fields: slog.M(
 				slog.F("hey", "hi"),

internal/slogfmt/humanfmt_test.go renamed to internal/entryhuman/entry_test.go

@@ -1,3 +1,3 @@
-package slogfmt
+package entryhuman
 
 var ForceColorWriter = forceColorWriter

internal/slogfmt/export_test.go renamed to internal/entryhuman/export_test.go

@@ -1,4 +1,4 @@
-package slogfmt
+package entryhuman
 
 import (
 	"bytes"