🎨 日志打印优化

config.go

@@ -11,12 +11,13 @@ var (
 
 // LogConfig 日志配置
 type LogConfig struct {
-	Mode       mode // dev, prod
-	LokiEnable bool
-	FileEnable bool
-	LokiHost   string
-	LokiPort   int
-	LokiName   string // Loki的job和source名称
+	Mode       mode   `env:"LOG_MODE"`             // dev, prod
+	LokiEnable bool   `env:"LOG_LOKI_ENABLE"`      // 是否启用Loki
+	FileEnable bool   `env:"LOG_FILE_ENABLE"`      // 是否输出到文件
+	LokiHost   string `env:"LOG_LOKI_HOST"`        // Loki地址
+	LokiPort   int    `env:"LOG_LOKI_PORT"`        // Loki端口
+	LokiSource string `env:"LOG_LOKI_SOURCE_NAME"` // Loki的source名称
+	LokiJob    string `env:"LOG_LOKI_JOB_NAME"`    // Loki的job名称
 }
 
 func (c LogConfig) getLokiPushURL() string {

go.mod

@@ -3,11 +3,14 @@ module gitee.ltd/lxh/logger
 go 1.17
 
 require (
+	github.com/caarlos0/env/v6 v6.8.0
 	github.com/go-kit/kit v0.10.0
 	github.com/lixh00/loki-client-go v1.0.1
 	github.com/natefinch/lumberjack v2.0.0+incompatible
-	github.com/prometheus/common v0.30.0
-	go.uber.org/zap v1.19.1
+	github.com/prometheus/common v0.32.0
+	go.uber.org/zap v1.20.0
+	gorm.io/driver/mysql v1.3.2
+	gorm.io/gorm v1.23.2
 )
 
 require (
@@ -15,9 +18,12 @@ require (
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/cespare/xxhash/v2 v2.1.1 // indirect
 	github.com/go-logfmt/logfmt v0.5.0 // indirect
+	github.com/go-sql-driver/mysql v1.6.0 // indirect
 	github.com/gogo/protobuf v1.3.1 // indirect
 	github.com/golang/protobuf v1.4.3 // indirect
 	github.com/golang/snappy v0.0.2 // indirect
+	github.com/jinzhu/inflection v1.0.0 // indirect
+	github.com/jinzhu/now v1.1.4 // indirect
 	github.com/jpillora/backoff v1.0.0 // indirect
 	github.com/json-iterator/go v1.1.11 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect

go.sum

@@ -114,6 +114,8 @@ github.com/blang/semver v3.5.1+incompatible/go.mod h1:kRBLl5iJ+tD4TcOOxsy/0fnweb
 github.com/bmizerany/pat v0.0.0-20170815010413-6226ea591a40/go.mod h1:8rLXio+WjiTceGBHIoTvn60HIbs7Hm7bcHjyrSqYB9c=
 github.com/boltdb/bolt v1.3.1/go.mod h1:clJnj/oiGkjum5o1McbSZDSLxVThjynRyGBgiAx27Ps=
 github.com/c-bata/go-prompt v0.2.2/go.mod h1:VzqtzE2ksDBcdln8G7mk2RX9QyGjH+OVqOCSiVIqS34=
+github.com/caarlos0/env/v6 v6.8.0 h1:abF9JinEXaibthiOowf4uSnRBWN66aJOxSpHLH67jeI=
+github.com/caarlos0/env/v6 v6.8.0/go.mod h1:FE0jGiAnQqtv2TenJ4KTa8+/T2Ss8kdS5s1VEjasoN0=
 github.com/casbin/casbin/v2 v2.1.2/go.mod h1:YcPU1XXisHhLzuxH9coDNf2FbKpjGlbCg3n9yuLkIJQ=
 github.com/cenkalti/backoff v2.2.1+incompatible/go.mod h1:90ReRw6GdpyfrHakVjL/QHaoyV4aDUVVkXQJJJ3NXXM=
 github.com/cenkalti/backoff/v4 v4.0.2/go.mod h1:eEew/i+1Q6OrCDZh3WiXYv3+nJwBASZ8Bog/87DQnVg=
@@ -255,6 +257,8 @@ github.com/go-openapi/validate v0.19.3/go.mod h1:90Vh6jjkTn+OT1Eefm0ZixWNFjhtOH7
 github.com/go-openapi/validate v0.19.8/go.mod h1:8DJv2CVJQ6kGNpFW6eV9N3JviE1C85nY1c2z52x1Gk4=
 github.com/go-sql-driver/mysql v1.4.0/go.mod h1:zAC/RDZ24gD3HViQzih4MyKcchzm+sOG5ZlKdlhCg5w=
 github.com/go-sql-driver/mysql v1.4.1/go.mod h1:zAC/RDZ24gD3HViQzih4MyKcchzm+sOG5ZlKdlhCg5w=
+github.com/go-sql-driver/mysql v1.6.0 h1:BCTh4TKNUYmOmMUcQ3IipzF5prigylS7XXjEkfCHuOE=
+github.com/go-sql-driver/mysql v1.6.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg=
 github.com/go-stack/stack v1.8.0 h1:5SgMzNM5HxrEjV0ww2lTmX6E2Izsfxas4+YHWRs3Lsk=
 github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY=
 github.com/gobuffalo/attrs v0.0.0-20190224210810-a9411de4debd/go.mod h1:4duuawTqi2wkkpB4ePgWMaai6/Kc6WEz83bhFwpHzj0=
@@ -415,6 +419,10 @@ github.com/influxdata/roaring v0.4.13-0.20180809181101-fc520f41fab6/go.mod h1:bS
 github.com/influxdata/tdigest v0.0.0-20181121200506-bf2b5ad3c0a9/go.mod h1:Js0mqiSBE6Ffsg94weZZ2c+v/ciT8QRHFOap7EKDrR0=
 github.com/influxdata/usage-client v0.0.0-20160829180054-6d3895376368/go.mod h1:Wbbw6tYNvwa5dlB6304Sd+82Z3f7PmVZHVKU637d4po=
 github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
+github.com/jinzhu/inflection v1.0.0 h1:K317FqzuhWc8YvSVlFMCCUb36O/S9MCKRDI7QkRKD/E=
+github.com/jinzhu/inflection v1.0.0/go.mod h1:h+uFLlag+Qp1Va5pdKtLDYj+kHp5pxUVkryuEj+Srlc=
+github.com/jinzhu/now v1.1.4 h1:tHnRBy1i5F2Dh8BAFxqFzxKqqvezXrL2OW1TnX+Mlas=
+github.com/jinzhu/now v1.1.4/go.mod h1:d3SSVoowX0Lcu0IBviAWJpolVfI5UJVZZ7cO71lE/z8=
 github.com/jmespath/go-jmespath v0.0.0-20180206201540-c2b33e8439af/go.mod h1:Nht3zPeWKUH0NzdCt2Blrr5ys8VGpn0CEB0cQHVjt7k=
 github.com/jmespath/go-jmespath v0.4.0/go.mod h1:T8mJZnbsbmF+m6zOOFylbeCJqk5+pHWvzYPziyZiYoo=
 github.com/jmespath/go-jmespath/internal/testify v1.5.1/go.mod h1:L3OGu8Wl2/fWfCI6z80xFu9LTZmf1ZRjMHUOPmWr69U=
@@ -475,6 +483,8 @@ github.com/mailru/easyjson v0.7.0/go.mod h1:KAzv3t3aY1NaHWoQz1+4F1ccyAH66Jk7yos7
 github.com/mailru/easyjson v0.7.1/go.mod h1:KAzv3t3aY1NaHWoQz1+4F1ccyAH66Jk7yos7ldAVICs=
 github.com/markbates/oncer v0.0.0-20181203154359-bf2de49a0be2/go.mod h1:Ld9puTsIW75CHf65OeIOkyKbteujpZVXDpWK6YGZbxE=
 github.com/markbates/safe v1.0.1/go.mod h1:nAqgmRi7cY2nqMc92/bSEeQA+R4OheNU2T1kNSCBdG0=
+github.com/matryer/is v1.4.0 h1:sosSmIWwkYITGrxZ25ULNDeKiMNzFSr4V/eqBQP0PeE=
+github.com/matryer/is v1.4.0/go.mod h1:8I/i5uYgLzgsgEloJE1U6xx5HkBQpAZvepWuujKwMRU=
 github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU=
 github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
 github.com/mattn/go-colorable v0.1.6/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc=
@@ -603,8 +613,9 @@ github.com/prometheus/common v0.9.1/go.mod h1:yhUN8i9wzaXS3w1O07YhxHEBxD+W35wd8b
 github.com/prometheus/common v0.10.0/go.mod h1:Tlit/dnDKsSWFlCLTWaA1cyBgKHSMdTB80sz/V91rCo=
 github.com/prometheus/common v0.14.0/go.mod h1:U+gB1OBLb1lF3O42bTCL+FK18tX9Oar16Clt/msog/s=
 github.com/prometheus/common v0.26.0/go.mod h1:M7rCNAaPfAosfx8veZJCuw84e35h3Cfd9VFqTh1DIvc=
-github.com/prometheus/common v0.30.0 h1:JEkYlQnpzrzQFxi6gnukFPdQ+ac82oRhzMcIduJu/Ug=
 github.com/prometheus/common v0.30.0/go.mod h1:vu+V0TpY+O6vW9J44gczi3Ap/oXXR10b+M/gUGO4Hls=
+github.com/prometheus/common v0.32.0 h1:HRmM4uANZDAjdvbsdfOoqI5UDbjz0faKeMs/cGPKKI0=
+github.com/prometheus/common v0.32.0/go.mod h1:vu+V0TpY+O6vW9J44gczi3Ap/oXXR10b+M/gUGO4Hls=
 github.com/prometheus/procfs v0.0.0-20181005140218-185b4288413d/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk=
 github.com/prometheus/procfs v0.0.0-20190117184657-bf6a532e95b1/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk=
 github.com/prometheus/procfs v0.0.2/go.mod h1:TjEm7ze935MbeOT/UhFTIMYKhuLP4wbCsTZCD3I8kEA=
@@ -707,8 +718,8 @@ go.uber.org/atomic v1.5.0/go.mod h1:sABNBOSYdrvTF6hTgEIbc7YasKWGhgEQZyfxyTvoXHQ=
 go.uber.org/atomic v1.7.0 h1:ADUqmZGgLDDfbSL9ZmPxKTybcoEYHgpYfELNoN+7hsw=
 go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc=
 go.uber.org/goleak v1.1.10/go.mod h1:8a7PlsEVH3e/a/GLqe5IIrQx6GzcnRmZEufDUTk4A7A=
-go.uber.org/goleak v1.1.11-0.20210813005559-691160354723 h1:sHOAIxRGBp443oHZIPB+HsUGaksVCXVQENPxwTfQdH4=
-go.uber.org/goleak v1.1.11-0.20210813005559-691160354723/go.mod h1:cwTWslyiVhfpKIDGSZEM2HlOvcqm+tG4zioyIeLoqMQ=
+go.uber.org/goleak v1.1.11 h1:wy28qYRKZgnJTxGxvye5/wgWr1EKjmUDGYox5mGlRlI=
+go.uber.org/goleak v1.1.11/go.mod h1:cwTWslyiVhfpKIDGSZEM2HlOvcqm+tG4zioyIeLoqMQ=
 go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/0=
 go.uber.org/multierr v1.3.0/go.mod h1:VgVr7evmIr6uPjLBxg28wmKNXyqE9akIJ5XnfpiKl+4=
 go.uber.org/multierr v1.6.0 h1:y6IPFStTAIT5Ytl7/XYmHvzXQ7S3g/IeZW9hyZ5thw4=
@@ -717,8 +728,8 @@ go.uber.org/tools v0.0.0-20190618225709-2cfd321de3ee/go.mod h1:vJERXedbb3MVM5f9E
 go.uber.org/zap v1.9.1/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q=
 go.uber.org/zap v1.10.0/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q=
 go.uber.org/zap v1.13.0/go.mod h1:zwrFLgMcdUuIBviXEYEH1YKNaOBnKXsx2IPda5bBwHM=
-go.uber.org/zap v1.19.1 h1:ue41HOKd1vGURxrmeKIgELGb3jPW9DMUDGtsinblHwI=
-go.uber.org/zap v1.19.1/go.mod h1:j3DNczoxDZroyBnOT1L/Q79cfUMGZxlv/9dzN7SM1rI=
+go.uber.org/zap v1.20.0 h1:N4oPlghZwYG55MlU6LXk/Zp00FVNE9X9wrYO8CEs4lc=
+go.uber.org/zap v1.20.0/go.mod h1:wjWOCqI0f2ZZrJF/UufIOkiC8ii6tm1iqIsLo76RfJw=
 golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
 golang.org/x/crypto v0.0.0-20181029021203-45a5f77698d3/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
@@ -1112,6 +1123,11 @@ gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C
 gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo=
 gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gorm.io/driver/mysql v1.3.2 h1:QJryWiqQ91EvZ0jZL48NOpdlPdMjdip1hQ8bTgo4H7I=
+gorm.io/driver/mysql v1.3.2/go.mod h1:ChK6AHbHgDCFZyJp0F+BmVGb06PSIoh9uVYKAlRbb2U=
+gorm.io/gorm v1.23.1/go.mod h1:l2lP/RyAtc1ynaTjFksBde/O8v9oOGIApu2/xRitmZk=
+gorm.io/gorm v1.23.2 h1:xmq9QRMWL8HTJyhAUBXy8FqIIQCYESeKfJL4DoGKiWQ=
+gorm.io/gorm v1.23.2/go.mod h1:l2lP/RyAtc1ynaTjFksBde/O8v9oOGIApu2/xRitmZk=
 gotest.tools v2.2.0+incompatible/go.mod h1:DsYFclhRJ6vuDpmuTbkuFWG+y2sxOXAzmJt81HFBacw=
 honnef.co/go/tools v0.0.0-20180728063816-88497007e858/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=

gorm.go

@@ -0,0 +1,85 @@
+package logger
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	gl "gorm.io/gorm/logger"
+	"time"
+)
+
+// 基于Gorm的日志实现
+type gormLogger struct {
+	gl.Config
+}
+
+// LogMode 实现LogMode接口
+func (l *gormLogger) LogMode(level gl.LogLevel) gl.Interface {
+	nl := *l
+	nl.LogLevel = level
+	return &nl
+}
+
+// Info 实现Info接口
+func (l gormLogger) Info(ctx context.Context, msg string, data ...interface{}) {
+	if l.LogLevel >= gl.Info {
+		//	// 去掉第一行
+		//	msg = strings.Join(strings.Split(msg, "\n")[1:], " ")
+		//	Say.Info(msg)
+		//
+		//	l.Printf(msg, append([]interface{}{utils.FileWithLineNum()}, data...)...)
+	}
+}
+
+// Warn 实现Warn接口
+func (l gormLogger) Warn(ctx context.Context, msg string, data ...interface{}) {
+	if l.LogLevel >= gl.Warn {
+		//
+	}
+}
+
+// 实现Error接口
+func (l gormLogger) Error(ctx context.Context, msg string, data ...interface{}) {
+	if l.LogLevel >= gl.Error {
+		//
+	}
+}
+
+// Trace 实现Trace接口
+func (l gormLogger) Trace(ctx context.Context, begin time.Time, fc func() (string, int64), err error) {
+	if l.LogLevel <= gl.Silent {
+		return
+	}
+
+	elapsed := time.Since(begin)
+	sql, rows := fc()
+	msg := fmt.Sprintf("[%v] [rows:%v] %s", elapsed.String(), rows, sql)
+	if rows == -1 {
+		msg = fmt.Sprintf("[%s] [-] %s", elapsed.String(), sql)
+	}
+
+	switch {
+	case err != nil && l.LogLevel >= gl.Error && (!errors.Is(err, gl.ErrRecordNotFound) || !l.IgnoreRecordNotFoundError):
+		Say.Errorf("%s -> %s", err.Error(), sql)
+	case elapsed > l.SlowThreshold && l.SlowThreshold != 0 && l.LogLevel >= gl.Warn:
+		slowLog := fmt.Sprintf("SLOW SQL >= %v", l.SlowThreshold)
+		Say.Warnf("%v -> %v", slowLog, sql)
+	case l.LogLevel == gl.Info:
+		Say.Info(msg)
+	}
+}
+
+// NewGormLoggerWithConfig ...
+func NewGormLoggerWithConfig(config gl.Config) gl.Interface {
+	return &gormLogger{config}
+}
+
+// DefaultGormLogger 默认的日志实现
+func DefaultGormLogger() gl.Interface {
+	return &gormLogger{gl.Config{
+		SlowThreshold:             time.Second, // Slow SQL threshold
+		IgnoreRecordNotFoundError: false,       // 忽略没找到结果的错误
+		LogLevel:                  gl.Info,     // Log level
+		Colorful:                  false,       // Disable color
+	}}
+}

gorm_test.go

@@ -0,0 +1,22 @@
+package logger
+
+import (
+	"gorm.io/driver/mysql"
+	"gorm.io/gorm"
+	"testing"
+)
+
+func TestGormLogger(t *testing.T) {
+	dsn := "saas:saas123@tcp(10.11.0.10:3307)/saas_tenant?charset=utf8mb4&parseTime=True&loc=Local"
+
+	engine, err := gorm.Open(mysql.Open(dsn), &gorm.Config{Logger: DefaultGormLogger()})
+	if err != nil {
+		Say.Panicf("mysql connect error: %s", err.Error())
+	}
+
+	var count int64
+	if err := engine.Table("t_tenant1").Count(&count).Error; err != nil {
+		t.Log(err)
+	}
+	t.Logf("count: %d", count)
+}

logger.go

@@ -1,6 +1,8 @@
 package logger
 
 import (
+	"fmt"
+	"github.com/caarlos0/env/v6"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
 )
@@ -10,7 +12,15 @@ var Say *zap.SugaredLogger
 
 // 避免异常，在第一次调用时初始化一个只打印到控制台的logger
 func init() {
-	InitLogger(LogConfig{Mode: Dev, LokiEnable: false, FileEnable: false})
+	if Say == nil {
+		// 从环境变量读取配置
+		var c LogConfig
+		if err := env.Parse(&c); err != nil {
+			fmt.Println("日志配置解析错误: " + err.Error())
+			c = LogConfig{Mode: Dev, LokiEnable: false, FileEnable: false}
+		}
+		InitLogger(c)
+	}
 }
 
 // InitLogger 初始化日志工具

logger_test.go

@@ -1,8 +1,16 @@
 package logger
 
-import "testing"
+import (
+	"testing"
+	"time"
+)
 
 func TestLogger(t *testing.T) {
 	InitLogger(LogConfig{Mode: Dev, LokiEnable: false, FileEnable: true})
 	Say.Debug("芜湖")
 }
+
+func TestLogger1(t *testing.T) {
+	Say.Info("我是测试消息")
+	time.Sleep(5 * time.Second)
+}

loki.go

@@ -32,7 +32,7 @@ func initLokiCore() zapcore.Core {
 	// 格式相关的配置
 	encoderConfig := zap.NewProductionEncoderConfig()
 	// 修改时间戳的格式
-	encoderConfig.EncodeTime = customTimeEncoder
+	encoderConfig.EncodeTime = customTimeEncoder // zapcore.EpochNanosTimeEncoder
 	// 日志级别使用大写
 	encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
 	// 将日志级别设置为 DEBUG
@@ -69,14 +69,17 @@ func (c lokiWriter) Write(p []byte) (int, error) {
 		return 0, err
 	}
 
-	label := model.LabelSet{"job": model.LabelValue(config.LokiName)}
-	label["source"] = model.LabelValue(config.LokiName)
+	label := model.LabelSet{"job": model.LabelValue(config.LokiJob)}
+	label["source"] = model.LabelValue(config.LokiSource)
 	label["level"] = model.LabelValue(li.Level)
 	label["caller"] = model.LabelValue(li.Caller)
 	// 异步推送消息到服务器
 	go func() {
-		err = lokiClient.Handle(label, time.Now().Local(), li.Msg)
-		if err != nil {
+		t, e := time.ParseInLocation("2006-01-02 15:04:05.000", li.Ts, time.Local)
+		if e != nil {
+			t = time.Now().Local()
+		}
+		if err = lokiClient.Handle(label, t, li.Msg); err != nil {
 			fmt.Printf("日志推送到Loki失败: %v\n", err.Error())
 		}
 	}()

readme.md

@@ -12,3 +12,14 @@ func main() {
 	logger.Say.Debug("芜湖")
 }
 ```
+
+### 环境变量
+```shell
+export LOG_MODE=0 # 0: dev, 1: prod
+export LOG_LOKI_ENABLE=1 # 是否启用Loki 0: disable, 1: enable
+export LOG_FILE_ENABLE=0 # 是否启用输出到文件 0: disable, 1: enable
+export LOG_LOKI_HOST=10.0.0.31 # Loki地址
+export LOG_LOKI_PORT=3100 # Loki端口
+export LOG_LOKI_SOURCE_NAME=tests # Loki Source 名称
+export LOG_LOKI_JOB_NAME=testj # Loki Job 名称
+```