Merge pull request #77 from FIWARE/refactor/logger

Replace logrus with zap

Author: wistefan

Dockerfile

@@ -22,4 +22,6 @@ COPY --from=build /go/src/app/views ./views
 COPY --from=build /go/src/app/VCVerifier ./VCVerifier
 COPY --from=build /go/src/app/server.yaml ./server.yaml
 
+ENV GIN_MODE=release
+
 CMD ["./VCVerifier"]

config/config.go

@@ -1,15 +1,17 @@
 package config
 
+import "github.com/fiware/VCVerifier/logging"
+
 // CONFIGURATION STRUCTURE FOR THE VERIFIER CONFIG
 
 // general structure of the configuration file
 type Configuration struct {
-	Server     Server     `mapstructure:"server"`
-	Verifier   Verifier   `mapstructure:"verifier"`
-	Logging    Logging    `mapstructure:"logging"`
-	ConfigRepo ConfigRepo `mapstructure:"configRepo"`
-	M2M        M2M        `mapstructure:"m2m"`
-	Elsi       Elsi       `mapstructure:"elsi"`
+	Server     Server                `mapstructure:"server"`
+	Verifier   Verifier              `mapstructure:"verifier"`
+	Logging    logging.LoggingConfig `mapstructure:"logging"`
+	ConfigRepo ConfigRepo            `mapstructure:"configRepo"`
+	M2M        M2M                   `mapstructure:"m2m"`
+	Elsi       Elsi                  `mapstructure:"elsi"`
 }
 
 // general configuration to run the application
@@ -22,6 +24,15 @@ type Server struct {
 	TemplateDir string `mapstructure:"templateDir" default:"views/"`
 	// directory of static files to be provided, f.e. to be used inside the templates
 	StaticDir string `mapstructure:"staticDir" default:"views/static/"`
+
+	// ReadTimeout is the maximum duration for reading the entire request, including the body.
+	ReadTimeout int `mapstructure:"readTimeout" default:"5"`
+	// WriteTimeout is the maximum duration before timing out writes of the response.
+	WriteTimeout int `mapstructure:"writeTimeout" default:"10"`
+	// IdleTimeout is the maximum amount of time to wait for the next request when keep-alives are enabled.
+	IdleTimeout int `mapstructure:"idleTimeout" default:"120"`
+	// ShutdownTimeout is the time allowed for active requests to finish during shutdown.
+	ShutdownTimeout int `mapstructure:"shutdownTimeout" default:"5"`
 }
 
 // configuration for M2M interaction
@@ -42,18 +53,6 @@ type M2M struct {
 	KeyType string `mapstructure:"keyType" default:"RSAPS256"`
 }
 
