13 Commits

Author SHA1 Message Date
ac33bdc69f add field 2020-12-31 16:21:31 +08:00
63ba3dd7ab update at 2020-01-07 17:38:50 by ehlxr 2020-01-07 17:38:50 +08:00
aad0d71d1e update at 2019-12-02 10:37:02 by ehlxr 2019-12-02 10:37:02 +08:00
4c129271a5 update at 2019-11-11 10:30:05 by ehlxr 2019-11-11 10:30:05 +08:00
5820e0ded2 update at 2019-11-11 10:28:56 by ehlxr 2019-11-11 10:28:56 +08:00
119fee49af update at 2019-11-11 09:32:36 by ehlxr 2019-11-11 09:32:36 +08:00
a2a63aebee release v0.0.4 2019-11-08 18:18:03 +08:00
8dcedb0ce7 release v0.0.4 2019-11-08 17:45:09 +08:00
b3fbc466f1 add rotating log files daily feature; add file log config 2019-11-07 17:04:36 +08:00
911f959018 update at 2019-11-06 13:45:39 by ehlxr 2019-11-06 13:45:39 +08:00
ae2bfef999 release v0.0.2 2019-11-06 10:15:22 +08:00
98605355bb add log test 2019-11-06 10:12:49 +08:00
9712dbfd2c add log test 2019-11-06 10:11:12 +08:00
12 changed files with 170 additions and 100 deletions

4
.gitignore vendored
View File

@@ -1,2 +1,4 @@
.vscode
go.sum
go.sum
/.idea/
logs

View File

