Centralized log names to simplify implementation of filtered loggers

Author: Peter Wilhelmsson

neo4j/consolelogger.go

@@ -20,9 +20,7 @@
 package neo4j
 
 import (
-	"fmt"
-	"os"
-	"time"
+	"github.com/neo4j/neo4j-go-driver/v4/neo4j/log"
 )
 
 // LogLevel is the type that default logging implementations use for available
@@ -40,63 +38,11 @@ const (
 	DEBUG = 4
 )
 
-func ConsoleLogger(level LogLevel) *ConsoleLog {
-	return &ConsoleLog{
+func ConsoleLogger(level LogLevel) *log.Console {
+	return &log.Console{
 		Errors: level >= ERROR,
 		Warns:  level >= WARNING,
 		Infos:  level >= INFO,
 		Debugs: level >= DEBUG,
 	}
 }
-
-// 2020-05-03 12:39:45.001  ERROR  [router 1] Failed to connect
-// 2020-05-03 12:39:45.001   INFO  [Server@192.168.0.1:666] Custom message
-// 2020-05-03 12:39:45.001   WARN  [bolt3 bolt-361@127.0.0.1:7687] Custom message
-type ConsoleLog struct {
-	Errors bool
-	Infos  bool
-	Warns  bool
-	Debugs bool
-}
-
-const timeFormat = "2006-01-02 15:04:05.000"
-
-func (l *ConsoleLog) Error(name, id string, err error) {
-	if !l.Errors {
-		return
-	}
-	now := time.Now()
-	fmt.Fprintf(os.Stderr, "%s  ERROR  [%s %s] %s\n", now.Format(timeFormat), name, id, err.Error())
-}
-
-func (l *ConsoleLog) Errorf(name, id string, msg string, args ...interface{}) {
-	if !l.Infos {
-		return
-	}
-	now := time.Now()
-	fmt.Fprintf(os.Stdout, "%s  ERROR  [%s %s] %s\n", now.Format(timeFormat), name, id, fmt.Sprintf(msg, args...))
-}
-
-func (l *ConsoleLog) Infof(name, id string, msg string, args ...interface{}) {
-	if !l.Infos {
-		return
-	}
-	now := time.Now()
-	fmt.Fprintf(os.Stdout, "%s   INFO  [%s %s] %s\n", now.Format(timeFormat), name, id, fmt.Sprintf(msg, args...))
-}
-
-func (l *ConsoleLog) Warnf(name, id string, msg string, args ...interface{}) {
-	if !l.Warns {
-		return
-	}
-	now := time.Now()
-	fmt.Fprintf(os.Stdout, "%s   WARN  [%s %s] %s\n", now.Format(timeFormat), name, id, fmt.Sprintf(msg, args...))
-}
-
-func (l *ConsoleLog) Debugf(name, id string, msg string, args ...interface{}) {
-	if !l.Debugs {
-		return
-	}
-	now := time.Now()
-	fmt.Fprintf(os.Stdout, "%s  DEBUG  [%s %s] %s\n", now.Format(timeFormat), name, id, fmt.Sprintf(msg, args...))
-}

neo4j/driver.go

@@ -23,10 +23,8 @@ package neo4j
 import (
 	"fmt"
 	"net/url"
-	"strconv"
 	"strings"
 	"sync"
-	"sync/atomic"
 
 	"github.com/neo4j/neo4j-go-driver/v4/neo4j/db"
 	"github.com/neo4j/neo4j-go-driver/v4/neo4j/log"
@@ -64,8 +62,6 @@ type Driver interface {
 	Close() error
 }
 
-var driverLogName = "driver"
-
 // NewDriver is the entry point to the neo4j driver to create an instance of a Driver. It is the first function to
 // be called in order to establish a connection to a neo4j database. It requires a Bolt URI and an authentication
 // token as parameters and can also take optional configuration function(s) as variadic parameters.
@@ -132,24 +128,25 @@ func NewDriver(target string, auth AuthToken, configurers ...func(*Config)) (Dri
 	d.log = d.config.Log
 	if d.log == nil {
 		// Default to void logger
-		d.log = &VoidLog{}
+		d.log = &log.Void{}
 	}
-	d.logId = strconv.FormatUint(uint64(atomic.AddUint32(&driverid, 1)), 10)
+	d.logId = log.NewId()
 
 	// Continue to setup connector
 	d.connector.UserAgent = d.config.UserAgent
 	d.connector.RootCAs = d.config.RootCAs
 	d.connector.Log = d.log
 	d.connector.Auth = auth.tokens
 
-	d.pool = pool.New(d.config.MaxConnectionPoolSize, d.config.MaxConnectionLifetime, d.connector.Connect, d.log)
+	// Let the pool use the same logid as the driver to simplify log reading.
+	d.pool = pool.New(d.config.MaxConnectionPoolSize, d.config.MaxConnectionLifetime, d.connector.Connect, d.log, d.logId)
 
 	if !routing {
 		d.router = &directRouter{server: parsed.Host}
 	} else {
 		routingContext, err := routingContextFromUrl(parsed)
 		if err != nil {
-			d.log.Error(driverLogName, d.logId, err)
+			d.log.Error(log.Driver, d.logId, err)
 			return nil, err
 		}
 
@@ -165,15 +162,14 @@ func NewDriver(target string, auth AuthToken, configurers ...func(*Config)) (Dri
 				return servers
 			}
 		}
-		d.router = router.New(parsed.Host, routersResolver, routingContext, d.pool, d.log)
+		// Let the router use the same logid as the driver to simplify log reading.
+		d.router = router.New(parsed.Host, routersResolver, routingContext, d.pool, d.log, d.logId)
 	}
 
-	d.log.Infof(driverLogName, d.logId, "Created { target: %s }", target)
+	d.log.Infof(log.Driver, d.logId, "Created { target: %s }", target)
 	return &d, nil
 }
 
-var driverid uint32
-
 func routingContextFromUrl(u *url.URL) (map[string]string, error) {
 	queryValues := u.Query()
 	routingContext := make(map[string]string, len(queryValues))
@@ -274,6 +270,6 @@ func (d *driver) Close() error {
 		d.pool.Close()
 	}
 	d.pool = nil
-	d.log.Infof(driverLogName, d.logId, "Closed")
+	d.log.Infof(log.Driver, d.logId, "Closed")
 	return nil
 }

neo4j/internal/bolt/bolt3.go

@@ -84,7 +84,6 @@ type bolt3 struct {
 	bookmark      string       // Last bookmark
 	birthDate     time.Time
 	log           log.Logger
-	logName       string
 	receiveBufer  []byte
 	sendBuffers   [][]byte
 }
@@ -101,7 +100,6 @@ func NewBolt3(serverName string, conn net.Conn, log log.Logger) *bolt3 {
 		unpacker:     &packstream.Unpacker{},
 		birthDate:    time.Now(),
 		log:          log,
-		logName:      "bolt3",
 	}
 }
 
@@ -122,7 +120,7 @@ func (b *bolt3) appendMsg(tag packstream.StructTag, field ...interface{}) error
 		// At this point we do not know the state of what has been written to the chunks.
 		// Either we should support rolling back whatever that has been written or just
 		// bail out this session.
-		b.log.Error(b.logName, b.logId, err)
+		b.log.Error(log.Bolt3, b.logId, err)
 		b.state = bolt3_dead
 		return err
 	}
