feat(logger): add logger option to all micro components (override DefaultLogger) closes #2556 (#2559)

* feat(logger): add logger option to all components

* fix: refactor api/rpc.go

* fix: refactor api/stream.go

* fix: api/options.go comment

* fix(logger): do not use logger.Helper internally

* fix(logger): fix comments

* fix(logger): use level.Enabled method

* fix: rename mlogger to log

* fix: run go fmt

* fix: log level

* fix: factories

Co-authored-by: Mohamed MHAMDI <mmhamdi@hubside.com>
Co-authored-by: Davincible <david.brouwer.99@gmail.com>

util/file/client.go

@@ -3,13 +3,12 @@ package file
 import (
 	"bufio"
 	"context"
-	"errors"
 	"fmt"
 	"io"
-	"log"
 	"os"
 
 	"go-micro.dev/v4/client"
+	"go-micro.dev/v4/logger"
 	proto "go-micro.dev/v4/util/file/proto"
 )
 
@@ -145,7 +144,7 @@ func (c *fc) DownloadAt(filename, saveFile string, blockId int) error {
 		return err
 	}
 	if stat.Type == "Directory" {
-		return errors.New(fmt.Sprintf("%s is directory.", filename))
+		return fmt.Errorf("%s is directory", filename)
 	}
 
 	blocks := int(stat.Size / blockSize)
@@ -153,7 +152,7 @@ func (c *fc) DownloadAt(filename, saveFile string, blockId int) error {
 		blocks += 1
 	}
 
-	log.Printf("Download %s in %d blocks\n", filename, blocks-blockId)
+	logger.Logf(logger.InfoLevel, "Download %s in %d blocks\n", filename, blocks-blockId)
 
 	file, err := os.OpenFile(saveFile, os.O_CREATE|os.O_WRONLY, 0666)
 	if err != nil {
@@ -176,14 +175,14 @@ func (c *fc) DownloadAt(filename, saveFile string, blockId int) error {
 		}
 
 		if i%((blocks-blockId)/100+1) == 0 {
-			log.Printf("Downloading %s [%d/%d] blocks", filename, i-blockId+1, blocks-blockId)
+			logger.Logf(logger.InfoLevel, "Downloading %s [%d/%d] blocks", filename, i-blockId+1, blocks-blockId)
 		}
 
 		if rerr == io.EOF {
 			break
 		}
 	}
-	log.Printf("Download %s completed", filename)
+	logger.Logf(logger.InfoLevel, "Download %s completed", filename)
 
 	c.Close(sessionId)
 

util/file/handler.go

@@ -6,11 +6,12 @@ import (
 	"path/filepath"
 	"sync"
 
+	"golang.org/x/net/context"
+
 	"go-micro.dev/v4/errors"
-	"go-micro.dev/v4/logger"
+	log "go-micro.dev/v4/logger"
 	"go-micro.dev/v4/server"
 	proto "go-micro.dev/v4/util/file/proto"
-	"golang.org/x/net/context"
 )
 
 // NewHandler is a handler that can be registered with a micro Server
@@ -20,6 +21,7 @@ func NewHandler(readDir string) proto.FileHandler {
 		session: &session{
 			files: make(map[int64]*os.File),
 		},
+		logger: log.DefaultLogger,
 	}
 }
 
@@ -31,6 +33,7 @@ func RegisterHandler(s server.Server, readDir string) {
 type handler struct {
 	readDir string
 	session *session
+	logger  log.Logger
 }
 
 func (h *handler) Open(ctx context.Context, req *proto.OpenRequest, rsp *proto.OpenResponse) error {
@@ -47,14 +50,14 @@ func (h *handler) Open(ctx context.Context, req *proto.OpenRequest, rsp *proto.O
 	rsp.Id = h.session.Add(file)
 	rsp.Result = true
 
-	logger.Debugf("Open %s, sessionId=%d", req.Filename, rsp.Id)
+	h.logger.Logf(log.DebugLevel, "Open %s, sessionId=%d", req.Filename, rsp.Id)
 
 	return nil
 }
 
 func (h *handler) Close(ctx context.Context, req *proto.CloseRequest, rsp *proto.CloseResponse) error {
 	h.session.Delete(req.Id)
-	logger.Debugf("Close sessionId=%d", req.Id)
+	h.logger.Logf(log.DebugLevel, "Close sessionId=%d", req.Id)
 	return nil
 }
 
@@ -73,7 +76,7 @@ func (h *handler) Stat(ctx context.Context, req *proto.StatRequest, rsp *proto.S
 	}
 
 	rsp.LastModified = fi.ModTime().Unix()
-	logger.Debugf("Stat %s, %#v", req.Filename, rsp)
+	h.logger.Logf(log.DebugLevel, "Stat %s, %#v", req.Filename, rsp)
 
 	return nil
 }
@@ -97,7 +100,7 @@ func (h *handler) Read(ctx context.Context, req *proto.ReadRequest, rsp *proto.R
 	rsp.Size = int64(n)
 	rsp.Data = rsp.Data[:n]
 
-	logger.Debugf("Read sessionId=%d, Offset=%d, n=%d", req.Id, req.Offset, rsp.Size)
+	h.logger.Logf(log.DebugLevel, "Read sessionId=%d, Offset=%d, n=%d", req.Id, req.Offset, rsp.Size)
 
 	return nil
 }
@@ -112,7 +115,7 @@ func (h *handler) Write(ctx context.Context, req *proto.WriteRequest, rsp *proto
 		return err
 	}
 
-	logger.Debugf("Write sessionId=%d, Offset=%d, n=%d", req.Id, req.Offset)
+	h.logger.Logf(log.DebugLevel, "Write sessionId=%d, Offset=%d, n=%d", req.Id, req.Offset)
 
 	return nil
 }

