Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: improve log mod name #517

Merged
merged 7 commits into from
Oct 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pkg/client/grpc/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ func DefaultConfig() *Config {
dialOptions: []grpc.DialOption{
grpc.WithInsecure(),
},
logger: xlog.Jupiter(),
logger: xlog.Jupiter().Named(ecode.ModClientGrpc),
BalancerName: roundrobin.Name, // round robin by default
DialTimeout: cast.ToDuration("3s"),
ReadTimeout: cast.ToDuration("1s"),
Expand Down
3 changes: 2 additions & 1 deletion pkg/client/redisgo/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (

cfg "github.com/douyu/jupiter/pkg/conf"
"github.com/douyu/jupiter/pkg/core/constant"
"github.com/douyu/jupiter/pkg/core/ecode"
"github.com/douyu/jupiter/pkg/util/xdebug"
"github.com/douyu/jupiter/pkg/xlog"
)
Expand Down Expand Up @@ -87,7 +88,7 @@ func DefaultConfig() *Config {
EnableMetricInterceptor: true,
EnableTraceInterceptor: true,
SlowLogThreshold: cast.ToDuration("250ms"),
logger: xlog.Jupiter().With(xlog.FieldMod("redigo")),
logger: xlog.Jupiter().Named(ecode.ModClientRedis),
OnDialError: "panic",
}
}
Expand Down
5 changes: 3 additions & 2 deletions pkg/client/resty/resty.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"github.com/alibaba/sentinel-golang/core/base"
"github.com/douyu/jupiter/pkg/conf"
"github.com/douyu/jupiter/pkg/core/constant"
"github.com/douyu/jupiter/pkg/core/ecode"
"github.com/douyu/jupiter/pkg/core/metric"
"github.com/douyu/jupiter/pkg/core/sentinel"
"github.com/douyu/jupiter/pkg/core/xtrace"
Expand Down Expand Up @@ -110,7 +111,7 @@ func DefaultConfig() *Config {
Timeout: cast.ToDuration("3000ms"),
EnableAccessLog: false,
EnableSentinel: true,
logger: xlog.Jupiter().With(xlog.FieldMod("resty")),
logger: xlog.Jupiter().Named(ecode.ModeClientResty),
}
}

