Update to use sirupsen/logrus

This new model forces vendor go files to use `sirupsen/logrus` instead
of `Sirupsen/logrus` by running the new script
`hack/force-github.com-sirupsen-logrus.sh`.

This change also removes the use of dlog and updates to the latest
logrus.

Signed-off-by: Luis Pabón <[email protected]>

Author: lpabon

STYLEGUIDE.md

@@ -20,7 +20,7 @@ IF YOU CODE ON OPENSTORAGE, YOU ARE EXPECTED TO KNOW THIS. Just take the 20 minu
 
 ### Items
 
-* Use [dlog](https://go.pedge.io/dlog) for logging.
+* Use [logrus](https://github.com/sirupsen/logrus) for logging.
 
 * File order:
 

alert/alert_kvdb.go

@@ -3,14 +3,15 @@ package alert
 import (
 	"encoding/json"
 	"fmt"
-	"github.com/libopenstorage/openstorage/api"
-	"github.com/libopenstorage/openstorage/pkg/proto/time"
-	"github.com/portworx/kvdb"
-	"go.pedge.io/dlog"
 	"strconv"
 	"strings"
 	"sync"
 	"time"
+
+	"github.com/libopenstorage/openstorage/api"
+	"github.com/libopenstorage/openstorage/pkg/proto/time"
+	"github.com/portworx/kvdb"
+	"github.com/sirupsen/logrus"
 )
 
 const (
@@ -285,15 +286,15 @@ func (kva *KvAlert) raiseIfNotExist(a *api.Alert) error {
 	// is able to proceed.
 	kvp, err := kv.Lock(getLockId(a.ResourceId, a.UniqueTag))
 	if err != nil {
-		dlog.Errorf("Failed to get lock for resource %s, err: %s",
+		logrus.Errorf("Failed to get lock for resource %s, err: %s",
 			a.ResourceId, err.Error())
 		return err
 	}
 	defer kv.Unlock(kvp)
 
 	alerts, err := kva.getResourceSpecificAlerts(a.Resource, kv)
 	if err != nil {
-		dlog.Infof("Failed to get alerts of type %s, error: %s",
+		logrus.Infof("Failed to get alerts of type %s, error: %s",
 			a.Resource, err.Error())
 		return err
 	}
@@ -324,15 +325,15 @@ func (kva *KvAlert) ClearByUniqueTag(
 
 	kvp, err := kv.Lock(getLockId(resourceId, uniqueTag))
 	if err != nil {
-		dlog.Errorf("Failed to get lock for resource %s, err: %s",
+		logrus.Errorf("Failed to get lock for resource %s, err: %s",
 			resourceId, err.Error())
 		return err
 	}
 	defer kv.Unlock(kvp)
 
 	alerts, err := kva.getResourceSpecificAlerts(resourceType, kv)
 	if err != nil {
-		dlog.Infof("Failed to get alerts of type %s, error: %s",
+		logrus.Infof("Failed to get alerts of type %s, error: %s",
 			resourceType, err.Error())
 		return err
 	}
@@ -469,18 +470,18 @@ func (kva *KvAlert) getKvdbForCluster(clusterID string) (kvdb.Kvdb, error) {
 }
 
 func processWatchError(err error, watcherKey string, prefix string) error {
-	dlog.Errorf("Alert Watch error for key %v: %v", watcherKey, err)
+	logrus.Errorf("Alert Watch error for key %v: %v", watcherKey, err)
 	w := watcherMap[watcherKey]
 	w.status = watchError
 	if w.watchErrors == 5 {
-		dlog.Warnf("Too many watch errors for key (%v). Error: %s. Stopping the watch!!", watcherKey, err.Error())
+		logrus.Warnf("Too many watch errors for key (%v). Error: %s. Stopping the watch!!", watcherKey, err.Error())
 		w.cb(nil, api.AlertActionType_ALERT_ACTION_TYPE_NONE, prefix, "")
 		// Too many watch errors. Stop the watch
 		return err
 	}
 	w.watchErrors++
 	if err := subscribeWatch(watcherKey); err != nil {
-		dlog.Warnf("Failed to resubscribe alert watch for key: %s: %s", watcherKey, err.Error())
+		logrus.Warnf("Failed to resubscribe alert watch for key: %s: %s", watcherKey, err.Error())
 	}
 	return err
 }

alert/alert_kvdb_test.go

@@ -10,8 +10,8 @@ import (
 	"github.com/libopenstorage/openstorage/pkg/proto/time"
 	"github.com/portworx/kvdb"
 	"github.com/portworx/kvdb/mem"
+	"github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/require"
-	"go.pedge.io/dlog"
 )
 
 var (
@@ -45,7 +45,7 @@ func TestAll(t *testing.T) {
 func setup(t *testing.T) {
 	kv := kvdb.Instance()
 	if kv == nil {
-		kv, err := kvdb.New(mem.Name, kvdbDomain+"/"+clusterName, []string{}, nil, dlog.Panicf)
+		kv, err := kvdb.New(mem.Name, kvdbDomain+"/"+clusterName, []string{}, nil, logrus.Panicf)
 		if err != nil {
 			t.Fatalf("Failed to set default KV store : (%v): %v", mem.Name, err)
 		}

api/flexvolume/flexvolume.go

@@ -13,7 +13,7 @@ import (
 	"github.com/libopenstorage/openstorage/volume"
 	"github.com/libopenstorage/openstorage/volume/drivers"
 
-	"go.pedge.io/dlog"
+	"github.com/sirupsen/logrus"
 )
 
 const (
@@ -63,7 +63,7 @@ func (c *flexVolumeClient) Attach(jsonOptions map[string]string) error {
 func (c *flexVolumeClient) Detach(mountDevice string, options map[string]string) error {
 	driverName, ok := deviceDriverMap[mountDevice]
 	if !ok {
-		dlog.Infof("Could not find driver for (%v). Resorting to default driver ", mountDevice)
+		logrus.Infof("Could not find driver for (%v). Resorting to default driver ", mountDevice)
 		driverName = c.defaultDriver
 	}
 	driver, err := c.getVolumeDriver(driverName)
@@ -96,7 +96,7 @@ func (c *flexVolumeClient) Mount(targetMountDir string, mountDevice string,
 	// Update the deviceDriverMap
 	mountManager, err := mount.New(mount.DeviceMount, nil, []string{""}, nil, []string{}, "")
 	if err != nil {
-		dlog.Infof("Could not read mountpoints from /proc/self/mountinfo. Device - Driver mapping not saved!")
+		logrus.Infof("Could not read mountpoints from /proc/self/mountinfo. Device - Driver mapping not saved!")
 		return nil
 	}
 	sourcePath, err := mountManager.GetSourcePath(targetMountDir)
@@ -119,7 +119,7 @@ func (c *flexVolumeClient) Unmount(mountDir string, options map[string]string) e
 	}
 	driverName, ok := deviceDriverMap[mountDevice]
 	if !ok {
-		dlog.Infof("Could not find driver for (%v). Resorting to default driver. ", mountDevice)
+		logrus.Infof("Could not find driver for (%v). Resorting to default driver. ", mountDevice)
 		driverName = c.defaultDriver
 	}
 	driver, err := c.getVolumeDriver(driverName)
@@ -152,7 +152,7 @@ func StartFlexVolumeAPI(port uint16, defaultDriver string) error {
 	}
 	go func() {
 		if err := grpcServer.Serve(listener); err != nil {
-			dlog.Errorln(err.Error())
+			logrus.Errorln(err.Error())
 		}
 	}()
 	return nil

api/server/server.go

@@ -7,7 +7,7 @@ import (
 	"os"
 	"path"
 
-	"go.pedge.io/dlog"
+	"github.com/sirupsen/logrus"
 
 	"github.com/gorilla/mux"
 )
@@ -141,15 +141,15 @@ func startServer(name string, sockBase string, port uint16, routes []*Route) err
 	os.Remove(socket)
 	os.MkdirAll(path.Dir(socket), 0755)
 
-	dlog.Printf("Starting REST service on socket : %+v", socket)
+	logrus.Printf("Starting REST service on socket : %+v", socket)
 	listener, err = net.Listen("unix", socket)
 	if err != nil {
-		dlog.Warnln("Cannot listen on UNIX socket: ", err)
+		logrus.Warnln("Cannot listen on UNIX socket: ", err)
 		return err
 	}
 	go http.Serve(listener, router)
 	if port != 0 {
-		dlog.Printf("Starting REST service on port : %v", port)
+		logrus.Printf("Starting REST service on port : %v", port)
 		go http.ListenAndServe(fmt.Sprintf(":%d", port), router)
 	}
 	return nil
@@ -158,7 +158,7 @@ func startServer(name string, sockBase string, port uint16, routes []*Route) err
 type restServer interface {
 	Routes() []*Route
 	String() string
-	logRequest(request string, id string) dlog.Logger
+	logRequest(request string, id string) *logrus.Entry
 	sendError(request string, id string, w http.ResponseWriter, msg string, code int)
 }
 
@@ -168,8 +168,8 @@ type restBase struct {
 	name    string
 }
 
-func (rest *restBase) logRequest(request string, id string) dlog.Logger {
-	return dlog.WithFields(map[string]interface{}{
+func (rest *restBase) logRequest(request string, id string) *logrus.Entry {
+	return logrus.WithFields(map[string]interface{}{
 		"Driver":  rest.name,
 		"Request": request,
 		"ID":      id,
@@ -181,6 +181,6 @@ func (rest *restBase) sendError(request string, id string, w http.ResponseWriter
 }
 
 func notFound(w http.ResponseWriter, r *http.Request) {
-	dlog.Warnf("Not found: %+v ", r.URL)
+	logrus.Warnf("Not found: %+v ", r.URL)
 	http.NotFound(w, r)
 }

api/testing/testing_test.go

@@ -5,7 +5,7 @@ import (
 	"testing"
 	"time"
 
-	"go.pedge.io/dlog"
+	"github.com/sirupsen/logrus"
 
 	"github.com/libopenstorage/openstorage/api"
 	volumeclient "github.com/libopenstorage/openstorage/api/client/volume"
@@ -21,7 +21,7 @@ var (
 )
 
 func init() {
-	dlog.SetLevel(dlog.LevelDebug)
+	logrus.SetLevel(logrus.DebugLevel)
 }
 
 func makeRequest(t *testing.T) {

cluster/database.go

@@ -5,7 +5,7 @@ import (
 	"encoding/json"
 	"strings"
 
-	"go.pedge.io/dlog"
+	"github.com/sirupsen/logrus"
 
 	"github.com/libopenstorage/openstorage/api"
 	"github.com/portworx/kvdb"
@@ -28,19 +28,19 @@ func snapAndReadClusterInfo() (*ClusterInitState, error) {
 	)
 	for i := 0; i < 3; i++ {
 		if i > 0 {
-			dlog.Infof("Retrying snapshot")
+			logrus.Infof("Retrying snapshot")
 		}
 		// Start the watch before the snapshot
 		collector, err = kvdb.NewUpdatesCollector(kv, "", 0)
 		if err != nil {
-			dlog.Errorf("Failed to start collector for cluster db: %v", err)
+			logrus.Errorf("Failed to start collector for cluster db: %v", err)
 			collector = nil
 			continue
 		}
 		// Create the snapshot
 		snap, version, err = kv.Snapshot("")
 		if err != nil {
-			dlog.Errorf("Snapshot failed for cluster db: %v", err)
+			logrus.Errorf("Snapshot failed for cluster db: %v", err)
 			collector.Stop()
 			collector = nil
 		} else {
@@ -50,11 +50,11 @@ func snapAndReadClusterInfo() (*ClusterInitState, error) {
 	if err != nil {
 		return nil, err
 	}
-	dlog.Infof("Cluster db snapshot at: %v", version)
+	logrus.Infof("Cluster db snapshot at: %v", version)
 
 	clusterDB, err := snap.Get(ClusterDBKey)
 	if err != nil && !strings.Contains(err.Error(), "Key not found") {
-		dlog.Warnln("Warning, could not read cluster database")
+		logrus.Warnln("Warning, could not read cluster database")
 		return nil, err
 	}
 
@@ -70,11 +70,11 @@ func snapAndReadClusterInfo() (*ClusterInitState, error) {
 	}
 
 	if clusterDB == nil || bytes.Compare(clusterDB.Value, []byte("{}")) == 0 {
-		dlog.Infoln("Cluster is uninitialized...")
+		logrus.Infoln("Cluster is uninitialized...")
 		return state, nil
 	}
 	if err := json.Unmarshal(clusterDB.Value, &db); err != nil {
-		dlog.Warnln("Fatal, Could not parse cluster database ", kv)
+		logrus.Warnln("Fatal, Could not parse cluster database ", kv)
 		return state, err
 	}
 
@@ -91,16 +91,16 @@ func readClusterInfo() (ClusterInfo, uint64, error) {
 	kv, err := kvdb.Get(ClusterDBKey)
 
 	if err != nil && !strings.Contains(err.Error(), "Key not found") {
-		dlog.Warnln("Warning, could not read cluster database")
+		logrus.Warnln("Warning, could not read cluster database")
 		return db, 0, err
 	}
 
 	if kv == nil || bytes.Compare(kv.Value, []byte("{}")) == 0 {
-		dlog.Infoln("Cluster is uninitialized...")
+		logrus.Infoln("Cluster is uninitialized...")
 		return db, 0, nil
 	}
 	if err := json.Unmarshal(kv.Value, &db); err != nil {
-		dlog.Warnln("Fatal, Could not parse cluster database ", kv)
+		logrus.Warnln("Fatal, Could not parse cluster database ", kv)
 		return db, 0, err
 	}
 
@@ -111,13 +111,13 @@ func writeClusterInfo(db *ClusterInfo) (*kvdb.KVPair, error) {
 	kvdb := kvdb.Instance()
 	b, err := json.Marshal(db)
 	if err != nil {
-		dlog.Warnf("Fatal, Could not marshal cluster database to JSON: %v", err)
+		logrus.Warnf("Fatal, Could not marshal cluster database to JSON: %v", err)
 		return nil, err
 	}
 
 	kvp, err := kvdb.Put(ClusterDBKey, b, 0)
 	if err != nil {
-		dlog.Warnf("Fatal, Could not marshal cluster database to JSON: %v", err)
+		logrus.Warnf("Fatal, Could not marshal cluster database to JSON: %v", err)
 		return nil, err
 	}
 	return kvp, nil