Replace logrus with zap logger` (#152)

Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com>
omec-project · Oct 3, 2024 · d385571 · d385571
1 parent da8d9f1
commit d385571
Show file tree

Hide file tree

Showing 27 changed files with 274 additions and 372 deletions.
diff --git a/.fossa.yml b/.fossa.yml
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.4.5-dev
+1.5.0
diff --git a/ampolicy/routers.go b/ampolicy/routers.go
@@ -20,7 +20,7 @@ import (
 
 	"github.com/gin-gonic/gin"
 	"github.com/omec-project/pcf/logger"
-	logger_util "github.com/omec-project/util/logger"
+	utilLogger "github.com/omec-project/util/logger"
 )
 
 // Route is the information for every URI.
@@ -40,7 +40,7 @@ type Routes []Route
 
 // NewRouter returns a new router.
 func NewRouter() *gin.Engine {
-	router := logger_util.NewGinWithLogrus(logger.GinLog)
+	router := utilLogger.NewGinWithZap(logger.GinLog)
 	AddService(router)
 	return router
 }

diff --git a/bdtpolicy/routers.go b/bdtpolicy/routers.go
@@ -20,7 +20,7 @@ import (
 
 	"github.com/gin-gonic/gin"
 	"github.com/omec-project/pcf/logger"
-	logger_util "github.com/omec-project/util/logger"
+	utilLogger "github.com/omec-project/util/logger"
 )
 
 // Route is the information for every URI.
@@ -40,7 +40,7 @@ type Routes []Route
 
 // NewRouter returns a new router.
 func NewRouter() *gin.Engine {
-	router := logger_util.NewGinWithLogrus(logger.GinLog)
+	router := utilLogger.NewGinWithZap(logger.GinLog)
 	AddService(router)
 	return router
 }

diff --git a/callback/router.go b/callback/router.go
@@ -31,7 +31,7 @@ type Routes []Route
 
 // NewRouter returns a new router.
 func NewRouter() *gin.Engine {
-	router := loggerUtil.NewGinWithLogrus(logger.GinLog)
+	router := loggerUtil.NewGinWithZap(logger.GinLog)
 	AddService(router)
 	return router
 }

diff --git a/consumer/nf_management.go b/consumer/nf_management.go
@@ -66,7 +66,6 @@ var SendRegisterNFInstance = func(nrfUri, nfInstanceId string, profile models.Nf
 	for {
 		nfProfile, res, err = client.NFInstanceIDDocumentApi.RegisterNFInstance(context.TODO(), nfInstanceId, profile)
 		if err != nil || res == nil {
-			// TODO : add log
 			logger.Consumerlog.Infof("PCF register to NRF Error[%v]", err.Error())
 			time.Sleep(2 * time.Second)
 			continue
@@ -96,7 +95,7 @@ var SendRegisterNFInstance = func(nrfUri, nfInstanceId string, profile models.Nf
 }
 
 func SendDeregisterNFInstance() (problemDetails *models.ProblemDetails, err error) {
-	logger.Consumerlog.Debugf("Send Deregister NFInstance")
+	logger.Consumerlog.Debugln("send Deregister NFInstance")
 
 	pcfSelf := pcfContext.PCF_Self()
 	// Set client and set url
@@ -127,7 +126,7 @@ func SendDeregisterNFInstance() (problemDetails *models.ProblemDetails, err erro
 }
 
 var SendUpdateNFInstance = func(patchItem []models.PatchItem) (nfProfile models.NfProfile, problemDetails *models.ProblemDetails, err error) {
-	logger.Consumerlog.Debugf("Send Update NFInstance")
+	logger.Consumerlog.Debugln("send Update NFInstance")
 
 	pcfSelf := pcfContext.PCF_Self()
 	configuration := Nnrf_NFManagement.NewConfiguration()
@@ -157,7 +156,7 @@ var SendUpdateNFInstance = func(patchItem []models.PatchItem) (nfProfile models.
 }
 
 func SendCreateSubscription(nrfUri string, nrfSubscriptionData models.NrfSubscriptionData) (nrfSubData models.NrfSubscriptionData, problemDetails *models.ProblemDetails, err error) {
-	logger.ConsumerLog.Debugf("Send Create Subscription")
+	logger.ConsumerLog.Debugln("send Create Subscription")
 
 	// Set client and set url
 	configuration := Nnrf_NFManagement.NewConfiguration()
@@ -187,7 +186,7 @@ func SendCreateSubscription(nrfUri string, nrfSubscriptionData models.NrfSubscri
 }
 
 func SendRemoveSubscription(subscriptionId string) (problemDetails *models.ProblemDetails, err error) {
-	logger.ConsumerLog.Infoln("Send Remove Subscription")
+	logger.ConsumerLog.Infoln("send Remove Subscription")
 
 	pcfSelf := pcfContext.PCF_Self()
 	// Set client and set url

diff --git a/context/context.go b/context/context.go
@@ -19,7 +19,7 @@ import (
 	"github.com/omec-project/pcf/factory"
 	"github.com/omec-project/pcf/logger"
 	"github.com/omec-project/util/idgenerator"
-	"github.com/sirupsen/logrus"
+	"go.uber.org/zap"
 )
 
 var pcfCtx *PCFContext
@@ -87,7 +87,7 @@ type PccPolicy struct {
 }
 type PcfSubscriberPolicyData struct {
 	PccPolicy map[string]*PccPolicy // sst+sd is key
-	CtxLog    *logrus.Entry
+	CtxLog    *zap.SugaredLogger
 	Supi      string
 }
 
@@ -191,7 +191,7 @@ func (c *PCFContext) NewPCFUe(Supi string) (*UeContext, error) {
 func (c *PCFContext) AllocBdtPolicyID() (bdtPolicyID string, err error) {
 	var allocID int64
 	if allocID, err = c.BdtPolicyIDGenerator.Allocate(); err != nil {
-		logger.CtxLog.Warnf("Allocate pathID error: %+v", err)
+		logger.CtxLog.Warnf("allocate pathID error: %+v", err)
 		return "", err
 	}
 
@@ -445,10 +445,10 @@ func (sess SessionPolicy) String() string {
 }
 
 func (c *PCFContext) DisplayPcfSubscriberPolicyData(imsi string) {
-	logger.CtxLog.Infof("Pcf Subscriber [%v] Policy Details :", imsi)
+	logger.CtxLog.Infof("pcf subscriber [%v] Policy Details:", imsi)
 	subs, exist := pcfCtx.PcfSubscriberPolicyData[imsi]
 	if !exist {
-		logger.CtxLog.Infof("Pcf Subscriber [%v] not exist", imsi)
+		logger.CtxLog.Warnf("pcf subscriber [%v] not exist", imsi)
 	} else {
 		for slice, val := range subs.PccPolicy {
 			subs.CtxLog.Infof("   SliceId: %v", slice)

diff --git a/factory/pcf_config_test.go b/factory/pcf_config_test.go
@@ -7,7 +7,6 @@
 package factory
 
 import (
-	"fmt"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -16,7 +15,7 @@ import (
 // Webui URL is not set then default Webui URL value is returned
 func TestGetDefaultWebuiUrl(t *testing.T) {
 	if err := InitConfigFactory("pcfcfg.yaml"); err != nil {
-		fmt.Printf("Error in InitConfigFactory: %v\n", err)
+		t.Logf("error in InitConfigFactory: %v", err)
 	}
 	got := PcfConfig.Configuration.WebuiUri
 	want := "webui:9876"
@@ -26,7 +25,7 @@ func TestGetDefaultWebuiUrl(t *testing.T) {
 // Webui URL is set to a custom value then custom Webui URL is returned
 func TestGetCustomWebuiUrl(t *testing.T) {
 	if err := InitConfigFactory("pcfcfg_with_custom_webui_url.yaml"); err != nil {
-		fmt.Printf("Error in InitConfigFactory: %v\n", err)
+		t.Logf("error in InitConfigFactory: %v", err)
 	}
 	got := PcfConfig.Configuration.WebuiUri
 	want := "myspecialwebui:9872"

diff --git a/go.mod b/go.mod
@@ -4,20 +4,19 @@ go 1.21
 
 require (
 	github.com/antihax/optional v1.0.0
-	github.com/antonfisher/nested-logrus-formatter v1.3.1
 	github.com/cydev/zero v0.0.0-20160322155811-4a4535dd56e7
 	github.com/gin-contrib/cors v1.7.2
 	github.com/gin-gonic/gin v1.10.0
 	github.com/google/uuid v1.6.0
 	github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826
 	github.com/omec-project/config5g v1.5.0
 	github.com/omec-project/openapi v1.3.1
-	github.com/omec-project/util v1.1.0
+	github.com/omec-project/util v1.2.1
 	github.com/prometheus/client_golang v1.20.4
-	github.com/sirupsen/logrus v1.9.3
 	github.com/stretchr/testify v1.9.0
 	github.com/tim-ywliu/event v0.1.0
 	github.com/urfave/cli v1.22.15
+	go.uber.org/zap v1.27.0
 	gopkg.in/yaml.v2 v2.4.0
 )
 
@@ -58,7 +57,6 @@ require (
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
 	github.com/ugorji/go/codec v1.2.12 // indirect
 	go.uber.org/multierr v1.10.0 // indirect
-	go.uber.org/zap v1.27.0 // indirect
 	golang.org/x/arch v0.8.0 // indirect
 	golang.org/x/crypto v0.27.0 // indirect
 	golang.org/x/net v0.29.0 // indirect

diff --git a/go.sum b/go.sum
@@ -1,8 +1,6 @@
 github.com/BurntSushi/toml v1.3.2/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
 github.com/antihax/optional v1.0.0 h1:xK2lYat7ZLaVVcIuj82J8kIro4V6kDe0AUDFboUCwcg=
 github.com/antihax/optional v1.0.0/go.mod h1:uupD/76wgC+ih3iEmQUL+0Ugr19nfwCT1kdvxnR2qWY=
-github.com/antonfisher/nested-logrus-formatter v1.3.1 h1:NFJIr+pzwv5QLHTPyKz9UMEoHck02Q9L0FP13b/xSbQ=
-github.com/antonfisher/nested-logrus-formatter v1.3.1/go.mod h1:6WTfyWFkBc9+zyBaKIqRrg/KwMqBbodBjgbHjDz7zjA=
 github.com/asaskevich/govalidator v0.0.0-20210307081110-f21760c49a8d h1:Byv0BzEl3/e6D5CLfI0j/7hiIEtvGVFPCZ7Ei2oq8iQ=
 github.com/asaskevich/govalidator v0.0.0-20210307081110-f21760c49a8d/go.mod h1:WaHUgvxTVq04UNunO+XhnAqY/wQc+bxr74GqbsZ/Jqw=
 github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
@@ -87,8 +85,8 @@ github.com/omec-project/config5g v1.5.0 h1:VC7uHIdg4S4F5onYvpFfaEAFBttWwWh6OSnNn
 github.com/omec-project/config5g v1.5.0/go.mod h1:yTjqsOjy8KQ8o4AlnPeZfP32CEvlm0kug3bMwZ3IDOQ=
 github.com/omec-project/openapi v1.3.1 h1:NCteMRdMtWnMhf1CXYduuLgeu8fEhc/7XO1CiE7fN3Y=
 github.com/omec-project/openapi v1.3.1/go.mod h1:cR6Iharp2TLOzEmskQ/EdCVFZnpKh0zTvUSSuyXAYLE=
-github.com/omec-project/util v1.1.0 h1:TUuLmzqTLChIEXQlK9g5Ihgmw4FUm/UJnjfu0wT8Gz0=
-github.com/omec-project/util v1.1.0/go.mod h1:BEv8nCokB4j0fgAQ6VVkKuQ2PSP3DJMEmz25pFMw5X8=
+github.com/omec-project/util v1.2.1 h1:+o5kbnZzKBmbqT4oprVGPgL0jH5b8BvRMfLye5srGQ4=
+github.com/omec-project/util v1.2.1/go.mod h1:kUF2LXhmtw+m7Bk5IGOMFLj7CA8VKtilLI/9QBJcfxE=
 github.com/pelletier/go-toml/v2 v2.2.2 h1:aYUidT7k73Pcl9nb2gScu7NSrKCSHIDE89b3+6Wq+LM=
 github.com/pelletier/go-toml/v2 v2.2.2/go.mod h1:1t835xjRzz80PqgE6HHgN2JOsmgYu/h4qDAS4n929Rs=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
@@ -108,8 +106,6 @@ github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjR
 github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog=
 github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
-github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
-github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
 github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
@@ -145,7 +141,6 @@ golang.org/x/net v0.29.0 h1:5ORfpBpCs4HzDYoodCDBbwHzdR5UrLBZ3sOnUJmFoHo=
 golang.org/x/net v0.29.0/go.mod h1:gLkgy8jTGERgjzMic6DS9+SP0ajcu6Xu3Orq/SpETg0=
 golang.org/x/oauth2 v0.23.0 h1:PbgcYx2W7i4LvjJWEbf0ngHV6qJYr86PkAV3bXdLEbs=
 golang.org/x/oauth2 v0.23.0/go.mod h1:XYTD2NtWslqkgxebSiOHnXEap4TF09sJSc7H1sXbhtI=
-golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/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.25.0 h1:r+8e+loiHxRqhXVl6ML1nO3l1+oFoWbnlu2Ehimmi34=

diff --git a/httpcallback/router.go b/httpcallback/router.go
@@ -10,7 +10,7 @@ import (
 
 	"github.com/gin-gonic/gin"
 	"github.com/omec-project/pcf/logger"
-	logger_util "github.com/omec-project/util/logger"
+	utilLogger "github.com/omec-project/util/logger"
 )
 
 // Route is the information for every URI.
@@ -30,7 +30,7 @@ type Routes []Route
 
 // NewRouter returns a new router.
 func NewRouter() *gin.Engine {
-	router := logger_util.NewGinWithLogrus(logger.GinLog)
+	router := utilLogger.NewGinWithZap(logger.GinLog)
 	AddService(router)
 	return router
 }

diff --git a/internal/notifyevent/send_smpolicy_termination.go b/internal/notifyevent/send_smpolicy_termination.go
@@ -23,13 +23,13 @@ type SendSMpolicyTerminationNotifyEvent struct {
 }
 
 func (e SendSMpolicyTerminationNotifyEvent) Handle() {
-	logger.NotifyEventLog.Infof("Handle SendSMpolicyTerminationNotifyEvent\n")
+	logger.NotifyEventLog.Infoln("handle SendSMpolicyTerminationNotifyEvent")
 	if e.uri == "" {
 		logger.NotifyEventLog.Warnln("SM Policy Termination Request Notification Error[URI is empty]")
 		return
 	}
 	client := util.GetNpcfSMPolicyCallbackClient()
-	logger.NotifyEventLog.Infof("SM Policy Termination Request Notification to SMF")
+	logger.NotifyEventLog.Infoln("SM Policy Termination Request Notification to SMF")
 	rsp, err := client.DefaultCallbackApi.SmPolicyControlTerminationRequestNotification(context.Background(), e.uri, *e.request)
 	if err != nil {
 		if rsp != nil {
@@ -48,8 +48,8 @@ func (e SendSMpolicyTerminationNotifyEvent) Handle() {
 		}
 	}()
 	if rsp.StatusCode != http.StatusNoContent {
-		logger.NotifyEventLog.Warnf("SM Policy Termination Request Notification  Failed")
+		logger.NotifyEventLog.Warnln("SM Policy Termination Request Notification Failed")
 	} else {
-		logger.NotifyEventLog.Tracef("SM Policy Termination Request Notification Success")
+		logger.NotifyEventLog.Debugln("SM Policy Termination Request Notification Success")
 	}
 }
diff --git a/internal/notifyevent/send_smpolicy_update.go b/internal/notifyevent/send_smpolicy_update.go
@@ -23,13 +23,13 @@ type SendSMpolicyUpdateNotifyEvent struct {
 }
 
 func (e SendSMpolicyUpdateNotifyEvent) Handle() {
-	logger.NotifyEventLog.Infof("Handle SendSMpolicyUpdateNotifyEvent\n")
+	logger.NotifyEventLog.Infoln("handle SendSMpolicyUpdateNotifyEvent")
 	if e.uri == "" {
-		logger.NotifyEventLog.Warnln("SM Policy Update Notification Error[URI is empty]")
+		logger.NotifyEventLog.Warnln("SM Policy Update Notification Error [URI is empty]")
 		return
 	}
 	client := util.GetNpcfSMPolicyCallbackClient()
-	logger.NotifyEventLog.Infof("Send SM Policy Update Notification to SMF")
+	logger.NotifyEventLog.Infoln("send SM Policy Update Notification to SMF")
 	_, httpResponse, err := client.DefaultCallbackApi.SmPolicyUpdateNotification(context.Background(), e.uri, *e.request)
 	if err != nil {
 		if httpResponse != nil {
@@ -39,7 +39,7 @@ func (e SendSMpolicyUpdateNotifyEvent) Handle() {
 		}
 		return
 	} else if httpResponse == nil {
-		logger.NotifyEventLog.Warnln("SM Policy Update Notification Failed[HTTP Response is nil]")
+		logger.NotifyEventLog.Warnln("SM Policy Update Notification Failed [HTTP Response is nil]")
 		return
 	}
 	defer func() {
@@ -48,8 +48,8 @@ func (e SendSMpolicyUpdateNotifyEvent) Handle() {
 		}
 	}()
 	if httpResponse.StatusCode != http.StatusOK && httpResponse.StatusCode != http.StatusNoContent {
-		logger.NotifyEventLog.Warnf("SM Policy Update Notification Failed")
+		logger.NotifyEventLog.Warnln("SM Policy Update Notification Failed")
 	} else {
-		logger.NotifyEventLog.Tracef("SM Policy Update Notification Success")
+		logger.NotifyEventLog.Debugln("SM Policy Update Notification Success")
 	}
 }