Introduce levellogging for retryablehttp so logging can be controller a lot better

Author: davidcollom

pkg/client/docker/docker.go

@@ -17,6 +17,7 @@ import (
 	retryablehttp "github.com/hashicorp/go-retryablehttp"
 	"github.com/jetstack/version-checker/pkg/api"
 	"github.com/jetstack/version-checker/pkg/client/util"
+	leveledlogger "github.com/jetstack/version-checker/pkg/leveledlogrus"
 )
 
 // Ensure that we are an ImageClient
@@ -69,7 +70,7 @@ func New(opts Options, log *logrus.Entry) (*Client, error) {
 	retryclient.RetryWaitMin = 1 * time.Second
 	// This custom backoff will fail requests that have a max wait of the RetryWaitMax
 	retryclient.Backoff = util.HTTPBackOff
-	retryclient.Logger = log.WithField("client", "docker")
+	retryclient.Logger = leveledlogger.Logger{Entry: log.WithField("client", "docker")}
 	client := retryclient.StandardClient()
 
 	// Setup Auth if username and password used.

pkg/client/quay/quay.go

@@ -12,6 +12,7 @@ import (
 
 	"github.com/jetstack/version-checker/pkg/api"
 	"github.com/jetstack/version-checker/pkg/client/util"
+	leveledlogger "github.com/jetstack/version-checker/pkg/leveledlogrus"
 )
 
 const (
@@ -39,6 +40,7 @@ func New(opts Options, log *logrus.Entry) *Client {
 	if opts.Transporter != nil {
 		client.HTTPClient.Transport = opts.Transporter
 	}
+	client.Logger = leveledlogger.Logger{Entry: log.WithField("client", "quay")}
 
 	return &Client{
 		Options: opts,

pkg/controller/kube_controller.go

@@ -16,6 +16,7 @@ import (
 	"k8s.io/client-go/rest"
 
 	"github.com/hashicorp/go-retryablehttp"
+	leveledlogger "github.com/jetstack/version-checker/pkg/leveledlogrus"
 	"github.com/jetstack/version-checker/pkg/metrics"
 	"github.com/jetstack/version-checker/pkg/version/semver"
 )
@@ -24,7 +25,7 @@ const channelURLSuffix = "https://dl.k8s.io/release/"
 
 type ClusterVersionScheduler struct {
 	client   kubernetes.Interface
-	http     http.Client
+	http     *http.Client
 	log      *logrus.Entry
 	metrics  *metrics.Metrics
 	interval time.Duration
@@ -49,12 +50,12 @@ func NewKubeReconciler(
 	httpClient.RetryMax = 3
 	httpClient.RetryWaitMin = 1 * time.Second
 	httpClient.RetryWaitMax = 30 * time.Second
-	httpClient.Logger = log
+	httpClient.Logger = retryablehttp.LeveledLogger(&leveledlogger.Logger{Entry: log})
 
 	return &ClusterVersionScheduler{
 		log:      log.WithField("channel", channel),
 		client:   kubernetes.NewForConfigOrDie(config),
-		http:     *httpClient.StandardClient(),
+		http:     httpClient.StandardClient(),
 		interval: interval,
 		metrics:  metrics,
 		channel:  channel,

pkg/leveledlogrus/logger.go

@@ -0,0 +1,54 @@
+// Creates a leveled logger compatible with hashicorp/go-retryablehttp
+package leveledlogger
+
+import "github.com/sirupsen/logrus"
+
+type Logger struct {
+	*logrus.Entry
+}
+
+func (l *Logger) Error(msg string, keysAndValues ...interface{}) {
+	l.fields(keysAndValues).Error(msg)
+}
+
+func (l *Logger) Info(msg string, keysAndValues ...interface{}) {
+	l.fields(keysAndValues).Info(msg)
+}
+func (l *Logger) Debug(msg string, keysAndValues ...interface{}) {
+	l.fields(keysAndValues).Debug(msg)
+}
+
+func (l *Logger) Warn(msg string, keysAndValues ...interface{}) {
+	l.fields(keysAndValues).Warn(msg)
+}
+
+func (l *Logger) fields(keysAndValues []interface{}) *logrus.Entry {
+	if len(keysAndValues) == 0 {
+		return l.Entry
+	}
+
+	fields := make(map[string]interface{}, len(keysAndValues)/2)
+
+	for i := 0; i < len(keysAndValues)-1; i += 2 {
+		key, ok := keysAndValues[i].(string)
+		if !ok {
+			// Skip invalid key-value pairs
+			continue
+		}
+		fields[key] = keysAndValues[i+1]
+	}
+
+	// Handle odd number of elements - log the trailing key without a value
+	if len(keysAndValues)%2 != 0 {
+		key, ok := keysAndValues[len(keysAndValues)-1].(string)
+		if ok {
+			fields[key] = "(MISSING)"
+		}
+	}
+
+	if len(fields) == 0 {
+		return l.Entry
+	}
+
+	return l.WithFields(fields)
+}