From 1983c89e27692a81ebf15672099c59773f06b3ca Mon Sep 17 00:00:00 2001 From: Piotr Tabor Date: Wed, 30 Sep 2020 09:16:07 +0200 Subject: [PATCH] pkg/logutil, etcdserver: Move zap-raft logger to etcdserver. This package depends on raft and is solelly used by etcdserver/raft.go. So it does not fullfills conditions of: ``` pkg/ is a collection of utility packages used by etcd without being specific to etcd itself. A package belongs here only if it could possibly be moved out into its own repository in the future. ``` --- etcdserver/raft.go | 16 ++++++++-------- {pkg/logutil => etcdserver}/zap_raft.go | 2 +- {pkg/logutil => etcdserver}/zap_raft_test.go | 12 ++++++------ 3 files changed, 15 insertions(+), 15 deletions(-) rename {pkg/logutil => etcdserver}/zap_raft.go (99%) rename {pkg/logutil => etcdserver}/zap_raft_test.go (92%) diff --git a/etcdserver/raft.go b/etcdserver/raft.go index 77933b219..a38712283 100644 --- a/etcdserver/raft.go +++ b/etcdserver/raft.go @@ -122,11 +122,11 @@ type raftNodeConfig struct { func newRaftNode(cfg raftNodeConfig) *raftNode { var lg raft.Logger if cfg.lg != nil { - lg = logutil.NewRaftLoggerZap(cfg.lg) + lg = NewRaftLoggerZap(cfg.lg) } else { lcfg := logutil.DefaultZapLoggerConfig var err error - lg, err = logutil.NewRaftLogger(&lcfg) + lg, err = NewRaftLogger(&lcfg) if err != nil { log.Fatalf("cannot create raft logger %v", err) } @@ -463,12 +463,12 @@ func startNode(cfg ServerConfig, cl *membership.RaftCluster, ids []types.ID) (id if cfg.Logger != nil { // called after capnslog setting in "init" function if cfg.LoggerConfig != nil { - c.Logger, err = logutil.NewRaftLogger(cfg.LoggerConfig) + c.Logger, err = NewRaftLogger(cfg.LoggerConfig) if err != nil { log.Fatalf("cannot create raft logger %v", err) } } else if cfg.LoggerCore != nil && cfg.LoggerWriteSyncer != nil { - c.Logger = logutil.NewRaftLoggerFromZapCore(cfg.LoggerCore, cfg.LoggerWriteSyncer) + c.Logger = NewRaftLoggerFromZapCore(cfg.LoggerCore, cfg.LoggerWriteSyncer) } } @@ -518,12 +518,12 @@ func restartNode(cfg ServerConfig, snapshot *raftpb.Snapshot) (types.ID, *member // called after capnslog setting in "init" function var err error if cfg.LoggerConfig != nil { - c.Logger, err = logutil.NewRaftLogger(cfg.LoggerConfig) + c.Logger, err = NewRaftLogger(cfg.LoggerConfig) if err != nil { log.Fatalf("cannot create raft logger %v", err) } } else if cfg.LoggerCore != nil && cfg.LoggerWriteSyncer != nil { - c.Logger = logutil.NewRaftLoggerFromZapCore(cfg.LoggerCore, cfg.LoggerWriteSyncer) + c.Logger = NewRaftLoggerFromZapCore(cfg.LoggerCore, cfg.LoggerWriteSyncer) } } @@ -602,12 +602,12 @@ func restartAsStandaloneNode(cfg ServerConfig, snapshot *raftpb.Snapshot) (types if cfg.Logger != nil { // called after capnslog setting in "init" function if cfg.LoggerConfig != nil { - c.Logger, err = logutil.NewRaftLogger(cfg.LoggerConfig) + c.Logger, err = NewRaftLogger(cfg.LoggerConfig) if err != nil { log.Fatalf("cannot create raft logger %v", err) } } else if cfg.LoggerCore != nil && cfg.LoggerWriteSyncer != nil { - c.Logger = logutil.NewRaftLoggerFromZapCore(cfg.LoggerCore, cfg.LoggerWriteSyncer) + c.Logger = NewRaftLoggerFromZapCore(cfg.LoggerCore, cfg.LoggerWriteSyncer) } } diff --git a/pkg/logutil/zap_raft.go b/etcdserver/zap_raft.go similarity index 99% rename from pkg/logutil/zap_raft.go rename to etcdserver/zap_raft.go index f0772a17c..11115d217 100644 --- a/pkg/logutil/zap_raft.go +++ b/etcdserver/zap_raft.go @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package logutil +package etcdserver import ( "errors" diff --git a/pkg/logutil/zap_raft_test.go b/etcdserver/zap_raft_test.go similarity index 92% rename from pkg/logutil/zap_raft_test.go rename to etcdserver/zap_raft_test.go index 5724f1916..92afca8c2 100644 --- a/pkg/logutil/zap_raft_test.go +++ b/etcdserver/zap_raft_test.go @@ -12,20 +12,20 @@ // See the License for the specific language governing permissions and // limitations under the License. -package logutil +package etcdserver import ( "bytes" "fmt" + "go.etcd.io/etcd/v3/pkg/logutil" + "go.uber.org/zap" + "go.uber.org/zap/zapcore" "io/ioutil" "os" "path/filepath" "strings" "testing" "time" - - "go.uber.org/zap" - "go.uber.org/zap/zapcore" ) func TestNewRaftLogger(t *testing.T) { @@ -40,7 +40,7 @@ func TestNewRaftLogger(t *testing.T) { Thereafter: 100, }, Encoding: "json", - EncoderConfig: DefaultZapLoggerConfig.EncoderConfig, + EncoderConfig: logutil.DefaultZapLoggerConfig.EncoderConfig, OutputPaths: []string{logPath}, ErrorOutputPaths: []string{logPath}, } @@ -66,7 +66,7 @@ func TestNewRaftLogger(t *testing.T) { if !bytes.Contains(data, []byte("etcd-logutil-2")) { t.Fatalf("can't find data in log %q", string(data)) } - if !bytes.Contains(data, []byte("logutil/zap_raft_test.go:")) { + if !bytes.Contains(data, []byte("zap_raft_test.go:")) { t.Fatalf("unexpected caller; %q", string(data)) } }