@@ -135,7 +133,7 @@ func (b *bolt3) sendMsg(tag packstream.StructTag, field ...interface{}) error {
 		return err
 	}
 	if err := b.chunker.send(b.conn); err != nil {
-		b.log.Error(b.logName, b.logId, err)
+		b.log.Error(log.Bolt3, b.logId, err)
 		b.state = bolt3_dead
 		return err
 	}
@@ -146,14 +144,14 @@ func (b *bolt3) receiveMsg() (interface{}, error) {
 	var err error
 	b.receiveBufer, err = dechunkMessage(b.conn, b.receiveBufer)
 	if err != nil {
-		b.log.Error(b.logName, b.logId, err)
+		b.log.Error(log.Bolt3, b.logId, err)
 		b.state = bolt3_dead
 		return nil, err
 	}
 
 	msg, err := b.unpacker.UnpackStruct(b.receiveBufer, hydrate)
 	if err != nil {
-		b.log.Error(b.logName, b.logId, err)
+		b.log.Error(log.Bolt3, b.logId, err)
 		b.state = bolt3_dead
 		return nil, err
 	}
@@ -176,15 +174,15 @@ func (b *bolt3) receiveSuccess() (*successResponse, error) {
 		b.state = bolt3_failed
 		if v.Classification() == "ClientError" {
 			// These could include potentially large cypher statement, only log to debug
-			b.log.Debugf(b.logName, b.logId, "%s", v)
+			b.log.Debugf(log.Bolt3, b.logId, "%s", v)
 		} else {
-			b.log.Error(b.logName, b.logId, v)
+			b.log.Error(log.Bolt3, b.logId, v)
 		}
 		return nil, v
 	}
 	b.state = bolt3_dead
 	err = errors.New("Expected success or database error")
-	b.log.Error(b.logName, b.logId, err)
+	b.log.Error(log.Bolt3, b.logId, err)
 	return nil, err
 }
 
