Changed logging to use zerolog

Author: ynHuber

generator-config.go

@@ -1,6 +1,9 @@
 package main
 
-import "gopkg.in/yaml.v2"
+import (
+	"github.com/rs/zerolog/log"
+	"gopkg.in/yaml.v2"
+)
 
 type OIDType string
 
@@ -53,7 +56,7 @@ func ParseConfiguration(b []byte) Configuration {
 	configuration := new(Configuration)
 	err := yaml.Unmarshal(b, configuration)
 	if err != nil {
-		log.Fatalf("[error] Error parsing configuration YAML: %v", err)
+		log.Fatal().Err(err).Msg("Error parsing configuration YAML")
 	}
 	return *configuration
 }

go.mod

@@ -4,26 +4,28 @@ go 1.23.3
 
 replace github.com/nerdalert/nflow-generato => .
 
-require (
-	github.com/jessevdk/go-flags v1.5.0
-	github.com/sirupsen/logrus v1.8.1
-)
+require github.com/jessevdk/go-flags v1.5.0
 
 require (
 	github.com/go-ole/go-ole v1.2.6 // indirect
+	github.com/konsorten/go-windows-terminal-sequences v1.0.1 // indirect
 	github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.19 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c // indirect
 	github.com/prometheus/procfs v0.0.8 // indirect
 	github.com/shirou/gopsutil/v3 v3.23.11 // indirect
 	github.com/shoenig/go-m1cpu v0.1.6 // indirect
+	github.com/sirupsen/logrus v1.4.2 // indirect
 	github.com/tklauser/go-sysconf v0.3.12 // indirect
 	github.com/tklauser/numcpus v0.6.1 // indirect
 	github.com/yusufpapurcu/wmi v1.2.3 // indirect
 )
 
 require (
 	github.com/gosnmp/gosnmp v1.40.0
+	github.com/rs/zerolog v1.34.0
 	github.com/slayercat/GoSNMPServer v0.5.2
 	golang.org/x/sys v0.15.0 // indirect
 	gopkg.in/yaml.v2 v2.4.0

go.sum

@@ -1,10 +1,12 @@
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
+github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
 github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/go-ole/go-ole v1.2.6 h1:/Fpf6oFPoeFik9ty7siob0G6Ke8QvQEuVcuChpwXzpY=
 github.com/go-ole/go-ole v1.2.6/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiUsvbm0=
+github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
 github.com/golang/mock v1.6.0/go.mod h1:p6yTPP+5HYm5mzsMV8JkE6ZKdX+/wYM6Hr+LicevLPs=
 github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
 github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
@@ -16,9 +18,15 @@ github.com/gosnmp/gosnmp v1.40.0 h1:MvSqHZaNnhMKdn5IVhyYzCsVfXV1lgg6ZgLRku7FVcM=
 github.com/gosnmp/gosnmp v1.40.0/go.mod h1:CxVS6bXqmWZlafUj9pZUnQX5e4fAltqPcijxWpCitDo=
 github.com/jessevdk/go-flags v1.5.0 h1:1jKYvbxEjfUl0fmqTCOfonvskHHXMjBySTLW4y9LFvc=
 github.com/jessevdk/go-flags v1.5.0/go.mod h1:Fw0T6WPc1dYxT4mKEZRfG5kJhaTDP9pj1c2EWnYs/m4=
+github.com/konsorten/go-windows-terminal-sequences v1.0.1 h1:mweAR1A6xJ3oS2pRaGiHgQ4OO8tzTaLawm8vnODuwDk=
 github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
 github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 h1:6E+4a0GO5zZEnZ81pIr0yLvtUWk2if982qA3F3QD6H4=
 github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0/go.mod h1:zJYVVT2jmtg6P3p1VtQj7WsuWi/y4VnjVBn7F8KPB3I=
+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 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
@@ -27,16 +35,18 @@ github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c h1:ncq/mPwQF
 github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c/go.mod h1:OmDBASR4679mdNQnz2pUhc2G8CO2JrUAVFDRBDP/hJE=
 github.com/prometheus/procfs v0.0.8 h1:+fpWZdT24pJBiqJdAwYBjPSk+5YmQzYNPYzQsdzLkt8=
 github.com/prometheus/procfs v0.0.8/go.mod h1:7Qr8sr6344vo1JqZ6HhLceV9o3AJ1Ff+GxbHq6oeK9A=
+github.com/rs/xid v1.6.0/go.mod h1:7XoLgs4eV+QndskICGsho+ADou8ySMSjJKDIan90Nz0=
+github.com/rs/zerolog v1.34.0 h1:k43nTLIwcTVQAncfCw4KZ2VY6ukYoZaBPNOE8txlOeY=
+github.com/rs/zerolog v1.34.0/go.mod h1:bJsvje4Z08ROH4Nhs5iH600c3IkWhwp44iRc54W6wYQ=
 github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/shirou/gopsutil/v3 v3.23.11 h1:i3jP9NjCPUz7FiZKxlMnODZkdSIp2gnzfrvsu9CuWEQ=
 github.com/shirou/gopsutil/v3 v3.23.11/go.mod h1:1FrWgea594Jp7qmjHUUPlJDTPgcsb9mGnXDxavtikzM=
 github.com/shoenig/go-m1cpu v0.1.6 h1:nxdKQNcEB6vzgA2E2bvzKIYRuNj7XNJ4S/aRSwKzFtM=
 github.com/shoenig/go-m1cpu v0.1.6/go.mod h1:1JJMcUBvfNwpq05QDQVAnx3gUHr9IYF7GNg9SUEw2VQ=
 github.com/shoenig/test v0.6.4/go.mod h1:byHiCGXqrVaflBLAMq/srcZIHynQPQgeyvkvXnjqq0k=
 github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
+github.com/sirupsen/logrus v1.4.2 h1:SPIRibHv4MatM3XXNO2BJeFLZwZ2LvZgfQ5+UNI2im4=
 github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE=
-github.com/sirupsen/logrus v1.8.1 h1:dJKuHgqk1NNQlqoA6BTlM1Wf9DOH3NBjQyu0h9+AZZE=
-github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
 github.com/slayercat/GoSNMPServer v0.5.2 h1:IK2d3kz6JoiYHbAZT5H7hrQQRzAD7rxF0iJZxWrV7Ns=
 github.com/slayercat/GoSNMPServer v0.5.2/go.mod h1:6taMSIwudR+7pKRO6dz2U+xoNccZds8eiMVlEN66fXY=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
@@ -93,7 +103,9 @@ golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

nflow-generator.go

@@ -14,6 +14,8 @@ import (
 	"time"
 
 	"github.com/jessevdk/go-flags"
+	"github.com/rs/zerolog"
+	"github.com/rs/zerolog/log"
 )
 
 type TrafficType int
@@ -49,6 +51,10 @@ type CommandLineOptions struct {
 func main() {
 	opts := CommandLineOptions{}
 
+	log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stderr, TimeFormat: time.DateTime})
+	zerolog.TimeFieldFormat = zerolog.TimeFormatUnix
+	zerolog.SetGlobalLevel(zerolog.InfoLevel)
+
 	_, err := flags.Parse(&opts)
 	if err != nil {
 		showUsage()
@@ -136,23 +142,23 @@ func runGenerator(generatorConfiguration *GeneratorConfiguration, wg *sync.WaitG
 	collector := collectorConfiguration.CollectorIP + ":" + collectorConfiguration.CollectorPort
 	udpAddr, err := net.ResolveUDPAddr("udp", collector)
 	if err != nil {
-		log.Fatal(err)
+		log.Fatal().Err(err)
 	}
 	conn, err := net.DialUDP("udp", nil, udpAddr)
 	defer func() {
 		wg.Wait()
 		conn.Close()
 	}()
 	if err != nil {
-		log.Fatal("Error connecting to the target collector: ", err)
+		log.Fatal().Err(err).Msg("Error connecting to the target collector:")
 	}
 
 	for _, flowDefinition := range generatorConfiguration.FlowConfigurations {
 		wg.Add(1)
 		go sendFlows(conn, flowDefinition, wg)
 	}
 
-	log.Infof("sending netflow data to a collector ip: %s and port: %s. \n"+
+	log.Info().Msgf("sending netflow data to a collector ip: %s and port: %s. - "+
 		"Use ctrl^c to terminate the app.", collectorConfiguration.CollectorIP, collectorConfiguration.CollectorPort)
 }
 
@@ -164,7 +170,7 @@ func sendFlows(conn *net.UDPConn, flowDefinition *FlowConfiguration, wg *sync.Wa
 
 	intervall, err := time.ParseDuration(flowDefinition.ReportingIntervall)
 	if err != nil {
-		log.Fatal("Failed to parse reporting intervall \""+flowDefinition.ReportingIntervall+"\" due to ", err.Error())
+		log.Fatal().Err(err).Msgf("Failed to parse reporting intervall \"%s\" due to ", flowDefinition.ReportingIntervall)
 	}
 
 	start := time.Now()
@@ -174,7 +180,7 @@ func sendFlows(conn *net.UDPConn, flowDefinition *FlowConfiguration, wg *sync.Wa
 		buffer := BuildNFlowPayload(data)
 		_, err = conn.Write(buffer.Bytes())
 		if err != nil {
-			log.Fatal("Error connecting to the target collector: ", err)
+			log.Fatal().Err(err).Msg("Error connecting to the target collector")
 		}
 		time.Sleep(intervall - time.Since(start))
 		start = flowEnd
@@ -216,7 +222,7 @@ func parseTrafficType(trafficTypeString string) TrafficType {
 		trafficType = CLDAP
 
 	default:
-		log.Fatal("Failed to parse netflow traffic definition" + trafficTypeString)
+		log.Fatal().Msgf("Failed to parse netflow traffic definition %s", trafficTypeString)
 		showUsage()
 		os.Exit(1)
 	}

nflow_logging.go

@@ -6,6 +6,8 @@ import (
 	"math/rand"
 	"net"
 	"time"
+
+	"github.com/rs/zerolog/log"
 )
 
 // Start time for this instance, used to compute sysUptime
@@ -84,12 +86,12 @@ func BuildNFlowPayload(data Netflow) bytes.Buffer {
 	buffer := new(bytes.Buffer)
 	err := binary.Write(buffer, binary.BigEndian, &data.Header)
 	if err != nil {
-		log.Println("Writing netflow header failed:", err)
+		log.Warn().Err(err).Msg("Writing netflow header failed:")
 	}
 	for _, record := range data.Records {
 		err := binary.Write(buffer, binary.BigEndian, &record)
 		if err != nil {
-			log.Println("Writing netflow record failed:", err)
+			log.Warn().Err(err).Msg("Writing netflow record failed:")
 		}
 	}
 	return *buffer
@@ -156,7 +158,7 @@ func PortForTrafficType(trafficType TrafficType) uint16 {
 	case CLDAP:
 		return CLDAP_PORT
 	}
-	log.Fatal("Unknown traffic definition")
+	log.Fatal().Msg("Unknown traffic definition")
 	return 0
 }
 
@@ -190,7 +192,7 @@ func ProtocollForTrafficType(trafficType TrafficType) int {
 		return 17
 	default:
 	}
-	log.Fatal("Unknown traffic definition")
+	log.Fatal().Msg("Unknown traffic definition")
 	return 0
 }
 

nflow_payload.go

@@ -1,12 +1,11 @@
 package main
 
 import (
-	"os"
 	"strconv"
 	"sync"
 
 	"github.com/gosnmp/gosnmp"
-	"github.com/sirupsen/logrus"
+	"github.com/rs/zerolog/log"
 	"github.com/slayercat/GoSNMPServer"
 )
 
@@ -27,13 +26,12 @@ OIDLooP:
 			oidType = gosnmp.Counter64
 			oidValueUint, err := strconv.ParseUint(oid.Value, 10, 0)
 			if err != nil {
-				log.Warn(err)
+				log.Warn().Err(err)
 				continue OIDLooP
 			}
-			log.Info(oidValueUint)
 			msg = GoSNMPServer.Asn1Counter64Unwrap(oidValueUint)
 		default:
-			log.Warn("unknown oid Type " + oid.Type)
+			log.Warn().Msgf("unknown oid Type %s", oid.Type)
 			continue OIDLooP
 		}
 
@@ -46,12 +44,10 @@ OIDLooP:
 		oids = append(oids, &oidObj)
 
 	}
-	var log = logrus.New()
-	log.Out = os.Stdout
-	log.Level = logrus.InfoLevel
+	var logger = &ZeroLogger{}
 
 	master := GoSNMPServer.MasterAgent{
-		Logger: log,
+		Logger: logger,
 		SecurityConfig: GoSNMPServer.SecurityConfig{
 			AuthoritativeEngineBoots: 1,
 			Users: []gosnmp.UsmSecurityParameters{
@@ -75,7 +71,7 @@ OIDLooP:
 	serverAddress := conf.CollectorIP + ":" + conf.CollectorPort
 	err := server.ListenUDP("udp", serverAddress)
 	if err != nil {
-		log.Printf("Error in listen: %+v", err)
+		log.Error().Err(err).Msg("Error in listen")
 	}
 	go server.ServeForever()
 	startUpWait.Done()

snmp.go

@@ -0,0 +1,94 @@
+package main
+
+import (
+	"fmt"
+
+	"github.com/rs/zerolog/log"
+)
+
+type ZeroLogger struct {
+}
+
+func (l *ZeroLogger) Debug(args ...interface{}) {
+	log.Debug().Msg(fmt.Sprint(args...))
+}
+
+func (l *ZeroLogger) Debugf(format string, args ...interface{}) {
+	log.Debug().Msgf(format, args...)
+}
+
+func (l *ZeroLogger) Debugln(args ...interface{}) {
+	log.Debug().Msg(fmt.Sprintln(args...))
+}
+
+func (l *ZeroLogger) Error(args ...interface{}) {
+	log.Error().Msg(fmt.Sprint(args...))
+}
+
+func (l *ZeroLogger) Errorf(format string, args ...interface{}) {
+	log.Error().Msgf(format, args...)
+}
+
+func (l *ZeroLogger) Errorln(args ...interface{}) {
+	log.Error().Msg(fmt.Sprintln(args...))
+}
+
+func (l *ZeroLogger) Fatal(args ...interface{}) {
+	log.Fatal().Msg(fmt.Sprint(args...))
+}
+
+func (l *ZeroLogger) Fatalf(format string, args ...interface{}) {
+	log.Fatal().Msgf(format, args...)
+}
+
+func (l *ZeroLogger) Fatalln(args ...interface{}) {
+	log.Fatal().Msg(fmt.Sprintln(args...))
+}
+
+func (l *ZeroLogger) Info(args ...interface{}) {
+	log.Info().Msg(fmt.Sprint(args...))
+}
+
+func (l *ZeroLogger) Infof(format string, args ...interface{}) {
+	log.Info().Msgf(format, args...)
+}
+
+func (l *ZeroLogger) Infoln(args ...interface{}) {
+	log.Info().Msg(fmt.Sprintln(args...))
+}
+
+func (l *ZeroLogger) Trace(args ...interface{}) {
+	log.Trace().Msg(fmt.Sprint(args...))
+}
+
+func (l *ZeroLogger) Tracef(format string, args ...interface{}) {
+	log.Trace().Msgf(format, args...)
+}
+
+func (l *ZeroLogger) Traceln(args ...interface{}) {
+	log.Trace().Msg(fmt.Sprintln(args...))
+}
+
+func (l *ZeroLogger) Warn(args ...interface{}) {
+	log.Warn().Msg(fmt.Sprint(args...))
+}
+
+func (l *ZeroLogger) Warnf(format string, args ...interface{}) {
+	log.Warn().Msgf(format, args...)
+}
+
+func (l *ZeroLogger) Warning(args ...interface{}) {
+	log.Warn().Msg(fmt.Sprint(args...))
+}
+
+func (l *ZeroLogger) Warningf(format string, args ...interface{}) {
+	log.Warn().Msgf(format, args...)
+}
+
+func (l *ZeroLogger) Warningln(args ...interface{}) {
+	log.Warn().Msg(fmt.Sprintln(args...))
+}
+
+func (l *ZeroLogger) Warnln(args ...interface{}) {
+	log.Warn().Msg(fmt.Sprintln(args...))
+}