Expand Down Expand Up @@ -235,7 +236,7 @@ func (config *Config) Build() (*resty.Client, error) {
func (c *Config) MustBuild() *resty.Client {
cc, err := c.Build()
if err != nil {
xlog.Jupiter().Panic("resty build failed", zap.Error(err), zap.Any("config", c))
c.logger.Panic("resty build failed", zap.Error(err), zap.Any("config", c))
}

return cc
Expand Down
6 changes: 2 additions & 4 deletions pkg/client/rocketmq/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,17 @@ import (
"runtime"

"github.com/apache/rocketmq-client-go/v2/primitive"
"github.com/apache/rocketmq-client-go/v2/rlog"
"github.com/douyu/jupiter/pkg/core/ecode"
"github.com/douyu/jupiter/pkg/xlog"
"go.uber.org/zap"
)

func init() {
rlog.SetLogLevel("debug")
rlog.SetLogger(&mqLogger{xlog.Jupiter()})

primitive.PanicHandler = func(i interface{}) {
stack := make([]byte, 1024)
length := runtime.Stack(stack, true)
fmt.Fprint(os.Stderr, "[rocketmq panic recovery]\n", string(stack[:length]))
xlog.Jupiter().Error("rocketmq panic recovery", zap.Any("error", i))
xlog.Jupiter().Named(ecode.ModeClientRocketMQ).Error("rocketmq panic recovery", zap.Any("error", i))
}
}
9 changes: 7 additions & 2 deletions pkg/core/application/application.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import (
"github.com/douyu/jupiter/pkg/core/ecode"
"github.com/douyu/jupiter/pkg/core/executor"
"github.com/douyu/jupiter/pkg/core/hooks"
"github.com/douyu/jupiter/pkg/core/rocketmq"
"github.com/douyu/jupiter/pkg/core/signals"
"github.com/douyu/jupiter/pkg/core/xgrpclog"
"github.com/douyu/jupiter/pkg/flag"
Expand Down Expand Up @@ -110,11 +111,15 @@ func (app *Application) initialize() {

_ = app.parseFlags()
_ = app.printBanner()

xgrpclog.SetLogger(xlog.Jupiter())
app.initLogger()
})
}

func (app *Application) initLogger() {
xgrpclog.SetLogger(xlog.Jupiter())
rocketmq.SetLogger(xlog.Jupiter())
}

// // start up application
// // By default the startup composition is:
// // - parse config, watch, version flags
Expand Down
21 changes: 19 additions & 2 deletions pkg/core/ecode/unified.go
Original file line number Diff line number Diff line change
Expand Up @@ -109,16 +109,33 @@ const (
ModApp = "app"
// ModProc ...
ModProc = "proc"

// ModGrpcServer ...
ModGrpcServer = "server.grpc"
// ModHTTPServer ...
ModEchoServer = "server.echo"

ModCacheFreecache = "cache.freecache"

// ModRegistryETCD ...
ModRegistryETCD = "registry.etcd"

// ModClientETCD ...
ModClientETCD = "client.etcd"
// ModClientGrpc ...
ModClientGrpc = "client.grpc"
// ModClientMySQL ...
ModClientMySQL = "client.mysql"
// ModeClientRocketMQ ...
ModeClientRocketMQ = "client.rocketmq"
// ModClientRedis ...
ModClientRedis = "client.redis"
// ModeClientResty ...
ModeClientResty = "client.resty"

// ModStoreMySQL ...
ModStoreMySQL = "store.mysql"
// ModStoreMongo ...
ModStoreMongo = "store.mongo"

// ModXcronETCD ...
ModXcronETCD = "xcron.etcd"
)
14 changes: 14 additions & 0 deletions pkg/client/rocketmq/log.go → pkg/core/rocketmq/log.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,27 @@
package rocketmq

import (
"github.com/apache/rocketmq-client-go/v2/rlog"
"github.com/douyu/jupiter/pkg/core/ecode"
"go.uber.org/zap"
)

type mqLogger struct {
logger *zap.Logger
}

const (
defaultCallerSkip = 2
)

func SetLogger(logger *zap.Logger) {
rlog.SetLogLevel("debug")
rlog.SetLogger(&mqLogger{
logger: logger.Named(ecode.ModeClientRocketMQ).
WithOptions(zap.AddCallerSkip(defaultCallerSkip)),
})
}

func (l *mqLogger) Debug(msg string, fields map[string]interface{}) {
if msg == "" && len(fields) == 0 {
return
Expand Down
3 changes: 2 additions & 1 deletion pkg/core/xgrpclog/logger.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package xgrpclog
import (
"fmt"

"github.com/douyu/jupiter/pkg/core/ecode"
"github.com/douyu/jupiter/pkg/xlog"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
Expand Down Expand Up @@ -30,7 +31,7 @@ var (

// SetLogger sets loggerWrapper to grpclog
func SetLogger(logger *xlog.Logger) {
logger = logger.WithOptions(zap.AddCallerSkip(defaultCallerSkip))
logger = logger.Named(ecode.ModClientGrpc).WithOptions(zap.AddCallerSkip(defaultCallerSkip))
grpclog.SetLoggerV2(&loggerWrapper{logger: logger, sugar: logger.Sugar()})
}

Expand Down
2 changes: 1 addition & 1 deletion pkg/registry/etcdv3/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ func DefaultConfig() *Config {
Config: etcdv3.DefaultConfig(),
ReadTimeout: time.Second * 3,
Prefix: "wsd-reg",
logger: xlog.Jupiter(),
logger: xlog.Jupiter().Named(ecode.ModRegistryETCD),
ServiceTTL: cast.ToDuration("60s"),
}
}
Expand Down
6 changes: 3 additions & 3 deletions pkg/registry/etcdv3/registry.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ var _ registry.Registry = new(etcdv3Registry)

func newETCDRegistry(config *Config) (*etcdv3Registry, error) {
if config.logger == nil {
config.logger = xlog.Jupiter()
config.logger = xlog.Jupiter().Named(ecode.ModRegistryETCD)
}
config.logger = config.logger.With(xlog.FieldMod(ecode.ModRegistryETCD), xlog.FieldAddrAny(config.Config.Endpoints))
config.logger = config.logger.With(xlog.FieldAddrAny(config.Config.Endpoints))
etcdv3Client, err := config.Config.Singleton()
if err != nil {
config.logger.Error("create etcdv3 client", xlog.FieldErrKind(ecode.ErrKindRequestErr), xlog.FieldErr(err))
Expand Down Expand Up @@ -164,7 +164,7 @@ func (reg *etcdv3Registry) WatchServices(ctx context.Context, prefix string) (ch
// case addresses <- snapshot:
case addresses <- *out:
default:
xlog.Jupiter().Warn("invalid")
reg.logger.Warn("invalid event")
}
}
})
Expand Down
5 changes: 1 addition & 4 deletions pkg/server/xecho/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,6 @@ import (
"go.uber.org/zap"
)

//ModName named a mod
const ModName = "server.echo"

//Config HTTP config
type Config struct {
Host string
Expand Down Expand Up @@ -56,7 +53,7 @@ func DefaultConfig() *Config {
Debug: false,
Deployment: constant.DefaultDeployment,
SlowQueryThresholdInMilli: 500, // 500ms
logger: xlog.Jupiter().With(xlog.FieldMod(ModName)),
logger: xlog.Jupiter().Named(ecode.ModEchoServer),
EnableTLS: false,
CertFile: "cert.pem",
PrivateFile: "private.pem",
Expand Down
2 changes: 1 addition & 1 deletion pkg/server/xgrpc/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ func DefaultConfig() *Config {
DisableTrace: false,
EnableTLS: false,
SlowQueryThresholdInMilli: 500,
logger: xlog.Jupiter().With(xlog.FieldMod("server.grpc")),
logger: xlog.Jupiter().Named(ecode.ModGrpcServer),
serverOptions: []grpc.ServerOption{},
streamInterceptors: []grpc.StreamServerInterceptor{},
unaryInterceptors: []grpc.UnaryServerInterceptor{},
Expand Down
3 changes: 0 additions & 3 deletions pkg/store/mongox/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import (
"net/http"

"github.com/douyu/jupiter/pkg/core/application"
"github.com/douyu/jupiter/pkg/xlog"
jsoniter "github.com/json-iterator/go"
"go.mongodb.org/mongo-driver/mongo"
)
Expand All @@ -31,5 +30,3 @@ func init() {
_ = jsoniter.NewEncoder(w).Encode(rets)
})
}

var _logger = xlog.Jupiter().With(xlog.FieldMod("mongodb"))
6 changes: 3 additions & 3 deletions pkg/store/mongox/mongo.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ func newSession(config *Config) *mongo.Client {
clientOpts.SocketTimeout = &config.SocketTimeout
client, err := mongo.Connect(context.Background(), clientOpts.ApplyURI(config.DSN))
if err != nil {
_logger.Panic("dial mongo", xlog.FieldAddr(config.DSN), xlog.Any("error", err))
config.logger.Panic("dial mongo", xlog.FieldAddr(config.DSN), xlog.Any("error", err))
}

_instances.Store(config.Name, client)
Expand All @@ -37,10 +37,10 @@ func newSession(config *Config) *mongo.Client {

func isConfigErr(config *Config) {
if config.SocketTimeout == time.Duration(0) {
_logger.Panic("invalid config", xlog.FieldExtMessage("socketTimeout"))
config.logger.Panic("invalid config", xlog.FieldExtMessage("socketTimeout"))
}

if config.PoolLimit == 0 {
_logger.Panic("invalid config", xlog.FieldExtMessage("poolLimit"))
config.logger.Panic("invalid config", xlog.FieldExtMessage("poolLimit"))
}
}
6 changes: 6 additions & 0 deletions pkg/store/mongox/option.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,12 @@ import (

"github.com/douyu/jupiter/pkg/conf"
"github.com/douyu/jupiter/pkg/core/constant"
"github.com/douyu/jupiter/pkg/core/ecode"
"github.com/douyu/jupiter/pkg/core/singleton"
"github.com/douyu/jupiter/pkg/xlog"
"github.com/spf13/cast"
"go.mongodb.org/mongo-driver/mongo"
"go.uber.org/zap"
)

// Config ...
Expand All @@ -20,6 +23,8 @@ type (
SocketTimeout time.Duration `json:"socketTimeout" toml:"socketTimeout"`
// 连接池大小(最大连接数)
PoolLimit int `json:"poolLimit" toml:"poolLimit"`

logger *zap.Logger
}
)

Expand All @@ -43,6 +48,7 @@ func DefaultConfig() *Config {
return &Config{
SocketTimeout: cast.ToDuration("5s"),
PoolLimit: 100,
logger: xlog.Jupiter().Named(ecode.ModStoreMongo),
}
}

Expand Down