feat: switch to zerolog for logging

Author: vwhitteron

examples/simple/main.go

@@ -9,7 +9,7 @@ import (
 )
 
 func main() {
-	clientConfig := telemetry_client.Config{
+	clientConfig := telemetry_client.GTClientOpts{
 		StatsEnabled: true,
 	}
 

go.mod

@@ -4,7 +4,13 @@ go 1.21.4
 
 require (
 	github.com/kaitai-io/kaitai_struct_go_runtime v0.10.0
+	github.com/rs/zerolog v1.32.0
 	golang.org/x/crypto v0.22.0
 )
 
-require golang.org/x/text v0.14.0 // indirect
+require (
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.19 // indirect
+	golang.org/x/sys v0.19.0 // indirect
+	golang.org/x/text v0.14.0 // indirect
+)

go.sum

@@ -1,7 +1,23 @@
+github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
+github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
 github.com/kaitai-io/kaitai_struct_go_runtime v0.10.0 h1:bxazq0XLMSVMm/DIVFLl9BqIWehrqcLsyVWSacEjIKE=
 github.com/kaitai-io/kaitai_struct_go_runtime v0.10.0/go.mod h1:fBebEoDoc0xNbZsIcRQWqDp4jViaTKv6uxAUjmCFGgM=
+github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
+github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
+github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
+github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA=
+github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
+github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
+github.com/rs/zerolog v1.32.0 h1:keLypqrlIjaFsbmJOBdB/qvyF8KEtCWHwobLp5l/mQ0=
+github.com/rs/zerolog v1.32.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss=
 golang.org/x/crypto v0.22.0 h1:g1v0xeRhjcugydODzvb3mEM9SQ0HGp9s/nh3COQ/C30=
 golang.org/x/crypto v0.22.0/go.mod h1:vr6Su+7cTlO45qkww3VDJlzDn0ctJvRgYbC2NvXHt+M=
+golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.19.0 h1:q5f1RH2jigJ1MoAWp2KTp3gm5zAGFUTarQZ5U386+4o=
+golang.org/x/sys v0.19.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
 golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
 golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=

telemetry_client.go

@@ -3,14 +3,13 @@ package telemetry
 import (
 	"bytes"
 	"encoding/binary"
-	"fmt"
-	"log"
 	"net"
+	"os"
 	"time"
 
 	"github.com/kaitai-io/kaitai_struct_go_runtime/kaitai"
+	"github.com/rs/zerolog"
 	"github.com/vwhitteron/gt-telemetry/internal/gttelemetry"
-	"github.com/vwhitteron/gt-telemetry/internal/utils"
 	"github.com/vwhitteron/gt-telemetry/internal/vehicles"
 	"golang.org/x/crypto/salsa20"
 )
@@ -33,48 +32,62 @@ type statistics struct {
 	PacketsTotal      int
 }
 
-type Config struct {
+type GTClientOpts struct {
 	IPAddr       string
 	LogLevel     string
+	Logger       *zerolog.Logger
 	StatsEnabled bool
 	VehicleDB    string
 }
 
 type GTClient struct {
-	logger      *utils.Logger
+	log         zerolog.Logger
 	ipAddr      string
 	sendPort    int
 	receivePort int
 	Telemetry   *transformer
 	Statistics  *statistics
 }
 
-func NewGTClient(config Config) (*GTClient, error) {
-	if config.LogLevel == "" {
-		config.LogLevel = "info"
+func NewGTClient(opts GTClientOpts) (*GTClient, error) {
+	var log zerolog.Logger
+	if opts.Logger != nil {
+		log = *opts.Logger
+	} else {
+		log = zerolog.New(os.Stdout).With().Timestamp().Logger()
 	}
-	logger, err := utils.NewLogger(config.LogLevel)
-	if err != nil {
-		return nil, err
+
+	switch opts.LogLevel {
+	case "debug":
+		log = log.Level(zerolog.DebugLevel)
+	case "info":
+		log = log.Level(zerolog.InfoLevel)
+	case "warn":
+		log = log.Level(zerolog.WarnLevel)
+	case "error":
+		log = log.Level(zerolog.ErrorLevel)
+	default:
+		log = log.Level(zerolog.WarnLevel)
+		log.Warn().Msg("Invalid log level, defaulting to warn")
 	}
 
-	if config.IPAddr == "" {
-		config.IPAddr = "255.255.255.255"
+	if opts.IPAddr == "" {
+		opts.IPAddr = "255.255.255.255"
 	}
 
-	inventory, err := vehicles.NewInventory(config.VehicleDB)
+	inventory, err := vehicles.NewInventory(opts.VehicleDB)
 	if err != nil {
 		return nil, err
 	}
 
 	return &GTClient{
-		logger:      logger,
-		ipAddr:      config.IPAddr,
+		log:         log,
+		ipAddr:      opts.IPAddr,
 		sendPort:    33739,
 		receivePort: 33740,
 		Telemetry:   NewTransformer(inventory),
 		Statistics: &statistics{
-			enabled:           config.StatsEnabled,
+			enabled:           opts.StatsEnabled,
 			decodeTimeLast:    time.Duration(0),
 			packetRateLast:    time.Now(),
 			DecodeTimeAvg:     time.Duration(0),
@@ -94,12 +107,12 @@ func NewGTClient(config Config) (*GTClient, error) {
 func (c *GTClient) Run() {
 	addr, err := net.ResolveUDPAddr("udp", ":33740")
 	if err != nil {
-		log.Fatal(err)
+		c.log.Fatal().Msgf("resolve UDP address: %s", err.Error())
 	}
 
 	conn, err := net.ListenUDP("udp", addr)
 	if err != nil {
-		log.Fatal(err)
+		c.log.Fatal().Msgf("listen UDP: %s", err.Error())
 	}
 	defer conn.Close()
 
@@ -118,12 +131,12 @@ func (c *GTClient) Run() {
 		buffer := make([]byte, 4096)
 		bufLen, _, err := conn.ReadFromUDP(buffer)
 		if err != nil {
-			c.logger.Debug(fmt.Sprintf("Failed to receive telemetry: %s", err.Error()))
+			c.log.Debug().Msgf("failed to receive telemetry: %s", err.Error())
 			continue
 		}
 
 		if len(buffer[:bufLen]) == 0 {
-			c.logger.Debug("No data received")
+			c.log.Debug().Msg("no data received")
 			continue
 		}
 
@@ -136,7 +149,7 @@ func (c *GTClient) Run() {
 
 		err = rawTelemetry.Read(stream, nil, nil)
 		if err != nil {
-			c.logger.Error(fmt.Sprintf("Failed to parse telemetry: %s", err.Error()))
+			c.log.Error().Msgf("failed to parse telemetry: %s", err.Error())
 			c.Statistics.PacketsInvalid++
 		}
 
@@ -167,10 +180,10 @@ func (c *GTClient) collectStats() {
 
 		delta := int(c.Telemetry.SequenceID() - c.Statistics.packetIDLast)
 		if delta > 1 {
-			c.logger.Warn(fmt.Sprintf("Dropped packets detected: %d", delta-1))
+			c.log.Warn().Int("dropped", delta-1).Msg("dropped packets detected")
 			c.Statistics.PacketsDropped += int(delta - 1)
 		} else if delta < 0 {
-			c.logger.Warn("Delayed packet deteted")
+			c.log.Warn().Msg("delayed packet detected")
 		}
 
 		c.Statistics.packetIDLast = c.Telemetry.SequenceID()
@@ -189,7 +202,7 @@ func (c *GTClient) collectStats() {
 }
 
 func (c *GTClient) SendHeartbeat(conn *net.UDPConn) {
-	c.logger.Debug("Sending heartbeat")
+	c.log.Debug().Msg("Sending heartbeat")
 	c.Statistics.Heartbeat = true
 	defer func() {
 		time.Sleep(250 * time.Millisecond)
@@ -201,11 +214,11 @@ func (c *GTClient) SendHeartbeat(conn *net.UDPConn) {
 		Port: c.sendPort,
 	})
 	if err != nil {
-		log.Fatal(err)
+		c.log.Fatal().Msgf("write to udp: %s", err.Error())
 	}
 	err = conn.SetReadDeadline(time.Now().Add(10 * time.Second))
 	if err != nil {
-		log.Fatal(err)
+		c.log.Fatal().Msgf("set read deadline: %s", err.Error())
 	}
 }