Merge pull request #163 from yfyf/reduce-logging

Eliminate unnecessary logs produced by Driver

Author: knuton

Changelog.md

@@ -2,6 +2,8 @@
 
 ## [UNRELEASED]
 
+- Reduce log metadata and volume
+
 ## [2.7.0] - 2025-10-15
 
 ### Added

src/dividat-driver/senso/main.go

@@ -122,9 +122,9 @@ func (backend *DeviceBackend) Connect(address string) {
 		backend.broker.TryPub(data, brokerTopicRx)
 	}
 
-	go connectTCP(ctx, backend.log.WithField("channel", "data"), address+":55568", backend.broker.Sub("noTx"), onReceive)
+	go connectTCP(ctx, backend.log.WithField("channel", "data"), address+":55568", backend.broker.Sub("noTx"), onReceive, true)
 	time.Sleep(1000 * time.Millisecond)
-	go connectTCP(ctx, backend.log.WithField("channel", "control"), address+":55567", backend.broker.Sub(brokerTopicTx), onReceive)
+	go connectTCP(ctx, backend.log.WithField("channel", "control"), address+":55567", backend.broker.Sub(brokerTopicTx), onReceive, false)
 
 	backend.cancelCurrentConnection = cancel
 }

src/dividat-driver/senso/tcp.go

@@ -20,11 +20,19 @@ const maxInterval = 30 * time.Second
 type onReceive = func([]byte)
 
 // connectTCP creates a persistent tcp connection to address
-func connectTCP(ctx context.Context, baseLogger *logrus.Entry, address string, tx chan interface{}, onReceive onReceive) {
+// isOptional is used when connecting to the data channel, which is used only in legacy Senso firmware
+func connectTCP(ctx context.Context, baseLogger *logrus.Entry, address string, tx chan interface{}, onReceive onReceive, isOptional bool) {
 	var dialer net.Dialer
 
 	var log = baseLogger.WithField("address", address)
 
+	var connectionAttemptLogLevel logrus.Level
+	if isOptional {
+		connectionAttemptLogLevel = logrus.DebugLevel
+	} else {
+		connectionAttemptLogLevel = logrus.InfoLevel
+	}
+
 	var conn net.Conn
 	dialTCP := func() error {
 
@@ -34,11 +42,11 @@ func connectTCP(ctx context.Context, baseLogger *logrus.Entry, address string, t
 			conn.Close()
 		}
 
-		log.Info("Dialing TCP connection.")
+		log.Log(connectionAttemptLogLevel, "Dialing TCP connection.")
 		conn, connErr = dialer.DialContext(ctx, "tcp", address)
 
 		if connErr != nil {
-			log.WithError(connErr).Info("Could not connect with Senso.")
+			log.WithError(connErr).Log(connectionAttemptLogLevel, "Could not connect with Senso.")
 		}
 		return connErr
 	}

src/dividat-driver/server/main.go

@@ -3,6 +3,7 @@ package server
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 	"net/http"
 
 	"github.com/sirupsen/logrus"
@@ -28,23 +29,15 @@ func Start(logger *logrus.Logger, origins []string) context.CancelFunc {
 	logServer := logging.NewLogServer()
 	logger.AddHook(logServer)
 
-	baseLog := logger.WithFields(logrus.Fields{
-		"version": version,
-	})
+	baseLog := logrus.NewEntry(logger)
 
 	// Get System information
 	systemInfo, err := GetSystemInfo()
 	if err != nil {
 		baseLog.WithError(err).Panic("Could not get system information.")
 	}
 
-	baseLog = baseLog.WithFields(logrus.Fields{
-		"machineId": systemInfo.MachineId,
-		"os":        systemInfo.Os,
-		"arch":      systemInfo.Arch,
-	})
-
-	baseLog.Info("Dividat Driver starting")
+	baseLog.Info(fmt.Sprintf("Dividat Driver (%s) starting", version))
 
 	// Setup log endpoint
 	http.Handle("/log", originMiddleware(origins, baseLog, logServer))
@@ -72,9 +65,6 @@ func Start(logger *logrus.Logger, origins []string) context.CancelFunc {
 	// Create a logger for server
 	log := baseLog.WithField("package", "server")
 
-	// Start the monitor
-	go startMonitor(baseLog.WithField("package", "monitor"))
-
 	// Setup HTTP Server
 	server := http.Server{Addr: "127.0.0.1:" + serverPort}
 

src/dividat-driver/server/monitor.go

@@ -38,5 +38,6 @@ it('Opening a second instance of the driver fails.', (done) => {
 it('Get log entries from HTTP endpoint.', async () => {
   const logs = await getJSON('http://127.0.0.1:8382/log')
   expect(logs).to.be.an('array')
-  expect(logs[0]).to.include({level: 'info', msg: 'Dividat Driver starting'})
+  expect(logs[0].level).to.equal('info')
+  expect(logs[0].msg).to.match(/Dividat Driver (.*) starting/)
 })