feat: add logc package, support AddGlobalFields for both logc and logx. (#2463)

* feat: add logc package

* feat: add logc, add AddGlobalFields for both logc and logx

* chore: add benchmarks

* chore: add more tests

* chore: simplify globalFields in logx

* chore: remove outdated comments

core/logc/logs.go

@@ -0,0 +1,122 @@
+package logc
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/zeromicro/go-zero/core/logx"
+)
+
+type (
+	LogConf  = logx.LogConf
+	LogField = logx.LogField
+)
+
+// AddGlobalFields adds global fields.
+func AddGlobalFields(fields ...LogField) {
+	logx.AddGlobalFields(fields...)
+}
+
+// Alert alerts v in alert level, and the message is written to error log.
+func Alert(_ context.Context, v string) {
+	logx.Alert(v)
+}
+
+// Close closes the logging.
+func Close() error {
+	return logx.Close()
+}
+
+// Error writes v into error log.
+func Error(ctx context.Context, v ...interface{}) {
+	getLogger(ctx).Error(v...)
+}
+
+// Errorf writes v with format into error log.
+func Errorf(ctx context.Context, format string, v ...interface{}) {
+	getLogger(ctx).Errorf(fmt.Errorf(format, v...).Error())
+}
+
+// Errorv writes v into error log with json content.
+// No call stack attached, because not elegant to pack the messages.
+func Errorv(ctx context.Context, v interface{}) {
+	getLogger(ctx).Errorv(v)
+}
+
+// Errorw writes msg along with fields into error log.
+func Errorw(ctx context.Context, msg string, fields ...LogField) {
+	getLogger(ctx).Errorw(msg, fields...)
+}
+
+// Field returns a LogField for the given key and value.
+func Field(key string, value interface{}) LogField {
+	return logx.Field(key, value)
+}
+
+// Info writes v into access log.
+func Info(ctx context.Context, v ...interface{}) {
+	getLogger(ctx).Info(v...)
+}
+
+// Infof writes v with format into access log.
+func Infof(ctx context.Context, format string, v ...interface{}) {
+	getLogger(ctx).Infof(format, v...)
+}
+
+// Infov writes v into access log with json content.
+func Infov(ctx context.Context, v interface{}) {
+	getLogger(ctx).Infov(v)
+}
+
+// Infow writes msg along with fields into access log.
+func Infow(ctx context.Context, msg string, fields ...LogField) {
+	getLogger(ctx).Infow(msg, fields...)
+}
+
+// Must checks if err is nil, otherwise logs the error and exits.
+func Must(err error) {
+	logx.Must(err)
+}
+
+// MustSetup sets up logging with given config c. It exits on error.
+func MustSetup(c logx.LogConf) {
+	logx.MustSetup(c)
+}
+
+// SetLevel sets the logging level. It can be used to suppress some logs.
+func SetLevel(level uint32) {
+	logx.SetLevel(level)
+}
+
+// SetUp sets up the logx. If already set up, just return nil.
+// we allow SetUp to be called multiple times, because for example
+// we need to allow different service frameworks to initialize logx respectively.
+// the same logic for SetUp
+func SetUp(c LogConf) error {
+	return logx.SetUp(c)
+}
+
+// Slow writes v into slow log.
+func Slow(ctx context.Context, v ...interface{}) {
+	getLogger(ctx).Slow(v...)
+}
+
+// Slowf writes v with format into slow log.
+func Slowf(ctx context.Context, format string, v ...interface{}) {
+	getLogger(ctx).Slowf(format, v...)
+}
+
+// Slowv writes v into slow log with json content.
+func Slowv(ctx context.Context, v interface{}) {
+	getLogger(ctx).Slowv(v)
+}
+
+// Sloww writes msg along with fields into slow log.
+func Sloww(ctx context.Context, msg string, fields ...LogField) {
+	getLogger(ctx).Sloww(msg, fields...)
+}
+
+// getLogger returns the logx.Logger with the given ctx and correct caller.
+func getLogger(ctx context.Context) logx.Logger {
+	return logx.WithContext(ctx).WithCallerSkip(1)
+}

