From 82ee796aa466b779703ff43c2bd72033db49147f Mon Sep 17 00:00:00 2001 From: Gyuho Lee Date: Wed, 7 Mar 2018 10:45:29 -0800 Subject: [PATCH 1/2] pkg/logutil: move "pkg/logger" to "logutil" Signed-off-by: Gyuho Lee --- pkg/{logger/discard.go => logutil/discard_logger.go} | 2 +- pkg/{logger => logutil}/doc.go | 4 ++-- pkg/{logger => logutil}/logger.go | 6 +++--- pkg/{logger => logutil}/logger_test.go | 8 ++++---- pkg/logutil/merge_logger.go | 1 - pkg/logutil/merge_logger_test.go | 6 +----- pkg/{logger => logutil}/package_logger.go | 2 +- pkg/{logger => logutil}/package_logger_test.go | 8 ++++---- 8 files changed, 16 insertions(+), 21 deletions(-) rename pkg/{logger/discard.go => logutil/discard_logger.go} (99%) rename pkg/{logger => logutil}/doc.go (88%) rename pkg/{logger => logutil}/logger.go (93%) rename pkg/{logger => logutil}/logger_test.go (85%) rename pkg/{logger => logutil}/package_logger.go (99%) rename pkg/{logger => logutil}/package_logger_test.go (92%) diff --git a/pkg/logger/discard.go b/pkg/logutil/discard_logger.go similarity index 99% rename from pkg/logger/discard.go rename to pkg/logutil/discard_logger.go index 0ac32462e..81b0a9d03 100644 --- a/pkg/logger/discard.go +++ b/pkg/logutil/discard_logger.go @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package logger +package logutil import ( "log" diff --git a/pkg/logger/doc.go b/pkg/logutil/doc.go similarity index 88% rename from pkg/logger/doc.go rename to pkg/logutil/doc.go index c32ffae4c..e919f2499 100644 --- a/pkg/logger/doc.go +++ b/pkg/logutil/doc.go @@ -12,5 +12,5 @@ // See the License for the specific language governing permissions and // limitations under the License. -// Package logger implements various logging utilities. -package logger +// Package logutil includes utilities to facilitate logging. +package logutil diff --git a/pkg/logger/logger.go b/pkg/logutil/logger.go similarity index 93% rename from pkg/logger/logger.go rename to pkg/logutil/logger.go index 1256cec64..cd1de5f7f 100644 --- a/pkg/logger/logger.go +++ b/pkg/logutil/logger.go @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package logger +package logutil import "google.golang.org/grpc/grpclog" @@ -28,7 +28,7 @@ type Logger interface { // assert that "defaultLogger" satisfy "Logger" interface var _ Logger = &defaultLogger{} -// New wraps "grpclog.LoggerV2" that implements "Logger" interface. +// NewLogger wraps "grpclog.LoggerV2" that implements "Logger" interface. // // For example: // @@ -36,7 +36,7 @@ var _ Logger = &defaultLogger{} // g := grpclog.NewLoggerV2WithVerbosity(os.Stderr, os.Stderr, os.Stderr, 4) // defaultLogger = New(g) // -func New(g grpclog.LoggerV2) Logger { return &defaultLogger{g: g} } +func NewLogger(g grpclog.LoggerV2) Logger { return &defaultLogger{g: g} } type defaultLogger struct { g grpclog.LoggerV2 diff --git a/pkg/logger/logger_test.go b/pkg/logutil/logger_test.go similarity index 85% rename from pkg/logger/logger_test.go rename to pkg/logutil/logger_test.go index b50eeb2a8..1f2ef9b68 100644 --- a/pkg/logger/logger_test.go +++ b/pkg/logutil/logger_test.go @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package logger_test +package logutil_test import ( "bytes" @@ -20,7 +20,7 @@ import ( "strings" "testing" - "github.com/coreos/etcd/pkg/logger" + "github.com/coreos/etcd/pkg/logutil" "google.golang.org/grpc/grpclog" ) @@ -28,7 +28,7 @@ import ( func TestLogger(t *testing.T) { buf := new(bytes.Buffer) - l := logger.New(grpclog.NewLoggerV2WithVerbosity(buf, buf, buf, 10)) + l := logutil.NewLogger(grpclog.NewLoggerV2WithVerbosity(buf, buf, buf, 10)) l.Infof("hello world!") if !strings.Contains(buf.String(), "hello world!") { t.Fatalf("expected 'hello world!', got %q", buf.String()) @@ -45,7 +45,7 @@ func TestLogger(t *testing.T) { } buf.Reset() - l = logger.New(grpclog.NewLoggerV2(ioutil.Discard, ioutil.Discard, ioutil.Discard)) + l = logutil.NewLogger(grpclog.NewLoggerV2(ioutil.Discard, ioutil.Discard, ioutil.Discard)) l.Infof("ignore this") if len(buf.Bytes()) > 0 { t.Fatalf("unexpected logs %q", buf.String()) diff --git a/pkg/logutil/merge_logger.go b/pkg/logutil/merge_logger.go index cc750f4d3..866b6f7a8 100644 --- a/pkg/logutil/merge_logger.go +++ b/pkg/logutil/merge_logger.go @@ -12,7 +12,6 @@ // See the License for the specific language governing permissions and // limitations under the License. -// Package logutil includes utilities to facilitate logging. package logutil import ( diff --git a/pkg/logutil/merge_logger_test.go b/pkg/logutil/merge_logger_test.go index 99e422d9d..10d0e4372 100644 --- a/pkg/logutil/merge_logger_test.go +++ b/pkg/logutil/merge_logger_test.go @@ -23,16 +23,12 @@ import ( "github.com/coreos/pkg/capnslog" ) -var ( - testLogger = capnslog.NewPackageLogger("github.com/coreos/etcd", "pkg/logutil") -) - func TestMergeLogger(t *testing.T) { var ( txt = "hello" repeatN = 6 duration = 2049843762 * time.Nanosecond - mg = NewMergeLogger(testLogger) + mg = NewMergeLogger(capnslog.NewPackageLogger("github.com/coreos/etcd", "pkg/logutil")) ) // overwrite this for testing defaultMergePeriod = time.Minute diff --git a/pkg/logger/package_logger.go b/pkg/logutil/package_logger.go similarity index 99% rename from pkg/logger/package_logger.go rename to pkg/logutil/package_logger.go index 576f31d2f..378bee0e3 100644 --- a/pkg/logger/package_logger.go +++ b/pkg/logutil/package_logger.go @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package logger +package logutil import ( "github.com/coreos/pkg/capnslog" diff --git a/pkg/logger/package_logger_test.go b/pkg/logutil/package_logger_test.go similarity index 92% rename from pkg/logger/package_logger_test.go rename to pkg/logutil/package_logger_test.go index 8205ec9f5..b6ab0052b 100644 --- a/pkg/logger/package_logger_test.go +++ b/pkg/logutil/package_logger_test.go @@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package logger_test +package logutil_test import ( "bytes" @@ -20,16 +20,16 @@ import ( "strings" "testing" - "github.com/coreos/pkg/capnslog" + "github.com/coreos/etcd/pkg/logutil" - "github.com/coreos/etcd/pkg/logger" + "github.com/coreos/pkg/capnslog" ) func TestPackageLogger(t *testing.T) { buf := new(bytes.Buffer) capnslog.SetFormatter(capnslog.NewDefaultFormatter(buf)) - l := logger.NewPackageLogger("github.com/coreos/etcd", "logger") + l := logutil.NewPackageLogger("github.com/coreos/etcd", "logger") r := capnslog.MustRepoLogger("github.com/coreos/etcd") r.SetLogLevel(map[string]capnslog.LogLevel{"logger": capnslog.INFO}) From 4e0c00244df50c7aaf0f2e34025bb1f4666dada6 Mon Sep 17 00:00:00 2001 From: Gyuho Lee Date: Wed, 7 Mar 2018 10:49:25 -0800 Subject: [PATCH 2/2] *: remove "pkg/logger", replace with "pkg/logutil" Signed-off-by: Gyuho Lee --- clientv3/logger.go | 16 ++++++++-------- etcdctl/ctlv3/command/snapshot_command.go | 14 +++++++------- snapshot/v3_snapshot.go | 8 ++++---- snapshot/v3_snapshot_test.go | 8 ++++---- 4 files changed, 23 insertions(+), 23 deletions(-) diff --git a/clientv3/logger.go b/clientv3/logger.go index 6c13514a2..3276372ad 100644 --- a/clientv3/logger.go +++ b/clientv3/logger.go @@ -18,14 +18,14 @@ import ( "io/ioutil" "sync" - "github.com/coreos/etcd/pkg/logger" + "github.com/coreos/etcd/pkg/logutil" "google.golang.org/grpc/grpclog" ) var ( lgMu sync.RWMutex - lg logger.Logger + lg logutil.Logger ) type settableLogger struct { @@ -42,22 +42,22 @@ func init() { // SetLogger sets client-side Logger. func SetLogger(l grpclog.LoggerV2) { lgMu.Lock() - lg = logger.New(l) + lg = logutil.NewLogger(l) // override grpclog so that any changes happen with locking grpclog.SetLoggerV2(lg) lgMu.Unlock() } -// GetLogger returns the current logger.Logger. -func GetLogger() logger.Logger { +// GetLogger returns the current logutil.Logger. +func GetLogger() logutil.Logger { lgMu.RLock() l := lg lgMu.RUnlock() return l } -// NewLogger returns a new Logger with logger.Logger. -func NewLogger(gl grpclog.LoggerV2) logger.Logger { +// NewLogger returns a new Logger with logutil.Logger. +func NewLogger(gl grpclog.LoggerV2) logutil.Logger { return &settableLogger{l: gl} } @@ -97,5 +97,5 @@ func (s *settableLogger) Lvl(lvl int) grpclog.LoggerV2 { if l.V(lvl) { return s } - return logger.NewDiscardLogger() + return logutil.NewDiscardLogger() } diff --git a/etcdctl/ctlv3/command/snapshot_command.go b/etcdctl/ctlv3/command/snapshot_command.go index b66fadfbc..3ce5b1f8a 100644 --- a/etcdctl/ctlv3/command/snapshot_command.go +++ b/etcdctl/ctlv3/command/snapshot_command.go @@ -20,7 +20,7 @@ import ( "path/filepath" "strings" - "github.com/coreos/etcd/pkg/logger" + "github.com/coreos/etcd/pkg/logutil" "github.com/coreos/etcd/pkg/types" "github.com/coreos/etcd/snapshot" @@ -96,13 +96,13 @@ func snapshotSaveCommandFunc(cmd *cobra.Command, args []string) { ExitWithError(ExitBadArgs, err) } - lg := logger.NewDiscardLogger() + lg := logutil.NewDiscardLogger() debug, err := cmd.Flags().GetBool("debug") if err != nil { ExitWithError(ExitError, err) } if debug { - lg = logger.NewPackageLogger("github.com/coreos/etcd", "snapshot") + lg = logutil.NewPackageLogger("github.com/coreos/etcd", "snapshot") } sp := snapshot.NewV3(mustClientFromCmd(cmd), lg) @@ -120,13 +120,13 @@ func snapshotStatusCommandFunc(cmd *cobra.Command, args []string) { } initDisplayFromCmd(cmd) - lg := logger.NewDiscardLogger() + lg := logutil.NewDiscardLogger() debug, err := cmd.Flags().GetBool("debug") if err != nil { ExitWithError(ExitError, err) } if debug { - lg = logger.NewPackageLogger("github.com/coreos/etcd", "snapshot") + lg = logutil.NewPackageLogger("github.com/coreos/etcd", "snapshot") } sp := snapshot.NewV3(nil, lg) @@ -158,13 +158,13 @@ func snapshotRestoreCommandFunc(cmd *cobra.Command, args []string) { walDir = filepath.Join(dataDir, "member", "wal") } - lg := logger.NewDiscardLogger() + lg := logutil.NewDiscardLogger() debug, err := cmd.Flags().GetBool("debug") if err != nil { ExitWithError(ExitError, err) } if debug { - lg = logger.NewPackageLogger("github.com/coreos/etcd", "snapshot") + lg = logutil.NewPackageLogger("github.com/coreos/etcd", "snapshot") } sp := snapshot.NewV3(nil, lg) diff --git a/snapshot/v3_snapshot.go b/snapshot/v3_snapshot.go index a410a4453..895a16a00 100644 --- a/snapshot/v3_snapshot.go +++ b/snapshot/v3_snapshot.go @@ -35,7 +35,7 @@ import ( "github.com/coreos/etcd/mvcc" "github.com/coreos/etcd/mvcc/backend" "github.com/coreos/etcd/pkg/fileutil" - "github.com/coreos/etcd/pkg/logger" + "github.com/coreos/etcd/pkg/logutil" "github.com/coreos/etcd/pkg/types" "github.com/coreos/etcd/raft" "github.com/coreos/etcd/raft/raftpb" @@ -97,9 +97,9 @@ type RestoreConfig struct { // NewV3 returns a new snapshot Manager for v3.x snapshot. // "*clientv3.Client" is only used for "Save" method. // Otherwise, pass "nil". -func NewV3(cli *clientv3.Client, lg logger.Logger) Manager { +func NewV3(cli *clientv3.Client, lg logutil.Logger) Manager { if lg == nil { - lg = logger.NewDiscardLogger() + lg = logutil.NewDiscardLogger() } return &v3Manager{cli: cli, logger: lg} } @@ -114,7 +114,7 @@ type v3Manager struct { cl *membership.RaftCluster skipHashCheck bool - logger logger.Logger + logger logutil.Logger } func (s *v3Manager) Save(ctx context.Context, dbPath string) error { diff --git a/snapshot/v3_snapshot_test.go b/snapshot/v3_snapshot_test.go index d8edb0faf..c90988bac 100644 --- a/snapshot/v3_snapshot_test.go +++ b/snapshot/v3_snapshot_test.go @@ -26,7 +26,7 @@ import ( "github.com/coreos/etcd/clientv3" "github.com/coreos/etcd/embed" - "github.com/coreos/etcd/pkg/logger" + "github.com/coreos/etcd/pkg/logutil" "github.com/coreos/etcd/pkg/testutil" "github.com/coreos/etcd/pkg/types" ) @@ -51,7 +51,7 @@ func TestSnapshotV3RestoreSingle(t *testing.T) { cfg.InitialCluster = fmt.Sprintf("%s=%s", cfg.Name, pURLs[0].String()) cfg.Dir = filepath.Join(os.TempDir(), fmt.Sprint(time.Now().Nanosecond())) - sp := NewV3(nil, logger.NewPackageLogger("github.com/coreos/etcd", "snapshot")) + sp := NewV3(nil, logutil.NewPackageLogger("github.com/coreos/etcd", "snapshot")) err := sp.Restore(dbPath, RestoreConfig{}) if err.Error() != `couldn't find local name "" in the initial cluster configuration` { @@ -188,7 +188,7 @@ func createSnapshotFile(t *testing.T, kvs []kv) string { } } - sp := NewV3(cli, logger.NewPackageLogger("github.com/coreos/etcd", "snapshot")) + sp := NewV3(cli, logutil.NewPackageLogger("github.com/coreos/etcd", "snapshot")) dpPath := filepath.Join(os.TempDir(), fmt.Sprintf("snapshot%d.db", time.Now().Nanosecond())) if err = sp.Save(context.Background(), dpPath); err != nil { t.Fatal(err) @@ -229,7 +229,7 @@ func restoreCluster(t *testing.T, clusterN int, dbPath string) ( cfg.InitialCluster = ics cfg.Dir = filepath.Join(os.TempDir(), fmt.Sprint(time.Now().Nanosecond()+i)) - sp := NewV3(nil, logger.NewPackageLogger("github.com/coreos/etcd", "snapshot")) + sp := NewV3(nil, logutil.NewPackageLogger("github.com/coreos/etcd", "snapshot")) if err := sp.Restore(dbPath, RestoreConfig{ Name: cfg.Name, OutputDataDir: cfg.Dir,