-// logging config
-type Logging struct {
-	// loglevel to be used - can be DEBUG, INFO, WARN or ERROR
-	Level string `mapstructure:"level" default:"INFO"`
-	// should the logging in a structured json format
-	JsonLogging bool `mapstructure:"jsonLogging" default:"true"`
-	// should requests be logged
-	LogRequests bool `mapstructure:"logRequests" default:"true"`
-	// list of paths to be ignored on request logging(could be often called operational endpoints like f.e. metrics)
-	PathsToSkip []string `mapstructure:"pathsToSkip"`
-}
-
 // configuration specific to the functionality of the verifier
 type Verifier struct {
 	// did to be used by the verifier

config/configClient_test.go

@@ -17,6 +17,14 @@ type MockHttpClient struct {
 	Answer string
 }
 
+var LOGGING_CONFIG = logging.LoggingConfig{
+	Level:         "DEBUG",
+	JsonLogging:   true,
+	LogRequests:   true,
+	PathsToSkip:   []string{},
+	DisableCaller: false,
+}
+
 func (mhc MockHttpClient) Get(url string) (resp *http.Response, err error) {
 	return &http.Response{StatusCode: 200, Body: io.NopCloser(strings.NewReader(mhc.Answer))}, nil
 }
@@ -31,7 +39,7 @@ func readFile(filename string, t *testing.T) string {
 
 func Test_getScope(t *testing.T) {
 
-	logging.Configure(true, "DEBUG", true, []string{})
+	logging.Configure(LOGGING_CONFIG)
 	type test struct {
 		testName          string
 		testScope         string

config/data/config_test.yaml

@@ -2,12 +2,16 @@ server:
   port: 3000
   staticDir: "views/static"
   templateDir: "views/"
-
+  ReadTimeout: 100
+  WriteTimeout: 200
+  IdleTimeout: 300
+  ShutdownTimeout:  400
 logging:
   level: "DEBUG"
   jsonLogging: true
   logRequests: true
   pathsToSkip: [/health]
+  disableCaller: true
 
 verifier:
   did: "did:key:somekey"
@@ -26,10 +30,10 @@ verifier:
 ssiKit:
   auditorURL: http://waltid:7003
 
-m2m: 
+m2m:
   authEnabled: false
 configRepo:
-  services: 
+  services:
     - id: testService
       defaultOidcScope: someScope
       oidcScopes:
@@ -45,9 +49,8 @@ configRepo:
             id: my-pd
             input_descriptors:
               - id: my-descriptor
-                constraints: 
-                  fields: 
+                constraints:
+                  fields:
                     - id: my-field
                       path:
                         - $.vc.my.claim
-        

config/provider_test.go

@@ -23,9 +23,13 @@ func Test_ReadConfig(t *testing.T) {
 			args{"data/config_test.yaml"},
 			Configuration{
 				Server: Server{
-					Port:        3000,
-					TemplateDir: "views/",
-					StaticDir:   "views/static",
+					Port:            3000,
+					TemplateDir:     "views/",
+					StaticDir:       "views/static",
+					ReadTimeout:     100,
+					WriteTimeout:    200,
+					IdleTimeout:     300,
+					ShutdownTimeout: 400,
 				},
 				Verifier: Verifier{
 					Did:            "did:key:somekey",
@@ -51,13 +55,14 @@ func Test_ReadConfig(t *testing.T) {
 					KeyAlgorithm:          "RS256",
 					GenerateKey:           true,
 					SupportedModes:        []string{"urlEncoded"},
-					JwtExpiration:		 30,
+					JwtExpiration:         30,
 				},
-				Logging: Logging{
-					Level:       "DEBUG",
-					JsonLogging: true,
-					LogRequests: true,
-					PathsToSkip: []string{"/health"},
+				Logging: logging.LoggingConfig{
+					Level:         "DEBUG",
+					JsonLogging:   true,
+					LogRequests:   true,
+					PathsToSkip:   []string{"/health"},
+					DisableCaller: true,
 				},
 				ConfigRepo: ConfigRepo{
 					ConfigEndpoint: "",
@@ -106,8 +111,12 @@ func Test_ReadConfig(t *testing.T) {
 			args{"data/empty_test.yaml"},
 			Configuration{
 				Server: Server{Port: 8080,
-					TemplateDir: "views/",
-					StaticDir:   "views/static/",
+					TemplateDir:     "views/",
+					StaticDir:       "views/static/",
+					ReadTimeout:     5,
+					WriteTimeout:    10,
+					IdleTimeout:     120,
+					ShutdownTimeout: 5,
 				},
 				Verifier: Verifier{Did: "",
 					TirAddress:     "",
@@ -120,11 +129,12 @@ func Test_ReadConfig(t *testing.T) {
 					SupportedModes: []string{"urlEncoded"},
 					JwtExpiration:  30,
 				},
-				Logging: Logging{
-					Level:       "INFO",
-					JsonLogging: true,
-					LogRequests: true,
-					PathsToSkip: nil,
+				Logging: logging.LoggingConfig{
+					Level:         "INFO",
+					JsonLogging:   true,
+					LogRequests:   true,
+					PathsToSkip:   nil,
+					DisableCaller: false,
 				},
 				M2M:        M2M{AuthEnabled: false, VerificationMethod: "JsonWebKey2020", SignatureType: "JsonWebSignature2020", KeyType: "RSAPS256"},
 				ConfigRepo: ConfigRepo{UpdateInterval: 30},

go.mod

@@ -85,6 +85,8 @@ require (
 	github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
 	go.opentelemetry.io/otel v1.10.0 // indirect
 	go.opentelemetry.io/otel/trace v1.10.0 // indirect
+	go.uber.org/multierr v1.11.0 // indirect
+	go.uber.org/zap v1.27.1 // indirect
 	golang.org/x/sync v0.13.0 // indirect
 	golang.org/x/term v0.31.0 // indirect
 	golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2 // indirect
@@ -111,7 +113,6 @@ require (
 	github.com/pelletier/go-toml/v2 v2.0.8 // indirect
 	github.com/penglongli/gin-metrics v0.1.10
 	github.com/procyon-projects/chrono v1.1.2
-	github.com/sirupsen/logrus v1.9.3
 	github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
 	github.com/ugorji/go/codec v1.2.11 // indirect

go.sum

@@ -488,6 +488,10 @@ go.opentelemetry.io/otel v1.10.0 h1:Y7DTJMR6zs1xkS/upamJYk0SxxN4C9AqRd77jmZnyY4=
 go.opentelemetry.io/otel v1.10.0/go.mod h1:NbvWjCthWHKBEUMpf0/v8ZRZlni86PpGFEMA9pnQSnQ=
 go.opentelemetry.io/otel/trace v1.10.0 h1:npQMbR8o7mum8uF95yFbOEJffhs1sbCOfDh8zAJiH5E=
 go.opentelemetry.io/otel/trace v1.10.0/go.mod h1:Sij3YYczqAdz+EhmGhE6TpTxUO5/F/AzrK+kxfGqySM=
+go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0=
+go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
+go.uber.org/zap v1.27.1 h1:08RqriUEv8+ArZRYSTXy1LeBScaMpVSTBhCeaZYfMYc=
+go.uber.org/zap v1.27.1/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E=
 golang.org/x/arch v0.0.0-20210923205945-b76863e36670/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8=
 golang.org/x/arch v0.5.0 h1:jpGode6huXQxcskEIpOCvrU+tzo81b6+oFLUYXWtH/Y=
 golang.org/x/arch v0.5.0/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8=