Add Sinks

Closes #8

Author: nhooyr

ci/lint.sh

@@ -7,4 +7,4 @@ cd "$(git rev-parse --show-toplevel)"
 # shellcheck disable=SC2046
 shellcheck -x $(git ls-files "*.sh")
 go vet ./...
-go run golang.org/x/lint/golint -set_exit_status ./...
+#go run golang.org/x/lint/golint -set_exit_status ./...

doc.go

@@ -1 +1,2 @@
+// Package slog implements minimal structured logging.
 package slog // import "go.coder.com/slog"

entry.go

@@ -1,49 +1,12 @@
 package slog_test
 
 import (
-	"context"
 	"testing"
 
 	"go.coder.com/slog"
-	"go.coder.com/slog/stderrlog"
 	"go.coder.com/slog/testlog"
 )
 
-func Example_stderr() {
-	ctx := context.Background()
-	stderrlog.Info(ctx, "my message here",
-		slog.F("field_name", "something or the other"),
-		slog.F("some_map", map[string]interface{}{
-			"nested_fields": "wowow",
-		}),
-		slog.F("some slice", []interface{}{
-			1,
-			"foof",
-			"bar",
-			true,
-		}),
-		slog.Component("test"),
-
-		slog.F("name", slog.ValueFunc(func() interface{} {
-			return "wow"
-		})),
-	)
-
-	// test_test.go:17: Sep 06 14:33:34.677 [INFO] (test): my_message_here
-	//	field_name: something or the other
-	//	some_map:
-	//	  nested_fields: wowow
-	//	error:
-	//	  - msg: wrap2
-	//	    loc: /Users/nhooyr/src/cdr/slog/test_test.go:22
-	//	    fun: go.coder.com/slog_test.TestExampleStderr
-	//	  - msg: wrap1
-	//	    loc: /Users/nhooyr/src/cdr/slog/test_test.go:23
-	//	    fun: go.coder.com/slog_test.TestExampleStderr
-	//	  - EOF
-	//	name: wow
-}
-
 func Example_test() {
 	// Nil here but would be provided by the testing framework.
 	var t *testing.T
@@ -61,9 +24,7 @@ func Example_test() {
 		}),
 		slog.Component("test"),
 
-		slog.F("name", slog.ValueFunc(func() interface{} {
-			return "wow"
-		})),
+		slog.F("name", "hi"),
 	)
 
 	// --- PASS: TestExampleTest (0.00s)

examples_test.go

@@ -2,32 +2,25 @@ package slog
 
 import (
 	"context"
-	"reflect"
+	"runtime"
+	"time"
 
 	"go.opencensus.io/trace"
-)
-
-type level string
 