core/logc/logs_test.go

@@ -0,0 +1,218 @@
+package logc
+
+import (
+	"bytes"
+	"context"
+	"encoding/json"
+	"fmt"
+	"runtime"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/zeromicro/go-zero/core/logx"
+)
+
+func TestAddGlobalFields(t *testing.T) {
+	var buf bytes.Buffer
+	writer := logx.NewWriter(&buf)
+	old := logx.Reset()
+	logx.SetWriter(writer)
+	defer logx.SetWriter(old)
+
+	Info(context.Background(), "hello")
+	buf.Reset()
+
+	AddGlobalFields(Field("a", "1"), Field("b", "2"))
+	AddGlobalFields(Field("c", "3"))
+	Info(context.Background(), "world")
+	var m map[string]interface{}
+	assert.NoError(t, json.Unmarshal(buf.Bytes(), &m))
+	assert.Equal(t, "1", m["a"])
+	assert.Equal(t, "2", m["b"])
+	assert.Equal(t, "3", m["c"])
+}
+
+func TestAlert(t *testing.T) {
+	var buf strings.Builder
+	writer := logx.NewWriter(&buf)
+	old := logx.Reset()
+	logx.SetWriter(writer)
+	defer logx.SetWriter(old)
+
+	Alert(context.Background(), "foo")
+	assert.True(t, strings.Contains(buf.String(), "foo"), buf.String())
+}
+
+func TestError(t *testing.T) {
+	var buf strings.Builder
+	writer := logx.NewWriter(&buf)
+	old := logx.Reset()
+	logx.SetWriter(writer)
+	defer logx.SetWriter(old)
+
+	file, line := getFileLine()
+	Error(context.Background(), "foo")
+	assert.True(t, strings.Contains(buf.String(), fmt.Sprintf("%s:%d", file, line+1)))
+}
+
+func TestErrorf(t *testing.T) {
+	var buf strings.Builder
+	writer := logx.NewWriter(&buf)
+	old := logx.Reset()
+	logx.SetWriter(writer)
+	defer logx.SetWriter(old)
+
+	file, line := getFileLine()
+	Errorf(context.Background(), "foo %s", "bar")
+	assert.True(t, strings.Contains(buf.String(), fmt.Sprintf("%s:%d", file, line+1)))
+}
+
+func TestErrorv(t *testing.T) {
+	var buf strings.Builder
+	writer := logx.NewWriter(&buf)
+	old := logx.Reset()
+	logx.SetWriter(writer)
+	defer logx.SetWriter(old)
+
+	file, line := getFileLine()
+	Errorv(context.Background(), "foo")
+	assert.True(t, strings.Contains(buf.String(), fmt.Sprintf("%s:%d", file, line+1)))
+}
+
+func TestErrorw(t *testing.T) {
+	var buf strings.Builder
+	writer := logx.NewWriter(&buf)
+	old := logx.Reset()
+	logx.SetWriter(writer)
+	defer logx.SetWriter(old)
+
+	file, line := getFileLine()
+	Errorw(context.Background(), "foo", Field("a", "b"))
+	assert.True(t, strings.Contains(buf.String(), fmt.Sprintf("%s:%d", file, line+1)))
+}
+
+func TestInfo(t *testing.T) {
+	var buf strings.Builder
+	writer := logx.NewWriter(&buf)
+	old := logx.Reset()
+	logx.SetWriter(writer)
+	defer logx.SetWriter(old)
+
+	file, line := getFileLine()
+	Info(context.Background(), "foo")
+	assert.True(t, strings.Contains(buf.String(), fmt.Sprintf("%s:%d", file, line+1)))
+}
+
+func TestInfof(t *testing.T) {
+	var buf strings.Builder
+	writer := logx.NewWriter(&buf)
+	old := logx.Reset()
+	logx.SetWriter(writer)
+	defer logx.SetWriter(old)
+
+	file, line := getFileLine()
+	Infof(context.Background(), "foo %s", "bar")
+	assert.True(t, strings.Contains(buf.String(), fmt.Sprintf("%s:%d", file, line+1)))
+}
+
+func TestInfov(t *testing.T) {
+	var buf strings.Builder
+	writer := logx.NewWriter(&buf)
+	old := logx.Reset()
+	logx.SetWriter(writer)
+	defer logx.SetWriter(old)
+
+	file, line := getFileLine()
+	Infov(context.Background(), "foo")
+	assert.True(t, strings.Contains(buf.String(), fmt.Sprintf("%s:%d", file, line+1)))
+}
+
+func TestInfow(t *testing.T) {
+	var buf strings.Builder
+	writer := logx.NewWriter(&buf)
+	old := logx.Reset()
+	logx.SetWriter(writer)
+	defer logx.SetWriter(old)
+
+	file, line := getFileLine()
+	Infow(context.Background(), "foo", Field("a", "b"))
+	assert.True(t, strings.Contains(buf.String(), fmt.Sprintf("%s:%d", file, line+1)))
+}
+
+func TestMust(t *testing.T) {
+	assert.NotPanics(t, func() {
+		Must(nil)
+	})
+	assert.NotPanics(t, func() {
+		MustSetup(LogConf{})
+	})
+}
+
+func TestMisc(t *testing.T) {
+	SetLevel(logx.DebugLevel)
+	assert.NoError(t, SetUp(LogConf{}))
+	assert.NoError(t, Close())
+}
+
+func TestSlow(t *testing.T) {
+	var buf strings.Builder
+	writer := logx.NewWriter(&buf)
+	old := logx.Reset()
+	logx.SetWriter(writer)
+	defer logx.SetWriter(old)
+
+	file, line := getFileLine()
+	Slow(context.Background(), "foo")
+	assert.True(t, strings.Contains(buf.String(), fmt.Sprintf("%s:%d", file, line+1)), buf.String())
+}
+
+func TestSlowf(t *testing.T) {
+	var buf strings.Builder
+	writer := logx.NewWriter(&buf)
+	old := logx.Reset()
+	logx.SetWriter(writer)
+	defer logx.SetWriter(old)
+
+	file, line := getFileLine()
+	Slowf(context.Background(), "foo %s", "bar")
+	assert.True(t, strings.Contains(buf.String(), fmt.Sprintf("%s:%d", file, line+1)), buf.String())
+}
+
+func TestSlowv(t *testing.T) {
+	var buf strings.Builder
+	writer := logx.NewWriter(&buf)
+	old := logx.Reset()
+	logx.SetWriter(writer)
+	defer logx.SetWriter(old)
+
+	file, line := getFileLine()
+	Slowv(context.Background(), "foo")
+	assert.True(t, strings.Contains(buf.String(), fmt.Sprintf("%s:%d", file, line+1)), buf.String())
+}
+
+func TestSloww(t *testing.T) {
+	var buf strings.Builder
+	writer := logx.NewWriter(&buf)
+	old := logx.Reset()
+	logx.SetWriter(writer)
+	defer logx.SetWriter(old)
+
+	file, line := getFileLine()
+	Sloww(context.Background(), "foo", Field("a", "b"))
+	assert.True(t, strings.Contains(buf.String(), fmt.Sprintf("%s:%d", file, line+1)), buf.String())
+}
+
+func getFileLine() (string, int) {
+	_, file, line, _ := runtime.Caller(1)
+	short := file
+
+	for i := len(file) - 1; i > 0; i-- {
+		if file[i] == '/' {
+			short = file[i+1:]
+			break
+		}
+	}
+
+	return short, line
+}