@@ -225,7 +223,7 @@ func (b *bolt3) connect(auth map[string]interface{}, userAgent string) error {
 
 	// Transition into ready state
 	b.state = bolt3_ready
-	b.log.Infof(b.logName, b.logId, "Connected")
+	b.log.Infof(log.Bolt3, b.logId, "Connected")
 	return nil
 }
 
@@ -307,7 +305,7 @@ func (b *bolt3) TxCommit(txh db.Handle) error {
 	if commitSuccess == nil {
 		b.state = bolt3_dead
 		err := errors.New(fmt.Sprintf("Failed to parse commit response: %+v", succRes))
-		b.log.Error(b.logName, b.logId, err)
+		b.log.Error(log.Bolt3, b.logId, err)
 		return err
 	}
 
@@ -430,7 +428,7 @@ func (b *bolt3) run(cypher string, params map[string]interface{}, tx *internalTx
 	if runRes == nil {
 		b.state = bolt3_dead
 		err = errors.New(fmt.Sprintf("Failed to parse RUN response: %+v", res))
-		b.log.Error(b.logName, b.logId, err)
+		b.log.Error(log.Bolt3, b.logId, err)
 		return nil, err
 	}
 	b.tfirst = runRes.t_first
@@ -448,11 +446,11 @@ func (b *bolt3) run(cypher string, params map[string]interface{}, tx *internalTx
 }
 
 func (b *bolt3) logError(err error) {
-	b.log.Error(b.logName, b.logId, err)
+	b.log.Error(log.Bolt3, b.logId, err)
 }
 
 func (b *bolt3) logDebug(err error) {
-	b.log.Debugf(b.logName, b.logId, "%s", err)
+	b.log.Debugf(log.Bolt3, b.logId, "%s", err)
 }
 
 func (b *bolt3) Run(
@@ -508,7 +506,7 @@ func (b *bolt3) Next(shandle db.Handle) (*db.Record, *db.Summary, error) {
 		if sum == nil {
 			b.state = bolt3_dead
 			err = errors.New("Failed to parse summary")
-			b.log.Error(b.logName, b.logId, err)
+			b.log.Error(log.Bolt3, b.logId, err)
 			return nil, nil, err
 		}
 		if b.state == bolt3_streamingtx {
@@ -530,15 +528,15 @@ func (b *bolt3) Next(shandle db.Handle) (*db.Record, *db.Summary, error) {
 		b.state = bolt3_failed
 		if x.Classification() == "ClientError" {
 			// These could include potentially large cypher statement, only log to debug
-			b.log.Debugf(b.logName, b.logId, "%s", x)
+			b.log.Debugf(log.Bolt3, b.logId, "%s", x)
 		} else {
-			b.log.Error(b.logName, b.logId, x)
+			b.log.Error(log.Bolt3, b.logId, x)
 		}
 		return nil, nil, x
 	default:
 		b.state = bolt3_dead
 		err = errors.New("Unknown response")
-		b.log.Error(b.logName, b.logId, err)
+		b.log.Error(log.Bolt3, b.logId, err)
 		return nil, nil, err
 	}
 }
@@ -645,7 +643,7 @@ func (b *bolt3) GetRoutingTable(database string, context map[string]string) (*db
 
 // Beware, could be called on another thread when driver is closed.
 func (b *bolt3) Close() {
-	b.log.Infof(b.logName, b.logId, "Disconnected")
+	b.log.Infof(log.Bolt3, b.logId, "Disconnected")
 	if b.state != bolt3_dead {
 		b.sendMsg(msgGoodbye)
 	}