fix: adding constants to describe logger rotations constraints

Author: Esteban Capillo

azure-ipam/ipam.go

@@ -32,7 +32,7 @@ type cnsClient interface {
 	ReleaseIPAddress(context.Context, cns.IPConfigRequest) error
 }
 
-// NewPlugin constructs a new IPAM plugin instance with given log and CNS client
+// NewPlugin constructs a new IPAM plugin instance with given logger and CNS client
 func NewPlugin(logger *zap.Logger, c cnsClient, out io.Writer) (*IPAMPlugin, error) {
 	plugin := &IPAMPlugin{
 		Name:      pluginName,

azure-ipam/logger/logger.go

@@ -17,7 +17,7 @@ type Config struct {
 	MaxBackups  int    // # of backups, no limitation by default
 }
 
-// NewLogger creates and returns a zap log and a clean up function
+// NewLogger creates and returns a zap logger and a clean up function
 func New(cfg *Config) (*zap.Logger, func(), error) {
 	logLevel, err := zapcore.ParseLevel(cfg.Level)
 	if err != nil {
@@ -45,7 +45,7 @@ func newFileLogger(cfg *Config, logLevel zapcore.Level) *zap.Logger {
 	encoderConfig := zap.NewProductionEncoderConfig()
 	encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
 	jsonEncoder := zapcore.NewJSONEncoder(encoderConfig)
-	// create a new zap log
+	// create a new zap logger
 	core := zapcore.NewCore(jsonEncoder, logFileWriter, logLevel)
 	logger := zap.New(core)
 	return logger

azure-ipam/main.go

@@ -20,14 +20,14 @@ func main() {
 }
 
 func executePlugin() error {
-	// log config
+	// logger config
 	loggerCfg := &logger.Config{
 		Level:       "debug",
 		Filepath:    "/var/log/azure-ipam.log",
 		MaxSizeInMB: 5, // MegaBytes
 		MaxBackups:  8,
 	}
-	// Create log
+	// Create logger
 	pluginLogger, cleanup, err := logger.New(loggerCfg)
 	if err != nil {
 		return errors.Wrapf(err, "failed to setup IPAM logging")

cni/ipam/plugin/main.go

@@ -15,7 +15,9 @@ import (
 )
 
 const (
-	name = "azure-vnet-ipam"
+	name               = "azure-vnet-ipam"
+	maxLogFileSizeInMb = 5
+	maxLogFileCount    = 8
 )
 
 // Version is populated by make during build.
@@ -29,8 +31,8 @@ func main() {
 	loggerCfg := &log.Config{
 		Level:       zapcore.DebugLevel,
 		LogPath:     log.LogPath + "azure-ipam.log",
-		MaxSizeInMB: 5,
-		MaxBackups:  8,
+		MaxSizeInMB: maxLogFileSizeInMb,
+		MaxBackups:  maxLogFileCount,
 		Name:        name,
 	}
 	cleanup, err := log.New(loggerCfg)

cni/ipam/pluginv6/main.go

@@ -15,7 +15,9 @@ import (
 )
 
 const (
-	name = "azure-vnet-ipamv6"
+	name               = "azure-vnet-ipamv6"
+	maxLogFileSizeInMb = 5
+	maxLogFileCount    = 8
 )
 
 // Version is populated by make during build.
@@ -29,8 +31,8 @@ func main() {
 	loggerCfg := &log.Config{
 		Level:       zapcore.DebugLevel,
 		LogPath:     log.LogPath + "azure-ipam.log",
-		MaxSizeInMB: 5,
-		MaxBackups:  8,
+		MaxSizeInMB: maxLogFileSizeInMb,
+		MaxBackups:  maxLogFileCount,
 		Name:        name,
 	}
 	cleanup, err := log.New(loggerCfg)

cni/network/network_linux.go

@@ -5,6 +5,7 @@ import (
 	"strconv"
 
 	"github.com/Azure/azure-container-networking/cni"
+	"github.com/Azure/azure-container-networking/cni/log"
 	"github.com/Azure/azure-container-networking/cns"
 	"github.com/Azure/azure-container-networking/network"
 	"github.com/Azure/azure-container-networking/network/policy"
@@ -51,7 +52,7 @@ func addInfraRoutes(azIpamResult *cniTypesCurr.Result, result *cniTypesCurr.Resu
 
 func setNetworkOptions(cnsNwConfig *cns.GetNetworkContainerResponse, nwInfo *network.NetworkInfo) {
 	if cnsNwConfig != nil && cnsNwConfig.MultiTenancyInfo.ID != 0 {
-		log.Printf("Setting Network Options")
+		log.Logger.Info("Setting Network Options")
 		vlanMap := make(map[string]interface{})
 		vlanMap[network.VlanIDKey] = strconv.Itoa(cnsNwConfig.MultiTenancyInfo.ID)
 		vlanMap[network.SnatBridgeIPKey] = cnsNwConfig.LocalIPConfiguration.GatewayIPAddress + "/" + strconv.Itoa(int(cnsNwConfig.LocalIPConfiguration.IPSubnet.PrefixLength))
@@ -61,7 +62,7 @@ func setNetworkOptions(cnsNwConfig *cns.GetNetworkContainerResponse, nwInfo *net
 
 func setEndpointOptions(cnsNwConfig *cns.GetNetworkContainerResponse, epInfo *network.EndpointInfo, vethName string) {
 	if cnsNwConfig != nil && cnsNwConfig.MultiTenancyInfo.ID != 0 {
-		log.Printf("Setting Endpoint Options")
+		log.Logger.Info("Setting Endpoint Options")
 		epInfo.Data[network.VlanIDKey] = cnsNwConfig.MultiTenancyInfo.ID
 		epInfo.Data[network.LocalIPKey] = cnsNwConfig.LocalIPConfiguration.IPSubnet.IPAddress + "/" + strconv.Itoa(int(cnsNwConfig.LocalIPConfiguration.IPSubnet.PrefixLength))
 		epInfo.Data[network.SnatBridgeIPKey] = cnsNwConfig.LocalIPConfiguration.GatewayIPAddress + "/" + strconv.Itoa(int(cnsNwConfig.LocalIPConfiguration.IPSubnet.PrefixLength))

cni/network/plugin/main.go

@@ -35,6 +35,8 @@ const (
 	telemetryNumRetries             = 5
 	telemetryWaitTimeInMilliseconds = 200
 	name                            = "azure-vnet"
+	maxLogFileSizeInMb              = 5
+	maxLogFileCount                 = 8
 )
 
 // Version is populated by make during build.
@@ -294,8 +296,8 @@ func main() {
 	loggerCfg := &log.Config{
 		Level:       zapcore.DebugLevel,
 		LogPath:     log.LogPath + "azure-vnet.log",
-		MaxSizeInMB: 5,
-		MaxBackups:  8,
+		MaxSizeInMB: maxLogFileSizeInMb,
+		MaxBackups:  maxLogFileCount,
 		Name:        name,
 	}
 	cleanup, err := log.New(loggerCfg)

cni/telemetry/service/telemetrymain.go

@@ -27,6 +27,8 @@ const (
 	pluginName                        = "AzureCNI"
 	azureVnetTelemetry                = "azure-vnet-telemetry"
 	configExtension                   = ".config"
+	maxLogFileSizeInMb                = 5
+	maxLogFileCount                   = 8
 )
 
 var version string
@@ -117,8 +119,8 @@ func main() {
 	loggerCfg := &log.Config{
 		Level:       logLevel,
 		LogPath:     log.LogPath + azureVnetTelemetry + ".log",
-		MaxSizeInMB: 5,
-		MaxBackups:  8,
+		MaxSizeInMB: maxLogFileSizeInMb,
+		MaxBackups:  maxLogFileCount,
 		Name:        azureVnetTelemetry,
 	}
 	cleanup, err := log.New(loggerCfg)

cns/multitenantcontroller/multitenantoperator/multitenantcrdcontroller.go

@@ -38,7 +38,7 @@ type requestController struct {
 
 // New creates a new multi-tenant CRD operator.
 func New(restService *restserver.HTTPRestService, kubeconfig *rest.Config) (*requestController, error) {
-	// Check that log package has been initialized.
+	// Check that logger package has been initialized.
 	if logger.Log == nil {
 		return nil, errors.New("Must initialize logger before calling")
 	}

go.mod

@@ -35,6 +35,7 @@ require (
 	golang.org/x/sys v0.6.0
 	google.golang.org/grpc v1.52.0
 	google.golang.org/protobuf v1.28.1
+	gopkg.in/natefinch/lumberjack.v2 v2.0.0
 	k8s.io/api v0.26.3
 	k8s.io/apiextensions-apiserver v0.26.1
 	k8s.io/apimachinery v0.26.3

go.sum

@@ -1244,6 +1244,7 @@ gopkg.in/inf.v0 v0.9.1 h1:73M5CoZyi3ZLMOyDlQh031Cx6N9NDJ2Vvfl76EDAgDc=
 gopkg.in/inf.v0 v0.9.1/go.mod h1:cWUDdTG/fYaXco+Dcufb5Vnc6Gp2YChqWtbxRZE0mXw=
 gopkg.in/ini.v1 v1.67.0 h1:Dgnx+6+nfE+IfzjUEISNeydPJh9AXNNsWbGP9KzCsOA=
 gopkg.in/ini.v1 v1.67.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
+gopkg.in/natefinch/lumberjack.v2 v2.0.0 h1:1Lc07Kr7qY4U2YPouBjpCLxpiyxIVoxqXgkXLknAOE8=
 gopkg.in/natefinch/lumberjack.v2 v2.0.0/go.mod h1:l0ndWWf7gzL7RNwBG7wST/UCcT4T24xpD6X8LsfU/+k=
 gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo=
 gopkg.in/square/go-jose.v2 v2.2.2/go.mod h1:M9dMgbHiYLoDGQrXy7OpJDJWiKiU//h+vD76mk0e1AI=