util/http/http.go

@@ -4,10 +4,10 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"log"
 	"net/http"
 	"strings"
 
+	"go-micro.dev/v4/logger"
 	"go-micro.dev/v4/metadata"
 	"go-micro.dev/v4/registry"
 	"go-micro.dev/v4/selector"
@@ -39,7 +39,7 @@ func WriteInternalServerError(w http.ResponseWriter, err error) {
 		"error": err.Error(),
 	})
 	if err != nil {
-		log.Println(err)
+		logger.Log(logger.ErrorLevel, err)
 		return
 	}
 	Write(w, "application/json", 500, string(rawBody))

util/kubernetes/client/client.go

@@ -20,7 +20,7 @@ var (
 	// path to kubernetes service account token
 	serviceAccountPath = "/var/run/secrets/kubernetes.io/serviceaccount"
 	// ErrReadNamespace is returned when the names could not be read from service account
-	ErrReadNamespace = errors.New("Could not read namespace from service account secret")
+	ErrReadNamespace = errors.New("could not read namespace from service account secret")
 	// DefaultImage is default micro image
 	DefaultImage = "micro/go-micro"
 	// DefaultNamespace is the default k8s namespace
@@ -228,7 +228,7 @@ func (c *client) Watch(r *Resource, opts ...WatchOption) (Watcher, error) {
 // NewService returns default micro kubernetes service definition
 func NewService(name, version, typ, namespace string) *Service {
 	if logger.V(logger.TraceLevel, logger.DefaultLogger) {
-		logger.Tracef("kubernetes default service: name: %s, version: %s", name, version)
+		logger.Logf(logger.TraceLevel, "kubernetes default service: name: %s, version: %s", name, version)
 	}
 
 	Labels := map[string]string{
@@ -271,7 +271,7 @@ func NewService(name, version, typ, namespace string) *Service {
 // NewService returns default micro kubernetes deployment definition
 func NewDeployment(name, version, typ, namespace string) *Deployment {
 	if logger.V(logger.TraceLevel, logger.DefaultLogger) {
-		logger.Tracef("kubernetes default deployment: name: %s, version: %s", name, version)
+		logger.Logf(logger.TraceLevel, "kubernetes default deployment: name: %s, version: %s", name, version)
 	}
 
 	Labels := map[string]string{

util/mdns/client.go

@@ -3,7 +3,6 @@ package mdns
 import (
 	"context"
 	"fmt"
-	"log"
 	"net"
 	"strings"
 	"sync"
@@ -12,6 +11,8 @@ import (
 	"github.com/miekg/dns"
 	"golang.org/x/net/ipv4"
 	"golang.org/x/net/ipv6"
+
+	"go-micro.dev/v4/logger"
 )
 
 // ServiceEntry is returned after we query for a service
@@ -146,7 +147,7 @@ func Listen(entries chan<- *ServiceEntry, exit chan struct{}) error {
 				m.SetQuestion(e.Name, dns.TypePTR)
 				m.RecursionDesired = false
 				if err := client.sendQuery(m); err != nil {
-					log.Printf("[ERR] mdns: Failed to query instance %s: %v", e.Name, err)
+					logger.Logf(logger.ErrorLevel, "[mdns] failed to query instance %s: %v", e.Name, err)
 				}
 			}
 		}
@@ -184,7 +185,7 @@ func newClient() (*client, error) {
 	uconn4, err4 := net.ListenUDP("udp4", &net.UDPAddr{IP: net.IPv4zero, Port: 0})
 	uconn6, err6 := net.ListenUDP("udp6", &net.UDPAddr{IP: net.IPv6zero, Port: 0})
 	if err4 != nil && err6 != nil {
-		log.Printf("[ERR] mdns: Failed to bind to udp port: %v %v", err4, err6)
+		logger.Logf(logger.ErrorLevel, "[mdns] failed to bind to udp port: %v %v", err4, err6)
 	}
 
 	if uconn4 == nil && uconn6 == nil {
@@ -202,7 +203,7 @@ func newClient() (*client, error) {
 	mconn4, err4 := net.ListenUDP("udp4", mdnsWildcardAddrIPv4)
 	mconn6, err6 := net.ListenUDP("udp6", mdnsWildcardAddrIPv6)
 	if err4 != nil && err6 != nil {
-		log.Printf("[ERR] mdns: Failed to bind to udp port: %v %v", err4, err6)
+		logger.Logf(logger.ErrorLevel, "[mdns] failed to bind to udp port: %v %v", err4, err6)
 	}
 
 	if mconn4 == nil && mconn6 == nil {
@@ -239,7 +240,7 @@ func newClient() (*client, error) {
 	}
 
 	if len(ifaces) == errCount1 && len(ifaces) == errCount2 {
-		return nil, fmt.Errorf("Failed to join multicast group on all interfaces!")
+		return nil, fmt.Errorf("failed to join multicast group on all interfaces")
 	}
 
 	c := &client{
@@ -375,7 +376,7 @@ func (c *client) query(params *QueryParam) error {
 				m.SetQuestion(inp.Name, inp.Type)
 				m.RecursionDesired = false
 				if err := c.sendQuery(m); err != nil {
-					log.Printf("[ERR] mdns: Failed to query instance %s: %v", inp.Name, err)
+					logger.Logf(logger.ErrorLevel, "[mdns] failed to query instance %s: %v", inp.Name, err)
 				}
 			}
 		case <-params.Context.Done():

util/mdns/dns_sd.go

@@ -10,18 +10,19 @@ import "github.com/miekg/dns"
 // register only the wrapped instance with the server.
 //
 // Example usage:
-//     service := &mdns.DNSSDService{
-//       MDNSService: &mdns.MDNSService{
-// 	       Instance: "My Foobar Service",
-// 	       Service: "_foobar._tcp",
-// 	       Port:    8000,
-//        }
-//      }
-//      server, err := mdns.NewServer(&mdns.Config{Zone: service})
-//      if err != nil {
-//        log.Fatalf("Error creating server: %v", err)
-//      }
-//      defer server.Shutdown()
+//
+//	    service := &mdns.DNSSDService{
+//	      MDNSService: &mdns.MDNSService{
+//		       Instance: "My Foobar Service",
+//		       Service: "_foobar._tcp",
+//		       Port:    8000,
+//	       }
+//	     }
+//	     server, err := mdns.NewServer(&mdns.Config{Zone: service})
+//	     if err != nil {
+//	       log.Fatalf("Error creating server: %v", err)
+//	     }
+//	     defer server.Shutdown()
 type DNSSDService struct {
 	MDNSService *MDNSService
 }

util/qson/qson.go

@@ -45,10 +45,13 @@ func Unmarshal(dst interface{}, query string) error {
 }
 
 // ToJSON will turn a query string like:
-//   cat=1&bar%5Bone%5D%5Btwo%5D=2&bar[one][red]=112
+//
+//	cat=1&bar%5Bone%5D%5Btwo%5D=2&bar[one][red]=112
+//
 // Into a JSON object with all the data merged as nicely as
 // possible. Eg the example above would output:
-//   {"bar":{"one":{"two":2,"red":112}}}
+//
+//	{"bar":{"one":{"two":2,"red":112}}}
 func ToJSON(query string) ([]byte, error) {
 	var (
 		builder interface{} = make(map[string]interface{})
@@ -65,13 +68,14 @@ func ToJSON(query string) ([]byte, error) {
 }
 
 // queryToMap turns something like a[b][c]=4 into
-//   map[string]interface{}{
-//     "a": map[string]interface{}{
-// 		  "b": map[string]interface{}{
-// 			  "c": 4,
-// 		  },
-// 	  },
-//   }
+//
+//	  map[string]interface{}{
+//	    "a": map[string]interface{}{
+//			  "b": map[string]interface{}{
+//				  "c": 4,
+//			  },
+//		  },
+//	  }
 func queryToMap(param string) (map[string]interface{}, error) {
 	rawKey, rawValue, err := splitKeyAndValue(param)
 	if err != nil {