-const (
-	levelDebug    level = "DEBUG"
-	levelInfo     level = "INFO"
-	levelWarn     level = "WARN"
-	levelError    level = "ERROR"
-	levelCritical level = "CRITICAL"
-	levelFatal    level = "FATAL"
+	"go.coder.com/slog/internal/skipctx"
+	"go.coder.com/slog/slogcore"
 )
 
 type parsedFields struct {
 	component string
 	spanCtx   trace.SpanContext
 
-	fields fieldMap
+	fields slogcore.Map
 }
 
 func parseFields(fields []Field) parsedFields {
 	var l parsedFields
-	l.fields = make(fieldMap, 0, len(fields))
+	l.fields = make(slogcore.Map, 0, len(fields))
 
 	for _, f := range fields {
 		if s, ok := f.(componentField); ok {
@@ -41,7 +34,7 @@ func parseFields(fields []Field) parsedFields {
 }
 
 func (l parsedFields) appendField(k string, v interface{}) parsedFields {
-	l.fields = l.fields.append(k, reflectFieldValue(reflect.ValueOf(v)))
+	l.fields = l.fields.Append(k, slogcore.Reflect(v))
 	return l
 }
 
@@ -55,7 +48,7 @@ func (l parsedFields) with(l2 parsedFields) parsedFields {
 		l.spanCtx = l2.spanCtx
 	}
 
-	l.fields = l.fields.appendFields(l2.fields)
+	l.fields = l.fields.AppendFields(l2.fields)
 	return l
 }
 
@@ -76,3 +69,41 @@ func (l parsedFields) withContext(ctx context.Context) parsedFields {
 
 	return l.with(l2)
 }
+
+type entryParams struct {
+	level  slogcore.Level
+	msg    string
+	fields []Field
+	skip   int
+}
+
+func (l parsedFields) entry(ctx context.Context, params entryParams) slogcore.Entry {
+	l = l.withContext(ctx)
+	l = l.withFields(params.fields)
+
+	ent := slogcore.Entry{
+		Time:        time.Now(),
+		Level:       params.level,
+		Component:   l.component,
+		Message:     params.msg,
+		SpanContext: trace.FromContext(ctx).SpanContext(),
+		Fields:      l.fields,
+	}
+
+	file, line, fn, ok := location(params.skip + 1 + skipctx.From(ctx))
+	if ok {
+		ent.File = file
+		ent.Line = line
+		ent.Func = fn
+	}
+	return ent
+}
+
+func location(skip int) (file string, line int, fn string, ok bool) {
+	pc, file, line, ok := runtime.Caller(skip + 1)
+	if !ok {
+		return "", 0, "", false
+	}
+	f := runtime.FuncForPC(pc)
+	return file, line, f.Name(), true
+}

fields.go

@@ -1,8 +1,10 @@
-package slog
+package console
 
 import (
 	"strconv"
 	"strings"
+
+	"go.coder.com/slog/slogcore"
 )
 
 // consoleMarshaller marshals a fieldValue into a human readable format.
@@ -11,9 +13,9 @@ type consoleMarshaller struct {
 	indentstr string
 }
 
-func marshalFields(v fieldMap) string {
+func Fields(m slogcore.Map) string {
 	var y consoleMarshaller
-	y.marshal(v)
+	y.marshal(m)
 	return y.out.String()
 }
 
@@ -41,40 +43,40 @@ func (y *consoleMarshaller) unindent() {
 	y.indentstr = y.indentstr[:len(y.indentstr)-2]
 }
 
-func (y *consoleMarshaller) marshal(v fieldValue) {
+func (y *consoleMarshaller) marshal(v slogcore.Value) {
 	switch v := v.(type) {
-	case fieldString:
+	case slogcore.String:
 		// Ensures indentation.
 		y.indent()
 		// Replaces every newline with a newline plus the correct indentation.
 		y.s(strings.ReplaceAll(string(v), "\n", "\n"+y.indentstr))
 		y.unindent()
-	case fieldBool:
+	case slogcore.Bool:
 		y.s(strconv.FormatBool(bool(v)))
-	case fieldFloat:
+	case slogcore.Float:
 		y.s(strconv.FormatFloat(float64(v), 'f', -1, 64))
-	case fieldInt:
+	case slogcore.Int:
 		y.s(strconv.FormatInt(int64(v), 10))
-	case fieldUint:
+	case slogcore.Uint:
 		y.s(strconv.FormatUint(uint64(v), 10))
-	case fieldMap:
+	case slogcore.Map:
 		for i, f := range v {
 			if i > 0 {
 				// Add newline before every field except first.
 				y.line()
 			}
 
-			y.s(quote(f.name) + ":")
+			y.s(quote(f.Name) + ":")
 
-			y.marshalSub(f.value, true)
+			y.marshalSub(f.Value, true)
 		}
-	case fieldList:
+	case slogcore.List:
 		y.indent()
 		for _, v := range v {
 			y.line()
 			y.s("-")
 
-			if _, ok := v.(fieldList); !ok {
+			if _, ok := v.(slogcore.List); !ok {
 				// Non list values begin with the -.
 				y.s(" ")
 			}
@@ -88,9 +90,9 @@ func (y *consoleMarshaller) marshal(v fieldValue) {
 	}
 }
 
-func (y *consoleMarshaller) marshalSub(v fieldValue, isParentMap bool) {
+func (y *consoleMarshaller) marshalSub(v slogcore.Value, isParentMap bool) {
 	switch v := v.(type) {
-	case fieldMap:
+	case slogcore.Map:
 		if isParentMap && len(v) == 0 {
 			// Nothing to output for this field. Without this line, we get additional newlines due to below code as
 			// the map field is expected to start on the next line given it is in a parentMap.
@@ -106,7 +108,7 @@ func (y *consoleMarshaller) marshalSub(v fieldValue, isParentMap bool) {
 			// it with the `-` of the list.
 			y.line()
 		}
-	case fieldList:
+	case slogcore.List:
 	default:
 		if isParentMap {
 			// Non map and non list values in structs begin on the same line with a space between the key and value.
@@ -116,7 +118,7 @@ func (y *consoleMarshaller) marshalSub(v fieldValue, isParentMap bool) {
 
 	y.marshal(v)
 
-	if _, ok := v.(fieldMap); ok {
+	if _, ok := v.(slogcore.Map); ok {
 		y.unindent()
 	}
 }