feat: use sharedlogging package from go-libs

cmd/container.go

@@ -4,16 +4,18 @@ import (
 	"fmt"
 	"github.com/gin-contrib/cors"
 	"github.com/gin-gonic/gin"
+	"github.com/numary/go-libs/sharedlogging"
+	"github.com/numary/go-libs/sharedlogging/sharedlogginglogrus"
 	"github.com/numary/ledger/pkg/api"
 	"github.com/numary/ledger/pkg/api/controllers"
 	"github.com/numary/ledger/pkg/api/middlewares"
 	"github.com/numary/ledger/pkg/api/routes"
 	"github.com/numary/ledger/pkg/ledger"
-	"github.com/numary/ledger/pkg/logging"
 	"github.com/numary/ledger/pkg/opentelemetry/opentelemetrymetrics"
 	"github.com/numary/ledger/pkg/opentelemetry/opentelemetrytraces"
 	"github.com/numary/ledger/pkg/storage"
 	"github.com/numary/ledger/pkg/storage/sqlstorage"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/viper"
 	"go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin"
 	"go.opentelemetry.io/otel/metric"
@@ -32,7 +34,9 @@ func NewContainer(v *viper.Viper, options ...fx.Option) *fx.App {
 		options = append(options, fx.NopLogger)
 	}
 
-	options = append(options, logging.LogrusModule())
+	l := logrus.New()
+	loggerFactory := sharedlogging.StaticLoggerFactory(sharedlogginglogrus.New(l))
+	sharedlogging.SetFactory(loggerFactory)
 
 	// Handle OpenTelemetry
 	if v.GetBool(otelTracesFlag) {
@@ -142,7 +146,6 @@ func NewContainer(v *viper.Viper, options ...fx.Option) *fx.App {
 	options = append(options, routes.ProvideMiddlewares(func(params struct {
 		fx.In
 		TracerProvider trace.TracerProvider `optional:"true"`
-		Logger         logging.Logger
 	}) []gin.HandlerFunc {
 		res := make([]gin.HandlerFunc, 0)
 
@@ -155,7 +158,7 @@ func NewContainer(v *viper.Viper, options ...fx.Option) *fx.App {
 		if viper.GetBool(otelTracesFlag) {
 			res = append(res, otelgin.Middleware("ledger", otelgin.WithTracerProvider(params.TracerProvider)))
 		}
-		res = append(res, middlewares.Log(params.Logger))
+		res = append(res, middlewares.Log())
 		var writer io.Writer = os.Stderr
 		if viper.GetBool(otelTracesFlag) {
 			writer = ioutil.Discard

docker-compose.override.yml

@@ -13,6 +13,8 @@ services:
       NUMARY_OTEL_TRACES_EXPORTER_JAEGER_ENDPOINT: http://jaeger:14268/api/traces
       NUMARY_OTEL_TRACES_EXPORTER_JAEGER_INSECURE: "true"
       NUMARY_OTEL_METRICS: "false"
+    depends_on:
+      - jaeger
 
   jaeger:
     image: jaegertracing/all-in-one:1.31

go.mod

@@ -40,6 +40,6 @@ require (
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
-	github.com/numary/go-libs v0.0.0-20220224131631-02329283c5bd
+	github.com/numary/go-libs v0.0.0-20220301123239-18e848add472
 	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b
 )

go.sum

@@ -603,6 +603,8 @@ github.com/numary/go-libs v0.0.0-20220224130919-9d6ff19c1eb6 h1:YSu6sZOVwTsX2wH2
 github.com/numary/go-libs v0.0.0-20220224130919-9d6ff19c1eb6/go.mod h1:kp6/a0l1j6I/SXAVxKuQM8qNGNmKssXDsi84USBMkwM=
 github.com/numary/go-libs v0.0.0-20220224131631-02329283c5bd h1:xIu4Wk6uNmu22TbgrTHkjiVbqVZdlic5LvGJjUYzXcE=
 github.com/numary/go-libs v0.0.0-20220224131631-02329283c5bd/go.mod h1:kp6/a0l1j6I/SXAVxKuQM8qNGNmKssXDsi84USBMkwM=
+github.com/numary/go-libs v0.0.0-20220301123239-18e848add472 h1:X2/xAxFKRMLNAsvPazgtO8aw7ka3bIAnJW1ah1lRt2w=
+github.com/numary/go-libs v0.0.0-20220301123239-18e848add472/go.mod h1:PcMl7qlpi3hJDDgoamQm5KIVCIVCCv1onU3y2iDQh68=
 github.com/numary/ledger v0.0.0-20210702172952-a5bd30e551d0/go.mod h1:u2K28z9TDYd6id1qeD2uv7JDlajuRZ0fvOnCeDZmDxk=
 github.com/numary/ledger v0.0.0-20211227131550-dc7b78f85b5b/go.mod h1:uovuDsK7Gs7duqKQ9PgaFulJnPTDftGdR/n3rBRzNIs=
 github.com/numary/machine v0.0.0-20210702091459-23a82555adbf/go.mod h1:WAFvefAGYNjdDmPtDoZ305F58QDtUJyB0QWN3vzSZao=

pkg/api/api_test.go

@@ -10,7 +10,6 @@ import (
 	"github.com/numary/ledger/pkg/core"
 	"github.com/numary/ledger/pkg/ledger"
 	"github.com/numary/ledger/pkg/ledgertesting"
-	"github.com/numary/ledger/pkg/logging"
 	"github.com/numary/ledger/pkg/storage"
 	"github.com/spf13/viper"
 	"github.com/stretchr/testify/assert"
@@ -34,7 +33,6 @@ func withNewModule(t *testing.T, options ...fx.Option) {
 		ledger.ResolveModule(),
 		storage.DefaultModule(),
 		ledgertesting.StorageModule(),
-		logging.LogrusModule(),
 		fx.NopLogger,
 	}, options...)
 	options = append(options, fx.Invoke(func() {

pkg/api/controllers/script_controller.go

@@ -5,7 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"github.com/numary/go-libs/sharedapi"
-	"github.com/numary/ledger/pkg/logging"
+	"github.com/numary/go-libs/sharedlogging"
 	"net/http"
 	"strings"
 
@@ -35,14 +35,11 @@ func EncodeLink(errStr string) string {
 // ScriptController -
 type ScriptController struct {
 	BaseController
-	Logger logging.Logger
 }
 
 // NewScriptController -
-func NewScriptController(logger logging.Logger) ScriptController {
-	return ScriptController{
-		Logger: logger,
-	}
+func NewScriptController() ScriptController {
+	return ScriptController{}
 }
 
 func (ctl *ScriptController) PostScript(c *gin.Context) {
@@ -71,7 +68,7 @@ func (ctl *ScriptController) PostScript(c *gin.Context) {
 			code = scriptError.Code
 			message = scriptError.Message
 		} else {
-			ctl.Logger.Error(c.Request.Context(), "internal errors executing script: %s", err)
+			sharedlogging.GetLogger(c.Request.Context()).Errorf("internal errors executing script: %s", err)
 		}
 		res.ErrorResponse = sharedapi.ErrorResponse{
 			ErrorCode:    code,

pkg/api/internal/testing.go

@@ -10,7 +10,6 @@ import (
 	"github.com/numary/ledger/pkg/core"
 	"github.com/numary/ledger/pkg/ledger"
 	"github.com/numary/ledger/pkg/ledgertesting"
-	"github.com/numary/ledger/pkg/logging"
 	"github.com/numary/ledger/pkg/storage"
 	"github.com/pborman/uuid"
 	"github.com/stretchr/testify/assert"
@@ -169,7 +168,6 @@ func WithNewModule(t *testing.T, options ...fx.Option) {
 		ledger.ResolveModule(),
 		storage.DefaultModule(),
 		ledgertesting.StorageModule(),
-		logging.LogrusModule(),
 		fx.NopLogger,
 	}, options...)
 	options = append(options, fx.Invoke(func() {

pkg/api/middlewares/ledger_middleware.go

@@ -2,25 +2,22 @@ package middlewares
 
 import (
 	"github.com/gin-gonic/gin"
+	"github.com/numary/go-libs/sharedlogging"
 	"github.com/numary/ledger/pkg/api/controllers"
 	"github.com/numary/ledger/pkg/ledger"
-	"github.com/numary/ledger/pkg/logging"
 )
 
 // LedgerMiddleware struct
 type LedgerMiddleware struct {
 	resolver *ledger.Resolver
-	logger   logging.Logger
 }
 
 // NewLedgerMiddleware
 func NewLedgerMiddleware(
 	resolver *ledger.Resolver,
-	logger logging.Logger,
 ) LedgerMiddleware {
 	return LedgerMiddleware{
 		resolver: resolver,
-		logger:   logger,
 	}
 }
 
@@ -41,7 +38,7 @@ func (m *LedgerMiddleware) LedgerMiddleware() gin.HandlerFunc {
 		defer func() {
 			err := l.Close(c.Request.Context())
 			if err != nil {
-				m.logger.Warn(c.Request.Context(), "error closing ledger: %s", err)
+				sharedlogging.GetLogger(c.Request.Context()).Errorf("error closing ledger: %s", err)
 			}
 		}()
 		c.Set("ledger", l)

pkg/api/middlewares/log_middleware.go

@@ -2,22 +2,22 @@ package middlewares
 
 import (
 	"github.com/gin-gonic/gin"
-	"github.com/numary/ledger/pkg/logging"
+	"github.com/numary/go-libs/sharedlogging"
 	"time"
 )
 
-func Log(logger logging.Logger) gin.HandlerFunc {
+func Log() gin.HandlerFunc {
 	return func(c *gin.Context) {
 		start := time.Now()
 		c.Next()
 		latency := time.Now().Sub(start)
-		logger.WithFields(map[string]interface{}{
+		sharedlogging.GetLogger(c.Request.Context()).WithFields(map[string]interface{}{
 			"status":     c.Writer.Status(),
 			"method":     c.Request.Method,
 			"path":       c.Request.URL.Path,
 			"ip":         c.ClientIP(),
 			"latency":    latency,
 			"user_agent": c.Request.UserAgent(),
-		}).Info(c.Request.Context(), "Request")
+		}).Info("Request")
 	}
 }

pkg/api/routes/routes.go

@@ -5,7 +5,6 @@ import (
 	"github.com/numary/ledger/pkg/api/controllers"
 	"github.com/numary/ledger/pkg/api/middlewares"
 	"github.com/numary/ledger/pkg/ledger"
-	"github.com/numary/ledger/pkg/logging"
 	"go.uber.org/fx"
 )
 
@@ -44,7 +43,6 @@ type Routes struct {
 	mappingController     controllers.MappingController
 	globalMiddlewares     []gin.HandlerFunc
 	perLedgerMiddlewares  []gin.HandlerFunc
-	logger                logging.Logger
 }
 
 // NewRoutes -
@@ -59,7 +57,6 @@ func NewRoutes(
 	accountController controllers.AccountController,
 	transactionController controllers.TransactionController,
 	mappingController controllers.MappingController,
-	logger logging.Logger,
 ) *Routes {
 	return &Routes{
 		globalMiddlewares:     globalMiddlewares,
@@ -72,7 +69,6 @@ func NewRoutes(
 		accountController:     accountController,
 		transactionController: transactionController,
 		mappingController:     mappingController,
-		logger:                logger,
 	}
 }
 

pkg/config/config.go

@@ -2,7 +2,7 @@ package config
 
 import (
 	"context"
-	"github.com/numary/ledger/pkg/logging"
+	"github.com/numary/go-libs/sharedlogging"
 	"github.com/spf13/viper"
 	"os"
 	"path/filepath"
@@ -26,7 +26,7 @@ type LedgerStorage struct {
 	Ledgers []string `json:"ledgers"`
 }
 
-func Remember(ctx context.Context, logger logging.Logger, ledger string) {
+func Remember(ctx context.Context, ledger string) {
 	ledgers := viper.GetStringSlice("ledgers")
 
 	for _, v := range ledgers {
@@ -52,14 +52,13 @@ func Remember(ctx context.Context, logger logging.Logger, ledger string) {
 	if writeTo == "" {
 		_, err := os.Create(userConfigFile)
 		if err != nil {
-			logger.Error(ctx, "failed to create config file: ledger %s will not be remembered", ledger)
+			sharedlogging.GetLogger(ctx).Errorf("failed to create config file: ledger %s will not be remembered", ledger)
 		}
 	}
 
 	viper.Set("ledgers", append(ledgers, ledger))
 	err = viper.WriteConfig()
 	if err != nil {
-		logger.Error(ctx, "failed to write config: ledger %s will not be remembered",
-			ledger)
+		sharedlogging.GetLogger(ctx).Errorf("failed to write config: ledger %s will not be remembered", ledger)
 	}
 }

pkg/ledger/ledger_test.go

@@ -7,7 +7,6 @@ import (
 	"flag"
 	"fmt"
 	"github.com/numary/ledger/pkg/ledgertesting"
-	"github.com/numary/ledger/pkg/logging"
 	"github.com/numary/ledger/pkg/storage"
 	"github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/assert"
@@ -28,7 +27,6 @@ func with(f func(l *Ledger)) {
 	app := fx.New(
 		fx.NopLogger,
 		ledgertesting.StorageModule(),
-		logging.LogrusModule(),
 		fx.Provide(storage.NewDefaultFactory),
 		fx.Invoke(func(lc fx.Lifecycle, storageFactory storage.Factory) {
 			lc.Append(fx.Hook{

pkg/ledger/resolver.go

@@ -2,7 +2,6 @@ package ledger
 
 import (
 	"context"
-	"github.com/numary/ledger/pkg/logging"
 	"github.com/numary/ledger/pkg/storage"
 	"github.com/numary/ledger/pkg/storage/sqlstorage"
 	"github.com/pkg/errors"
@@ -33,25 +32,16 @@ func WithLocker(locker Locker) ResolveOptionFn {
 	})
 }
 
-func WithLogger(logger logging.Logger) ResolveOptionFn {
-	return func(r *Resolver) error {
-		r.logger = logger
-		return nil
-	}
-}
-
 var DefaultResolverOptions = []ResolverOption{
-	WithStorageFactory(storage.NewDefaultFactory(sqlstorage.NewInMemorySQLiteDriver(logging.DefaultLogger()))),
+	WithStorageFactory(storage.NewDefaultFactory(sqlstorage.NewInMemorySQLiteDriver())),
 	WithLocker(NewInMemoryLocker()),
-	WithLogger(logging.DefaultLogger()),
 }
 
 type Resolver struct {
 	storageFactory    storage.Factory
 	locker            Locker
 	lock              sync.RWMutex
 	initializedStores map[string]struct{}
-	logger            logging.Logger
 }
 
 func NewResolver(options ...ResolverOption) *Resolver {
@@ -113,6 +103,5 @@ func ResolveModule() fx.Option {
 			fx.Annotate(NewResolver, fx.ParamTags(ResolverOptionsKey)),
 		),
 		ProvideResolverOption(WithStorageFactory),
-		ProvideResolverOption(WithLogger),
 	)
 }

pkg/ledgertesting/db.go

@@ -3,7 +3,6 @@ package ledgertesting
 import (
 	"context"
 	"fmt"
-	"github.com/numary/ledger/pkg/logging"
 	"github.com/numary/ledger/pkg/storage"
 	"github.com/numary/ledger/pkg/storage/sqlstorage"
 	"github.com/pborman/uuid"
@@ -21,11 +20,11 @@ func StorageDriverName() string {
 	return "sqlite"
 }
 
-func Driver(logger logging.Logger) (storage.Driver, func(), error) {
+func Driver() (storage.Driver, func(), error) {
 	switch StorageDriverName() {
 	case "sqlite":
 		id := uuid.New()
-		return sqlstorage.NewOpenCloseDBDriver(logger, "sqlite", sqlstorage.SQLite, func(name string) string {
+		return sqlstorage.NewOpenCloseDBDriver("sqlite", sqlstorage.SQLite, func(name string) string {
 			return sqlstorage.SQLiteFileConnString(path.Join(
 				os.TempDir(),
 				fmt.Sprintf("%s_%s.db", id, name),
@@ -37,7 +36,6 @@ func Driver(logger logging.Logger) (storage.Driver, func(), error) {
 			return nil, nil, err
 		}
 		return sqlstorage.NewOpenCloseDBDriver(
-				logger,
 				"postgres",
 				sqlstorage.PostgreSQL,
 				func(name string) string {
@@ -52,8 +50,8 @@ func Driver(logger logging.Logger) (storage.Driver, func(), error) {
 
 func StorageModule() fx.Option {
 	return fx.Options(
-		fx.Provide(func(logger logging.Logger, lifecycle fx.Lifecycle) (storage.Driver, error) {
-			driver, stopFn, err := Driver(logger)
+		fx.Provide(func(lifecycle fx.Lifecycle) (storage.Driver, error) {
+			driver, stopFn, err := Driver()
 			if err != nil {
 				return nil, err
 			}