add bracket format (#15 )

Reviewed-on: #15 Co-authored-by: andrey <andrey@4devs.io> Co-committed-by: andrey <andrey@4devs.io>
update source (#14 )
2024-01-03 21:35:21 +03:00 · 2024-01-03 18:44:40 +03:00 · 2024-01-02 20:23:08 +03:00 · 2024-01-02 20:22:35 +03:00 · 2024-01-02 17:33:24 +03:00 · 2024-01-02 17:18:18 +03:00
28 changed files with 686 additions and 62 deletions
--- a/.drone.yml
+++ b/.drone.yml
@@ -20,28 +20,3 @@ steps:
 volumes:
 - name: deps
  temp: {}
-
---
-kind: pipeline
-type: docker
-name: otel
-
-steps:
- name: test
-  image: golang:1.21.5
-  volumes:
-  - name: deps
-    path: /go/src/mod
-  commands:
-  - cd handler/otel
-  - go test 
-
- name: golangci-lint
-  image: golangci/golangci-lint:v1.55
-  commands:
-  - cd handler/otel
-  - golangci-lint run
-
-volumes:
- name: deps
-  temp: {}
--- a/.golangci.yml
+++ b/.golangci.yml
@@ -70,3 +70,7 @@ issues:
      linters:
        - lll
        - goerr113
+    - path: example/*
+      linters:
+        - gomnd
+        - lll
--- a/entry/entry.go
+++ b/entry/entry.go
@@ -161,3 +161,24 @@ func (e *Entry) AddAny(key string, value interface{}) *Entry {
 func (e *Entry) AddString(key, value string) *Entry {
 	return e.Add(field.String(key, value))
 }
+
+func (e *Entry) Replace(key string, value field.Value) *Entry {
+	has := false
+
+	e.fields.Fields(func(f field.Field) bool {
+		if f.Key == key {
+			f.Value = value
+			has = true
+
+			return false
+		}
+
+		return true
+	})
+
+	if !has {
+		e.AddAny(key, value)
+	}
+
+	return e
+}
--- a/example/log.go
+++ b/example/log.go
@@ -0,0 +1,38 @@
+package main
+
+import (
+	"context"
+	"time"
+
+	"gitoa.ru/go-4devs/log"
+	"gitoa.ru/go-4devs/log/field"
+)
+
+func main() {
+	ctx := context.Background()
+
+	log.DebugKV(ctx, "debug message")
+	log.ErrKV(ctx, "error message")
+	log.Errf(ctx, "format error message:%v", 42)
+	log.Err(ctx, "error message", 42)
+	service(ctx, log.Log())
+
+	logger := log.New(log.WithJSONFormat()).With(log.WithSource(10, log.TrimPath), log.WithTime(log.KeyTime, time.RFC3339))
+	logger.AlertKV(ctx, "alert message new logger", field.String("string", "value"))
+	service(ctx, logger)
+
+	strLogger := log.New(log.WithFormat(log.FormatWithBracket())).With(log.WithSource(10, log.TrimPath), log.WithTime(log.KeyTime, time.RFC3339))
+	strLogger.AlertKV(ctx, "alert message new txt logger", field.String("string", "value"))
+	service(ctx, strLogger)
+}
+
+func service(ctx context.Context, logger log.Logger) {
+	logger = logger.With(log.WithName("service"))
+	logger.WarnKV(ctx, "warn service message")
+	otherService(ctx, logger)
+}
+
+func otherService(ctx context.Context, logger log.Logger) {
+	logger = logger.With(log.WithName("other_service"))
+	logger.WarnKV(ctx, "warn other service message")
+}
--- a/field/encoder_text.go
+++ b/field/encoder_text.go
@@ -1,6 +1,7 @@
 package field

 import (
+	"encoding"
 	"fmt"
 )

@@ -8,8 +9,18 @@ func NewEncoderText(opts ...func(*BaseEncoder)) BaseEncoder {
 	opts = append([]func(*BaseEncoder){
 		WithGropuConfig(0, 0, ' '),
 		WithNullValue("<nil>"),
-		WithDefaultValue(func(dst []byte, _ Encoder, val Value) []byte {
-			return fmt.Appendf(dst, "%+v", val.Any())
+		WithDefaultValue(func(dst []byte, enc Encoder, val Value) []byte {
+			switch value := val.Any().(type) {
+			case encoding.TextMarshaler:
+				data, err := value.MarshalText()
+				if err != nil {
+					return enc.AppendValue(dst, ErrorValue(err))
+				}
+
+				return enc.AppendValue(dst, StringValue(string(data)))
+			default:
+				return fmt.Appendf(dst, "%+v", val.Any())
+			}
 		}),
 	}, opts...)

--- a/field/field.go
+++ b/field/field.go
@@ -501,3 +501,14 @@ type Field struct {
 func (f Field) String() string {
 	return fmt.Sprintf("%s=%+v", f.Key, f.Value)
 }
+
+// String implent stringer.
+func (f Field) IsKey(keys ...string) bool {
+	for _, key := range keys {
+		if key == f.Key {
+			return true
+		}
+	}
+
+	return false
+}
--- a/global.go
+++ b/global.go
@@ -3,14 +3,15 @@ package log
 import (
 	"context"
 	"io"
+	"time"

 	"gitoa.ru/go-4devs/log/field"
 	"gitoa.ru/go-4devs/log/level"
 )

-//nolint:gochecknoglobals
+//nolint:gochecknoglobals,gomnd
 var global = With(New(),
-	WithCaller(KeySource, 1, false),
+	WithTime(KeyTime, time.RFC3339),
 	WithLevel(KeyLevel, level.Debug),
 	WithExit(level.Alert),
 	WithPanic(level.Emergency),
--- a/global_example_test.go
+++ b/global_example_test.go
@@ -0,0 +1,25 @@
+package log_test
+
+import (
+	"context"
+	"path/filepath"
+
+	"gitoa.ru/go-4devs/log"
+	"gitoa.ru/go-4devs/log/level"
+)
+
+func ExampleDebug() {
+	logger := log.New(log.WithStdout()).With(
+		log.WithSource(2, filepath.Base),
+		log.WithLevel(log.KeyLevel, level.Debug),
+		log.WithExit(level.Alert),
+		log.WithPanic(level.Emergency),
+	)
+
+	log.SetLogger(logger)
+
+	ctx := context.Background()
+	log.Debug(ctx, "debug message")
+	// Output:
+	// msg="debug message" source=global_example_test.go:22 level=debug
+}
--- a/handler/logrus/go.mod
+++ b/handler/logrus/go.mod
@@ -0,0 +1,10 @@
+module gitoa.ru/go-4devs/log/handler/logrus
+
+go 1.20
+
+require (
+	github.com/sirupsen/logrus v1.9.3
+	gitoa.ru/go-4devs/log v0.5.1
+)
+
+require golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // indirect
--- a/handler/logrus/go.sum
+++ b/handler/logrus/go.sum
@@ -0,0 +1,17 @@
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
+github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+gitoa.ru/go-4devs/log v0.5.1 h1:rrIyjpUaw8AjDCf7ZuH0HgCRf370O3TV29yrU1xizWM=
+gitoa.ru/go-4devs/log v0.5.1/go.mod h1:tREtjEH2cTHl0p3uCVcH9g5tlqtsVNI/tDQVfq53Ty4=
+golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=
+golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
--- a/handler/logrus/logger.go
+++ b/handler/logrus/logger.go
@@ -0,0 +1,49 @@
+package logrus
+
+import (
+	"context"
+
+	"github.com/sirupsen/logrus"
+	"gitoa.ru/go-4devs/log"
+	"gitoa.ru/go-4devs/log/entry"
+	"gitoa.ru/go-4devs/log/field"
+	"gitoa.ru/go-4devs/log/level"
+)
+
+// Standard create new standart logrus handler.
+// Deprecated: delete after 0.7.0
+func Standard() log.Logger {
+	return New(logrus.StandardLogger())
+}
+
+// New create new logrus handler.
+// Deprecated: delete after 0.7.0
+func New(log *logrus.Logger) log.Logger {
+	return func(ctx context.Context, data *entry.Entry) (int, error) {
+		lrgFields := make(logrus.Fields, data.Fields().Len())
+		data.Fields().Fields(func(f field.Field) bool {
+			lrgFields[f.Key] = f.Value.Any()
+
+			return true
+		})
+
+		entry := log.WithContext(ctx).WithFields(lrgFields)
+
+		switch data.Level() {
+		case level.Emergency:
+			entry.Panic(data.Message())
+		case level.Alert:
+			entry.Fatal(data.Message())
+		case level.Critical, level.Error:
+			entry.Error(data.Message())
+		case level.Warning:
+			entry.Warn(data.Message())
+		case level.Notice, level.Info:
+			entry.Info(data.Message())
+		case level.Debug:
+			entry.Debug(data.Message())
+		}
+
+		return 0, nil
+	}
+}
--- a/handler/logrus/logger_example_test.go
+++ b/handler/logrus/logger_example_test.go
@@ -0,0 +1,30 @@
+package logrus_test
+
+import (
+	"context"
+	"io"
+	"os"
+
+	slogrus "github.com/sirupsen/logrus"
+	"gitoa.ru/go-4devs/log/field"
+	"gitoa.ru/go-4devs/log/handler/logrus"
+)
+
+func ExampleNew_logrusHandler() {
+	ctx := context.Background()
+	lgrs := slogrus.New()
+	lgrs.SetOutput(os.Stdout)
+	lgrs.SetFormatter(&slogrus.TextFormatter{
+		DisableTimestamp: true,
+	})
+
+	log := logrus.New(lgrs)
+	log.Err(ctx, "log logrus")
+	log.ErrKV(ctx, "log logrus kv", field.Int("int", 42))
+	log.ErrKVs(ctx, "log logrus kv sugar", "err", io.EOF)
+
+	// Output:
+	// level=error msg="log logrus"
+	// level=error msg="log logrus kv" int=42
+	// level=error msg="log logrus kv sugar" err=EOF
+}
--- a/handler/logrus/logger_test.go
+++ b/handler/logrus/logger_test.go
@@ -0,0 +1,38 @@
+package logrus_test
+
+import (
+	"bytes"
+	"context"
+	"strings"
+	"testing"
+
+	lgr "github.com/sirupsen/logrus"
+	"gitoa.ru/go-4devs/log/entry"
+	"gitoa.ru/go-4devs/log/handler/logrus"
+	"gitoa.ru/go-4devs/log/level"
+)
+
+func TestNew(t *testing.T) {
+	t.Parallel()
+
+	ctx := context.Background()
+	buf := &bytes.Buffer{}
+
+	lgrus := lgr.New()
+	lgrus.SetLevel(lgr.DebugLevel)
+	lgrus.SetOutput(buf)
+	lgrus.SetFormatter(&lgr.TextFormatter{
+		DisableTimestamp: true,
+	})
+
+	handler := logrus.New(lgrus)
+	expect := "level=info msg=\"handle logrus message\"\n"
+
+	if _, err := handler(ctx, entry.New(entry.WithLevel(level.Info), entry.WithMessage("handle logrus message"))); err != nil {
+		t.Error(err)
+	}
+
+	if !strings.HasSuffix(buf.String(), expect) {
+		t.Errorf("invalid suffix\n got: %s\nexpect:%s\n", buf.String(), expect)
+	}
+}
--- a/handler/otel/logger.go
+++ b/handler/otel/logger.go
@@ -7,6 +7,7 @@ import (
 	"gitoa.ru/go-4devs/log/entry"
 )

+// Deprecated: delete after 0.7.0
 func New() log.Logger {
 	return func(ctx context.Context, e *entry.Entry) (int, error) {
 		addEvent(ctx, e)
--- a/handler/otel/middleware.go
+++ b/handler/otel/middleware.go
@@ -7,6 +7,7 @@ import (
 	"gitoa.ru/go-4devs/log/entry"
 )

+// Deprecated: delete after 0.7.0
 func Middleware() log.Middleware {
 	return func(ctx context.Context, e *entry.Entry, handler log.Logger) (int, error) {
 		addEvent(ctx, e)
--- a/handler/zap/go.mod
+++ b/handler/zap/go.mod
@@ -0,0 +1,10 @@
+module gitoa.ru/go-4devs/log/handler/zap
+
+go 1.21.5
+
+require (
+	gitoa.ru/go-4devs/log v0.5.1
+	go.uber.org/zap v1.26.0
+)
+
+require go.uber.org/multierr v1.10.0 // indirect
--- a/handler/zap/go.sum
+++ b/handler/zap/go.sum
@@ -0,0 +1,16 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
+github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
+gitoa.ru/go-4devs/log v0.5.1 h1:rrIyjpUaw8AjDCf7ZuH0HgCRf370O3TV29yrU1xizWM=
+gitoa.ru/go-4devs/log v0.5.1/go.mod h1:tREtjEH2cTHl0p3uCVcH9g5tlqtsVNI/tDQVfq53Ty4=
+go.uber.org/goleak v1.2.0 h1:xqgm/S+aQvhWFTtR0XK3Jvg7z8kGV8P4X14IzwN3Eqk=
+go.uber.org/goleak v1.2.0/go.mod h1:XJYK+MuIchqpmGmUSAzotztawfKvYLUIgg7guXrwVUo=
+go.uber.org/multierr v1.10.0 h1:S0h4aNzvfcFsC3dRF1jLoaov7oRaKqRGC/pUEJ2yvPQ=
+go.uber.org/multierr v1.10.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
+go.uber.org/zap v1.26.0 h1:sI7k6L95XOKS281NhVKOFCUNIvv9e0w4BF8N3u+tCRo=
+go.uber.org/zap v1.26.0/go.mod h1:dtElttAiwGvoJ/vj4IwHBS/gXsEu/pZ50mUIRWuG0so=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
--- a/handler/zap/logger.go
+++ b/handler/zap/logger.go
@@ -0,0 +1,70 @@
+package zap
+
+import (
+	"context"
+
+	"gitoa.ru/go-4devs/log"
+	"gitoa.ru/go-4devs/log/entry"
+	"gitoa.ru/go-4devs/log/field"
+	"gitoa.ru/go-4devs/log/level"
+	"go.uber.org/zap"
+)
+
+// Deprecated: delete after 0.7.0
+func Nop() log.Logger {
+	return New(zap.NewNop())
+}
+
+// Deprecated: delete after 0.7.0
+func Example(options ...zap.Option) log.Logger {
+	return New(zap.NewExample(options...))
+}
+
+// Deprecated: delete after 0.7.0
+func Production(options ...zap.Option) log.Logger {
+	z, err := zap.NewProduction(options...)
+	if err != nil {
+		panic(err)
+	}
+
+	return New(z)
+}
+
+// Deprecated: delete after 0.7.0
+func Development(options ...zap.Option) log.Logger {
+	z, err := zap.NewDevelopment(options...)
+	if err != nil {
+		panic(err)
+	}
+
+	return New(z)
+}
+
+// New create handler by zap logger.
+func New(logger *zap.Logger) log.Logger {
+	return func(ctx context.Context, data *entry.Entry) (int, error) {
+		zf := make([]zap.Field, 0, data.Fields().Len())
+		data.Fields().Fields(func(f field.Field) bool {
+			zf = append(zf, zap.Any(f.Key, f.Value.Any()))
+
+			return true
+		})
+
+		switch data.Level() {
+		case level.Emergency:
+			logger.Fatal(data.Message(), zf...)
+		case level.Alert:
+			logger.Panic(data.Message(), zf...)
+		case level.Critical, level.Error:
+			logger.Error(data.Message(), zf...)
+		case level.Warning:
+			logger.Warn(data.Message(), zf...)
+		case level.Notice, level.Info:
+			logger.Info(data.Message(), zf...)
+		case level.Debug:
+			logger.Debug(data.Message(), zf...)
+		}
+
+		return 0, nil
+	}
+}
--- a/handler/zap/logger_example_test.go
+++ b/handler/zap/logger_example_test.go
@@ -0,0 +1,23 @@
+package zap_test
+
+import (
+	"context"
+	"io"
+
+	"gitoa.ru/go-4devs/log/field"
+	"gitoa.ru/go-4devs/log/handler/zap"
+	uzap "go.uber.org/zap"
+)
+
+func ExampleNew_zapHandler() {
+	ctx := context.Background()
+	log := zap.New(uzap.NewExample())
+	log.Err(ctx, "log zap")
+	log.ErrKV(ctx, "log zap kv", field.Int("int", 42))
+	log.ErrKVs(ctx, "log zap kv sugar", "err", io.EOF)
+
+	// Output:
+	// {"level":"error","msg":"log zap"}
+	// {"level":"error","msg":"log zap kv","int":42}
+	// {"level":"error","msg":"log zap kv sugar","err":"EOF"}
+}
--- a/handler/zap/logger_test.go
+++ b/handler/zap/logger_test.go
@@ -0,0 +1,43 @@
+package zap_test
+
+import (
+	"bytes"
+	"context"
+	"testing"
+
+	"gitoa.ru/go-4devs/log/entry"
+	"gitoa.ru/go-4devs/log/field"
+	zlog "gitoa.ru/go-4devs/log/handler/zap"
+	"gitoa.ru/go-4devs/log/level"
+	"go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
+)
+
+func TestNew(t *testing.T) {
+	t.Parallel()
+
+	ctx := context.Background()
+	buf := &bytes.Buffer{}
+	core := zapcore.NewCore(zapcore.NewJSONEncoder(zapcore.EncoderConfig{
+		MessageKey:     "msg",
+		LevelKey:       "level",
+		NameKey:        "logger",
+		EncodeLevel:    zapcore.LowercaseLevelEncoder,
+		EncodeTime:     zapcore.ISO8601TimeEncoder,
+		EncodeDuration: zapcore.StringDurationEncoder,
+	}), zapcore.AddSync(buf), zapcore.DebugLevel)
+	logger := zlog.New(zap.New(core))
+	expect := `{"level":"info","msg":"handle zap message","env":"test"}` + "\n"
+
+	if _, err := logger(ctx, entry.New(
+		entry.WithFields(field.String("env", "test")),
+		entry.WithLevel(level.Notice),
+		entry.WithMessage("handle zap message"),
+	)); err != nil {
+		t.Error(err)
+	}
+
+	if buf.String() != expect {
+		t.Errorf("invalid message\n got: %s\nexpect:%s\n", buf.String(), expect)
+	}
+}
--- a/logger_example_caller_test.go
+++ b/logger_example_caller_test.go
@@ -1,22 +1,23 @@
 package log_test

 import (
+	"path/filepath"
+
 	"gitoa.ru/go-4devs/log"
 	"gitoa.ru/go-4devs/log/level"
 )

 func ExampleNew_withCaller() {
-	logger := log.With(
-		log.New(log.WithStdout()),
-		log.WithLevel("level", level.Debug),
-		log.WithCaller("caller", 2, false),
+	logger := log.New(log.WithStdout()).With(
+		log.WithLevel(log.KeyLevel, level.Debug),
+		log.WithSource(3, filepath.Base),
 	)
 	logger.Err(ctx, "same error message")
 	logger.InfoKVs(ctx, "same info message", "api-version", 0.1)
 	_, _ = logger.Write([]byte("same write message"))

 	// Output:
-	// msg="same error message" level=error caller=logger_example_caller_test.go:14
-	// msg="same info message" api-version=0.1 level=info caller=logger_example_caller_test.go:15
-	// msg="same write message" level=info caller=logger_example_caller_test.go:16
+	// msg="same error message" level=error source=logger_example_caller_test.go:15
+	// msg="same info message" api-version=0.1 level=info source=logger_example_caller_test.go:16
+	// msg="same write message" level=info source=logger_example_caller_test.go:17
 }
--- a/logger_example_test.go
+++ b/logger_example_test.go
@@ -47,19 +47,19 @@ func ExampleNew_errf() {
 }

 func ExampleNew_debugKV() {
-	logger := log.New(log.WithStdout()).With(log.WithLevel("level", level.Debug))
+	logger := log.New(log.WithStdout()).With(log.WithLevel(log.KeyLevel, level.Debug))
 	logger.DebugKVs(ctx, "same message", "error", os.ErrNotExist)
 	// Output: msg="same message" error="file does not exist" level=debug
 }

 func ExampleNew_level() {
-	logger := log.New(log.WithStdout()).With(log.WithLevel("level", level.Error))
+	logger := log.New(log.WithStdout()).With(log.WithLevel(log.KeyLevel, level.Error))
 	logger.Err(ctx, "same error message")
 	// Output: msg="same error message" level=error
 }

 func ExampleNew_level_info() {
-	logger := log.New(log.WithStdout()).With(log.WithLevel("level", level.Error))
+	logger := log.New(log.WithStdout()).With(log.WithLevel(log.KeyLevel, level.Error))
 	logger.Info(ctx, "same message")
 	// Output:
 }
@@ -218,11 +218,11 @@ func ExampleNew_jsonFormat() {
 }

 func ExampleNew_textEncoding() {
-	logger := log.With(
-		log.New(log.WithStdout()),
-		log.WithLevel(log.KeyLevel, level.Debug),
-		log.GoVersion("go-version"),
-	)
+	logger := log.New(log.WithStdout()).
+		With(
+			log.WithLevel(log.KeyLevel, level.Debug),
+			log.GoVersion("go-version"),
+		)
 	logger.Err(ctx, "same error message")
 	logger.InfoKVs(ctx, "same info message", "api-version", 0.1, "obj", Obj{Name: "text value", IsEnable: true})

@@ -238,25 +238,29 @@ func (c ctxKey) String() string {
 }

 func levelInfo(ctx context.Context, entry *entry.Entry, handler log.Logger) (int, error) {
-	return handler(ctx, entry.Add(field.String("level", entry.Level().String())))
+	return handler(ctx, entry.Add(field.String(log.KeyLevel, entry.Level().String())))
 }

 func ExampleWith() {
 	var requestID ctxKey = "requestID"
 	vctx := context.WithValue(ctx, requestID, "6a5fa048-7181-11ea-bc55-0242ac130003")

-	logger := log.With(
-		log.New(log.WithStdout()),
-		levelInfo, log.WithContextValue(requestID), log.KeyValue("api", "0.1.0"), log.GoVersion("go"),
+	logger := log.New(log.WithStdout()).With(
+		levelInfo,
+		log.WithContextValue(requestID),
+		log.KeyValue("api", "0.1.0"),
+		log.GoVersion("go"),
 	)
 	logger.Info(vctx, "same message")
 	// Output: msg="same message" level=info requestID=6a5fa048-7181-11ea-bc55-0242ac130003 api=0.1.0 go=go1.21.5
 }

 func ExampleLogger_Print() {
-	logger := log.With(
-		log.New(log.WithStdout()),
-		levelInfo, log.KeyValue("client", "http"), log.KeyValue("api", "0.1.0"), log.GoVersion("go"),
+	logger := log.New(log.WithStdout()).With(
+		levelInfo,
+		log.KeyValue("client", "http"),
+		log.KeyValue("api", "0.1.0"),
+		log.GoVersion("go"),
 	)
 	logger.Print("same message")
 	// Output: msg="same message" level=info client=http api=0.1.0 go=go1.21.5
@@ -277,7 +281,7 @@ func Example_fieldClosureFn() {
 		return d
 	})

-	log := log.With(log.New(log.WithStdout()), log.WithLevel("level", level.Info))
+	log := log.New(log.WithStdout()).With(log.WithLevel(log.KeyLevel, level.Info))

 	log.DebugKVs(ctx, "debug message", "data", closure)
 	log.ErrKVs(ctx, "error message", "err", closure)
@@ -289,7 +293,9 @@ func Example_fieldClosureFn() {
 }

 func Example_withGroup() {
-	log := log.With(log.New(log.WithStdout()), log.WithLevel(log.KeyLevel, level.Info))
+	log := log.New(log.WithStdout()).With(
+		log.WithLevel(log.KeyLevel, level.Info),
+	)

 	log.ErrKVs(ctx, "error message",
 		field.Groups("grous_field",
--- a/logger_test.go
+++ b/logger_test.go
@@ -27,7 +27,7 @@ func TestFields(t *testing.T) {
 	ctx := context.Background()
 	buf := &bytes.Buffer{}
 	log := log.New(log.WithWriter(buf)).
-		With(log.WithLevel("level", level.Info))
+		With(log.WithLevel(log.KeyLevel, level.Info))
 	success := "msg=message err=\"file already exists\" version=0.1.0 obj={id:uid} closure=\"some closure data\" level=info\n"

 	log.InfoKVs(ctx, "message",
@@ -65,7 +65,7 @@ func TestWriter(t *testing.T) {

 	success := "msg=\"info message\" err=\"file already exists\" requestID=6a5fa048-7181-11ea-bc55-0242ac1311113 level=info\n"
 	buf := &bytes.Buffer{}
-	logger := log.New(log.WithWriter(buf)).With(log.WithContextValue(requestID), log.WithLevel("level", level.Info))
+	logger := log.New(log.WithWriter(buf)).With(log.WithContextValue(requestID), log.WithLevel(log.KeyLevel, level.Info))

 	_, _ = logger.Writer(
 		context.WithValue(ctx, requestID, "6a5fa048-7181-11ea-bc55-0242ac1311113"),
@@ -91,7 +91,7 @@ func TestLogger(t *testing.T) {

 	ctx := context.Background()
 	buf := &bytes.Buffer{}
-	logger := log.New(log.WithWriter(buf)).With(log.WithContextValue(requestID), log.WithLevel("level", level.Info))
+	logger := log.New(log.WithWriter(buf)).With(log.WithContextValue(requestID), log.WithLevel(log.KeyLevel, level.Info))

 	_, err := logger(ctx, nil)
 	if err != nil {
--- a/middleware.go
+++ b/middleware.go
@@ -85,7 +85,14 @@ func WithContextValue(keys ...fmt.Stringer) Middleware {
 	}
 }

+func WithName(name string) Middleware {
+	return func(ctx context.Context, data *entry.Entry, handler Logger) (int, error) {
+		return handler(ctx, data.Replace(KeyName, field.StringValue(name)))
+	}
+}
+
 // WithCaller adds called file.
+// Deprecated: use WithSource.
 func WithCaller(key string, depth int, full bool) Middleware {
 	const offset = 2

--- a/source.go
+++ b/source.go
@@ -0,0 +1,94 @@
+package log
+
+import (
+	"context"
+	"fmt"
+	"path/filepath"
+	"runtime"
+	"strings"
+
+	"gitoa.ru/go-4devs/log/entry"
+	"gitoa.ru/go-4devs/log/field"
+)
+
+func WithSource(items int, trimPath func(string) string) Middleware {
+	const (
+		skip       = 4
+		funcPrefix = "gitoa.ru/go-4devs/log.Logger"
+		skipHelper = "gitoa.ru/go-4devs/log."
+	)
+
+	items += skip
+
+	return func(ctx context.Context, data *entry.Entry, handler Logger) (int, error) {
+		pc := make([]uintptr, items)
+		n := runtime.Callers(skip, pc)
+
+		if n == 0 {
+			return handler(ctx, data.Add(errSourceField(skip, items)))
+		}
+
+		pc = pc[:n] // pass only valid pcs to runtime.CallersFrames
+		frames := runtime.CallersFrames(pc)
+		prew := false
+
+		for {
+			frame, more := frames.Next()
+
+			has := strings.HasPrefix(frame.Function, funcPrefix)
+			if !has && prew {
+				if strings.HasPrefix(frame.Function, skipHelper) {
+					continue
+				}
+
+				return handler(ctx, data.AddAny(KeySource, Source{
+					Func: filepath.Base(frame.Function),
+					Line: frame.Line,
+					File: trimPath(frame.File),
+				}))
+			}
+
+			prew = has
+
+			if !more {
+				break
+			}
+		}
+
+		return handler(ctx, data.Add(errSourceField(skip, items)))
+	}
+}
+
+func TrimPath(file string) string {
+	idx := strings.LastIndexByte(file, '/')
+	if idx == -1 {
+		return filepath.Base(file)
+	}
+
+	// Find the penultimate separator.
+	idx = strings.LastIndexByte(file[:idx], '/')
+	if idx == -1 {
+		return filepath.Base(file)
+	}
+
+	return file[idx+1:]
+}
+
+// Source describes the location of a line of source code.
+type Source struct {
+	Func string `json:"func"`
+	File string `json:"file"`
+	Line int    `json:"line"`
+}
+
+func (l Source) MarshalText() ([]byte, error) {
+	return []byte(fmt.Sprintf("%s:%d", l.File, l.Line)), nil
+}
+
+func (l Source) MarshalJSON() ([]byte, error) {
+	return fmt.Appendf([]byte{}, `{"file":"%s","line":%d,"func":"%s"}`, l.File, l.Line, l.Func), nil
+}
+
+func errSourceField(skip, max int) field.Field {
+	return field.String(KeySource, fmt.Sprintf("source not found by frames[%d:%d]", skip, max))
+}
--- a/source_example_test.go
+++ b/source_example_test.go
@@ -0,0 +1,26 @@
+package log_test
+
+import (
+	"context"
+	"path/filepath"
+
+	"gitoa.ru/go-4devs/log"
+)
+
+func ExampleWithSource() {
+	ctx := context.Background()
+	logger := log.New(log.WithStdout()).With(log.WithSource(1, filepath.Base))
+
+	logger.Debug(ctx, "debug message")
+	// Output:
+	// msg="debug message" source=source_example_test.go:14
+}
+
+func ExampleWithSource_json() {
+	ctx := context.Background()
+	logger := log.New(log.WithStdout(), log.WithJSONFormat()).With(log.WithSource(2, filepath.Base))
+
+	logger.Debug(ctx, "debug message")
+	// Output:
+	// {"msg":"debug message","source":{"file":"source_example_test.go","line":23,"func":"log_test.ExampleWithSource_json"}}
+}
--- a/writer_example_test.go
+++ b/writer_example_test.go
@@ -0,0 +1,37 @@
+package log_test
+
+import (
+	"context"
+	"math"
+	"path/filepath"
+	"time"
+
+	"gitoa.ru/go-4devs/log"
+	"gitoa.ru/go-4devs/log/entry"
+	"gitoa.ru/go-4devs/log/field"
+	"gitoa.ru/go-4devs/log/level"
+)
+
+func exampleWithTime(key, format string) log.Middleware {
+	return func(ctx context.Context, e *entry.Entry, handler log.Logger) (int, error) {
+		return handler(ctx, e.Add(field.FormatTime(key, format, time.Unix(math.MaxInt32, 0).In(time.UTC))))
+	}
+}
+
+func ExampleFormatWithBracket() {
+	ctx := context.Background()
+	logger := log.New(log.WithFormat(log.FormatWithBracket()), log.WithStdout()).With(
+		log.WithSource(10, filepath.Base),
+		// log.WithTime(log.KeyTime, time.RFC3339),
+		exampleWithTime(log.KeyTime, time.RFC3339),
+		log.WithLevel(log.KeyLevel, level.Info),
+	)
+
+	logger.InfoKV(ctx, "imfo message", field.Int64("num", 42))
+
+	serviceLogger := logger.With(log.WithName("service_name"))
+	serviceLogger.Err(ctx, "error message")
+	// Output:
+	// 2038-01-19T03:14:07Z [info] writer_example_test.go:30 "imfo message" num=42
+	// 2038-01-19T03:14:07Z [error][service_name] writer_example_test.go:33 "error message"
+}
--- a/writter.go
+++ b/writter.go
@@ -25,6 +25,8 @@ const (
 	// SourceKey is the key used by the built-in handlers for the source file
 	// and line of the log call. The associated value is a string.
 	KeySource = "source"
+	// KeyName logger name.
+	KeyName = "name"
 )

 func WithWriter(w io.Writer) func(*option) {
@@ -41,15 +43,18 @@ func WithStdout() func(*option) {

 // WithStringFormat sets format as simple string.
 func WithStringFormat() func(*option) {
-	return func(o *option) {
-		o.format = formatText()
-	}
+	return WithFormat(formatString())
 }

 // WithJSONFormat sets json output format.
 func WithJSONFormat() func(*option) {
+	return WithFormat(formatJSON())
+}
+
+// WithFormat sets custom output format.
+func WithFormat(format func(io.Writer, *entry.Entry) (int, error)) func(*option) {
 	return func(o *option) {
-		o.format = formatJSON()
+		o.format = format
 	}
 }

@@ -61,7 +66,7 @@ type option struct {
 // New creates standart logger.
 func New(opts ...func(*option)) Logger {
 	log := option{
-		format: formatText(),
+		format: formatString(),
 		out:    os.Stderr,
 	}

@@ -74,7 +79,61 @@ func New(opts ...func(*option)) Logger {
 	}
 }

-func formatText() func(io.Writer, *entry.Entry) (int, error) {
+func FormatWithBracket() func(io.Writer, *entry.Entry) (int, error) {
+	enc := field.NewEncoderText()
+
+	appendValue := func(buf *buffer.Buffer, data field.Fields, key, prefix, suffix string) *buffer.Buffer {
+		data.Fields(
+			func(f field.Field) bool {
+				if f.IsKey(key) {
+					_, _ = buf.WriteString(prefix)
+					*buf = enc.AppendValue(*buf, f.Value)
+					_, _ = buf.WriteString(suffix)
+
+					return false
+				}
+
+				return true
+			})
+
+		return buf
+	}
+
+	return func(w io.Writer, data *entry.Entry) (int, error) {
+		buf := buffer.New()
+		defer func() {
+			buf.Free()
+		}()
+
+		fields := data.Fields()
+		buf = appendValue(buf, fields, KeyTime, "", " ")
+		_, _ = buf.WriteString("[")
+		*buf = enc.AppendValue(*buf, field.StringValue(data.Level().String()))
+		_, _ = buf.WriteString("]")
+		buf = appendValue(buf, fields, KeyName, "[", "]")
+		buf = appendValue(buf, fields, KeySource, " ", " ")
+		*buf = enc.AppendValue(*buf, field.StringValue(data.Message()))
+
+		fields.Fields(func(f field.Field) bool {
+			if !f.IsKey(KeyTime, KeySource, KeyName, KeyLevel) {
+				*buf = enc.AppendField(*buf, f)
+			}
+
+			return true
+		})
+
+		_, _ = buf.WriteString("\n")
+
+		n, err := w.Write(*buf)
+		if err != nil {
+			return 0, fmt.Errorf("format text:%w", err)
+		}
+
+		return n, nil
+	}
+}
+
+func formatString() func(io.Writer, *entry.Entry) (int, error) {
 	enc := field.NewEncoderText()

 	return func(w io.Writer, entry *entry.Entry) (int, error) {
Author	SHA1	Message	Date
andrey	57a908f894	add bracket format (#15 ) All checks were successful continuous-integration/drone/tag Build is passing Details continuous-integration/drone/push Build is passing Details Reviewed-on: #15 Co-authored-by: andrey <andrey@4devs.io> Co-committed-by: andrey <andrey@4devs.io>	2024-01-03 21:35:21 +03:00
andrey	acaa46b73f	update source (#14 ) Some checks failed continuous-integration/drone/push Build is failing Details Reviewed-on: #14 Co-authored-by: andrey <andrey@4devs.io> Co-committed-by: andrey <andrey@4devs.io>	2024-01-03 18:44:40 +03:00
andrey	24a5d3dd88	Merge pull request 'add source with func name' (#13 ) from source into master Some checks failed continuous-integration/drone/push Build is failing Details continuous-integration/drone/tag Build is failing Details Reviewed-on: #13	2024-01-02 20:23:08 +03:00
andrey	1de7cc0034	add source with func name Some checks failed continuous-integration/drone/push Build is failing Details continuous-integration/drone/pr Build is failing Details	2024-01-02 20:22:35 +03:00
andrey	9a61d4b9d3	Merge pull request 'add handler zap' (#12 ) from zap into master Some checks failed continuous-integration/drone/push Build is failing Details Reviewed-on: #12	2024-01-02 17:33:24 +03:00
andrey	4aef5329c7	add handler zap Some checks failed continuous-integration/drone/pr Build is failing Details continuous-integration/drone/push Build is failing Details	2024-01-02 17:18:18 +03:00
andrey	eb1708a296	Merge pull request 'add logrus handler' (#11 ) from logrus into master Some checks failed continuous-integration/drone/push Build is failing Details Reviewed-on: #11	2024-01-02 17:14:38 +03:00
andrey	50cfee751d	add logrus handler Some checks failed continuous-integration/drone/push Build is failing Details continuous-integration/drone/pr Build is failing Details	2024-01-02 17:03:49 +03:00