@@ -1 +1,6 @@
# logger
[![license](https://badgen.net/badge/license/MIT/blue)](./LICENSE)
[![](https://badgen.net/github/commits/ehlxr/log)](https://github.com/ehlxr/log/commits/)
[![](https://badgen.net/github/last-commit/ehlxr/log)]((https://github.com/ehlxr/log/commits/))
[![](https://badgen.net/github/releases/ehlxr/log)](https://github.com/ehlxr/log/releases)

View File

@@ -6,16 +6,14 @@ import (
"log"
"os"
"syscall"
"github.com/pkg/errors"
)
// CrashLog set crash log
func CrashLog(file string) {
// NewCrashLog set crash log
func NewCrashLog(file string) {
f, err := os.OpenFile(file, os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0666)
if err != nil {
log.Fatalf("open crash log file error. %v", errors.WithStack(err))
log.Fatalf("open crash log file error. %v", err)
} else {
syscall.Dup2(int(f.Fd()), 2)
_ = syscall.Dup2(int(f.Fd()), 2)
}
}

View File

@@ -6,16 +6,14 @@ import (
"log"
"os"
"syscall"
"github.com/pkg/errors"
)
// CrashLog set crash log
func CrashLog(file string) {
// NewCrashLog set crash log
func NewCrashLog(file string) {
f, err := os.OpenFile(file, os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0666)
if err != nil {
log.Fatalf("open crash log file error. %v", errors.WithStack(err))
log.Fatalf("open crash log file error. %v", err)
} else {
syscall.Dup3(int(f.Fd()), 2, 0)
_ = syscall.Dup3(int(f.Fd()), 2, 0)
}
}

View File

@@ -6,8 +6,6 @@ import (
"log"
"os"
"syscall"
"github.com/pkg/errors"
)
var (
@@ -26,15 +24,15 @@ func setStdHandle(stdhandle int32, handle syscall.Handle) error {
return nil
}
// CrashLog set crash log
func CrashLog(file string) {
// NewCrashLog set crash log
func NewCrashLog(file string) {
f, err := os.OpenFile(file, os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0666)
if err != nil {
log.Println(err.Error())
} else {
err = setStdHandle(syscall.STD_ERROR_HANDLE, syscall.Handle(f.Fd()))
if err != nil {
log.Fatalf("open crash log file error. %v", errors.WithStack(err))
log.Fatalf("open crash log file error. %v", err)
}
}
}

View File

@@ -88,7 +88,7 @@ func (enc textEncoder) EncodeEntry(ent zapcore.Entry, fields []zapcore.Field) (*
// if i > 0 {
// line.AppendByte('\t')
// }
fmt.Fprint(line, arr.elems[i])
_, _ = fmt.Fprint(line, arr.elems[i])
}
putSliceEncoder(arr)
@@ -129,7 +129,7 @@ func (enc textEncoder) writeContext(line *buffer.Buffer, extra []zapcore.Field)
// c.addTabIfNecessary(line)
line.AppendByte('{')
line.Write(context.buf.Bytes())
_, _ = line.Write(context.buf.Bytes())
line.AppendByte('}')
}
@@ -185,6 +185,8 @@ func (enc *textEncoder) AddBool(key string, val bool) {
enc.addElementSeparator()
enc.buf.AppendBool(val)
}
//noinspection GoRedundantConversion
func (enc *textEncoder) AddComplex128(key string, val complex128) {
enc.addKey(key)
enc.addElementSeparator()
@@ -260,6 +262,8 @@ func (enc *textEncoder) AddUint64(key string, val uint64) {
enc.addElementSeparator()
enc.buf.AppendUint(val)
}
//noinspection GoRedundantConversion
func (enc *textEncoder) AddComplex64(k string, v complex64) { enc.AddComplex128(k, complex128(v)) }
func (enc *textEncoder) AddFloat32(k string, v float32) { enc.AddFloat64(k, float64(v)) }
func (enc *textEncoder) AddInt(k string, v int) { enc.AddInt64(k, int64(v)) }
@@ -274,7 +278,7 @@ func (enc *textEncoder) AddUintptr(k string, v uintptr) { enc.AddUint64(k, u
func (enc *textEncoder) Clone() zapcore.Encoder {
clone := enc.clone()
clone.buf.Write(enc.buf.Bytes())
_, _ = clone.buf.Write(enc.buf.Bytes())
return clone
}
@@ -355,7 +359,7 @@ func (enc *textEncoder) safeAddByteString(s []byte) {
i++
continue
}
enc.buf.Write(s[i : i+size])
_, _ = enc.buf.Write(s[i : i+size])
i += size
}
}

5
go.mod
View File

@@ -3,8 +3,7 @@ module github.com/ehlxr/log
go 1.13
require (
github.com/ehlxr/logger v0.0.0-20191105075740-0235eee42e0f
github.com/pkg/errors v0.8.1
github.com/ehlxr/lumberjack v0.0.2-0.20200107093220-2a579f1b2e4d
github.com/robfig/cron/v3 v3.0.0
go.uber.org/zap v1.12.0
gopkg.in/natefinch/lumberjack.v2 v2.0.0
)

View File

@@ -35,15 +35,15 @@ const (
White
)
func (lc *logConfig) initColor() {
func (config *logConfig) initColor() {
for level, color := range _levelToColor {
lcs := level.String()
if lc.EnableCapitalLevel {
if config.EnableCapitalLevel {
lcs = level.CapitalString()
}
if lc.EnableLevelTruncation {
if config.EnableLevelTruncation {
lcs = lcs[:4]
}
_levelToColorStrings[level] = color.Add(lcs)

161
log.go
View File

@@ -2,20 +2,19 @@ package log
import (
"fmt"
"github.com/ehlxr/lumberjack"
"log"
"os"
"path"
"strings"
"time"
"github.com/ehlxr/log/encoder"
"github.com/ehlxr/log/bufferpool"
"github.com/ehlxr/log/crash"
"github.com/pkg/errors"
"github.com/ehlxr/log/encoder"
"github.com/robfig/cron/v3"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"gopkg.in/natefinch/lumberjack.v2"
)
var logger *zap.SugaredLogger
@@ -32,10 +31,9 @@ const (
type logConfig struct {
Level zapcore.Level
FilePath string
EnableColors bool
CrashLogPath string
ErrorLogPath string
CrashLogFilename string
ErrorLogFilename string
EnableLineNumber bool
// enable the truncation of the level text to 4 characters.
@@ -45,93 +43,96 @@ type logConfig struct {
EnableCapitalLevel bool
atomicLevel zap.AtomicLevel
Name string
Fields []zap.Field
*lumberjack.Logger
}
func init() {
lc := &logConfig{
Level: InfoLevel,
FilePath: "",
EnableColors: false,
CrashLogPath: "",
ErrorLogPath: "",
EnableLineNumber: false,
EnableLevelTruncation: false,
EnableErrorStacktrace: false,
TimestampFormat: "",
EnableCapitalLevel: false,
Name: "",
config := &logConfig{
Logger: &lumberjack.Logger{
LocalTime: true,
},
}
logger = lc.newLogger().Sugar()
logger = config.newLogger().Sugar()
}
func (lc *logConfig) Init() {
logger = lc.newLogger().Sugar()
func (config *logConfig) Init() {
logger = config.newLogger().Sugar()
}
func NewLogConfig() *logConfig {
return &logConfig{
Level: DebugLevel,
FilePath: "./log/",
EnableColors: true,
CrashLogPath: "./log/crash.log",
ErrorLogPath: "./log/error_",
CrashLogFilename: "./logs/crash.log",
ErrorLogFilename: "./logs/error.log",
EnableLineNumber: true,
EnableLevelTruncation: true,
EnableErrorStacktrace: true,
TimestampFormat: "2006-01-02 15:04:05.000",
EnableCapitalLevel: true,
Logger: &lumberjack.Logger{
Filename: "./logs/log.log",
MaxSize: 200,
MaxAge: 0,
MaxBackups: 30,
LocalTime: true,
Compress: false,
BackupTimeFormat: "2006-01-02",
},
}
}
func (lc *logConfig) newLogger() *zap.Logger {
if lc.CrashLogPath != "" {
writeCrashLog(lc.CrashLogPath)
func (config *logConfig) newLogger() *zap.Logger {
if config.CrashLogFilename != "" {
writeCrashLog(config.CrashLogFilename)
}
lc.atomicLevel = zap.NewAtomicLevelAt(lc.Level)
lc.initColor()
config.atomicLevel = zap.NewAtomicLevelAt(config.Level)
config.initColor()
cores := []zapcore.Core{
zapcore.NewCore(
encoder.NewTextEncoder(lc.encoderConfig()),
encoder.NewTextEncoder(config.encoderConfig()),
zapcore.Lock(os.Stdout),
lc.atomicLevel,
config.atomicLevel,
)}
if lc.FilePath != "" {
cores = append(cores, lc.fileCore())
if config.Filename != "" {
cores = append(cores, config.fileCore())
}
if lc.ErrorLogPath != "" {
cores = append(cores, lc.errorFileCore())
if config.ErrorLogFilename != "" {
cores = append(cores, config.errorFileCore())
}
core := zapcore.NewTee(cores...)
var options []zap.Option
if lc.EnableLineNumber {
if config.EnableLineNumber {
options = append(options, zap.AddCaller(), zap.AddCallerSkip(1))
}
if lc.EnableErrorStacktrace {
if config.EnableErrorStacktrace {
options = append(options, zap.AddStacktrace(zapcore.ErrorLevel))
}
zapLog := zap.New(core, options...)
if lc.Name != "" {
zapLog = zapLog.Named(fmt.Sprintf("[%s]", lc.Name))
if config.Name != "" {
zapLog = zapLog.Named(fmt.Sprintf("[%s]", config.Name))
}
return zapLog
return zapLog.With(config.Fields...)
}
func (lc *logConfig) encoderConfig() zapcore.EncoderConfig {
el := lc.encodeLevel
if lc.EnableColors {
el = lc.encodeColorLevel
func (config *logConfig) encoderConfig() zapcore.EncoderConfig {
el := config.encodeLevel
if config.EnableColors {
el = config.encodeColorLevel
}
return zapcore.EncoderConfig{
@@ -145,8 +146,8 @@ func (lc *logConfig) encoderConfig() zapcore.EncoderConfig {
EncodeLevel: el,
EncodeTime: func(t time.Time, enc zapcore.PrimitiveArrayEncoder) {
tf := time.RFC3339
if lc.TimestampFormat != "" {
tf = lc.TimestampFormat
if config.TimestampFormat != "" {
tf = config.TimestampFormat
}
enc.AppendString(t.Format(fmt.Sprintf("[%s]", tf)))
},
@@ -157,40 +158,40 @@ func (lc *logConfig) encoderConfig() zapcore.EncoderConfig {
}
}
func (lc *logConfig) fileCore() zapcore.Core {
func (config *logConfig) fileCore() zapcore.Core {
return zapcore.NewCore(
encoder.NewTextEncoder(lc.encoderConfig()),
encoder.NewTextEncoder(config.encoderConfig()),
// zapcore.NewMultiWriteSyncer(
// zapcore.Lock(os.Stdout),
// lc.fileWriteSyncer(),
// config.fileWriteSyncer(),
// ),
fileWriteSyncer(lc.FilePath),
lc.atomicLevel,
config.fileWriteSyncer(config.Filename),
config.atomicLevel,
)
}
func (lc *logConfig) errorFileCore() zapcore.Core {
func (config *logConfig) errorFileCore() zapcore.Core {
return zapcore.NewCore(
encoder.NewTextEncoder(lc.encoderConfig()),
encoder.NewTextEncoder(config.encoderConfig()),
fileWriteSyncer(lc.ErrorLogPath),
config.fileWriteSyncer(config.ErrorLogFilename),
zap.LevelEnablerFunc(func(lvl zapcore.Level) bool {
return lvl >= zapcore.ErrorLevel
}),
)
}
func (lc *logConfig) encodeLevel(l zapcore.Level, enc zapcore.PrimitiveArrayEncoder) {
func (config *logConfig) encodeLevel(l zapcore.Level, enc zapcore.PrimitiveArrayEncoder) {
levelString := l.CapitalString()
if lc.EnableLevelTruncation {
if config.EnableLevelTruncation {
levelString = levelString[:4]
}
enc.AppendString(fmt.Sprintf("[%s]", levelString))
}
func (lc *logConfig) encodeColorLevel(l zapcore.Level, enc zapcore.PrimitiveArrayEncoder) {
func (config *logConfig) encodeColorLevel(l zapcore.Level, enc zapcore.PrimitiveArrayEncoder) {
s, ok := _levelToColorStrings[l]
if !ok {
s = _unknownLevelColor.Add(l.CapitalString())
@@ -219,28 +220,46 @@ func trimCallerFilePath(ec zapcore.EntryCaller) string {
return fmt.Sprintf(" %s", caller)
}
func fileWriteSyncer(name string) zapcore.WriteSyncer {
fileName := fmt.Sprintf("%s%s.log",
name,
time.Now().Format("2006-01-02"))
func (config *logConfig) fileWriteSyncer(fileName string) zapcore.WriteSyncer {
// go get github.com/lestrrat-go/file-rotatelogs
// writer, err := rotatelogs.New(
// name+".%Y%m%d",
// rotatelogs.WithLinkName(name), // 生成软链,指向最新日志文件
// rotatelogs.WithMaxAge(7*24*time.Hour), // 文件最大保存时间
// rotatelogs.WithRotationTime(24*time.Hour), // 日志切割时间间隔
// )
// if err != nil {
// log.Fatalf("config normal logger file error. %v", errors.WithStack(err))
// }
return zapcore.AddSync(&lumberjack.Logger{
Filename: fileName,
MaxSize: 500, // 单个日志文件大小MB
MaxBackups: 10,
MaxAge: 30, // 保留多少天的日志
LocalTime: true,
Compress: true,
writer := &lumberjack.Logger{
Filename: fileName,
MaxSize: config.MaxSize, // 单个日志文件大小MB
MaxBackups: config.MaxBackups,
MaxAge: config.MaxAge, // 保留多少天的日志
LocalTime: config.LocalTime,
Compress: config.Compress,
BackupTimeFormat: config.BackupTimeFormat,
}
// Rotating log files daily
runner := cron.New(cron.WithSeconds(), cron.WithLocation(time.Local))
_, _ = runner.AddFunc("0 0 0 * * ?", func() {
_ = writer.Rotate(time.Now().AddDate(0, 0, -1))
})
go runner.Run()
return zapcore.AddSync(writer)
}
func writeCrashLog(file string) {
err := os.MkdirAll(path.Dir(file), os.ModePerm)
if err != nil {
log.Fatalf("make crash log dir error. %v", errors.WithStack(err))
log.Fatalf("make crash log dir error. %v",
err)
}
crash.CrashLog(file)
crash.NewCrashLog(file)
}
func Fields(args ...interface{}) {

43
log_test.go Normal file
View File

@@ -0,0 +1,43 @@
package log
import (
"go.uber.org/zap"
"testing"
"time"
)
func TestLog(t *testing.T) {
Debugf("this is %s message", "debug")
Infof("this is %s message", "info")
Errorf("this is %s message", "error")
// Panicf("this is %s message", "panic")
}
func TestLogWithConfig(t *testing.T) {
config := NewLogConfig()
_ = config.Level.Set("d")
config.Name = "main"
//config.Fields = []zap.Field{zap.String("traceid", "12123123123")}
config.Init()
With("foo", "baz")
Debugf("this is %s message", "debug")
config.Init()
With(zap.String("traceid", "12123123123"))
Infof("this is %s message", "info")
//Errorf("this is %s message", "error")
// Panicf("this is %s message", "panic")
}
func TestLogRote(t *testing.T) {
lc := NewLogConfig()
lc.MaxSize = 1
lc.Init()
for {
Infof("this is %s message", "info")
time.Sleep(time.Millisecond * 1)
}
}

View File

@@ -1,5 +1,9 @@
package log
func With(args ...interface{}) {
logger = logger.With(args...)
}
func Debug(args ...interface{}) {
logger.Debug(args...)
}

View File

@@ -1 +1 @@
v0.0.1
v0.0.6