feat!: Provide logger through depinject

core/log/service.go

@@ -0,0 +1,25 @@
+package log
+
+// Service is the same as the Cosmos SDK logger interface (copied from cosmossdk.io/log).
+// All functionalities of the logger are available through the Impl() method.
+type Service interface {
+	// Info takes a message and a set of key/value pairs and logs with level INFO.
+	// The key of the tuple must be a string.
+	Info(msg string, keyVals ...any)
+
+	// Error takes a message and a set of key/value pairs and logs with level ERR.
+	// The key of the tuple must be a string.
+	Error(msg string, keyVals ...any)
+
+	// Debug takes a message and a set of key/value pairs and logs with level DEBUG.
+	// The key of the tuple must be a string.
+	Debug(msg string, keyVals ...any)
+
+	// With returns a new wrapped logger with additional context provided by a set.
+	With(keyVals ...any) Service
+
+	// Impl returns the underlying logger implementation.
+	// It is used to access the full functionalities of the underlying logger.
+	// Advanced users can type cast the returned value to the actual logger.
+	Impl() any
+}

docs/architecture/adr-063-core-module-api.md

@@ -160,6 +160,47 @@ the block or app hash is left to the runtime to specify).
 Events emitted by `EmitKVEvent` and `EmitProtoEventNonConsensus` are not considered to be part of consensus and cannot be observed
 by other modules. If there is a client-side need to add events in patch releases, these methods can be used.
 
+#### Logger Service
+
+The logger `Service` will be defined in the `cosmossdk.io/core/log` package and it implements the full Cosmos SDK logger interface.
+
+```go
+package log
+
+// Service is the same as the Cosmos SDK logger interface (copied from cosmossdk.io/log).
+// All functionalities of the logger are available through the Impl() method.
+type Service interface {
+	// Info takes a message and a set of key/value pairs and logs with level INFO.
+	// The key of the tuple must be a string.
+	Info(msg string, keyVals ...any)
+
+	// Error takes a message and a set of key/value pairs and logs with level ERR.
+	// The key of the tuple must be a string.
+	Error(msg string, keyVals ...any)
+
+	// Debug takes a message and a set of key/value pairs and logs with level DEBUG.
+	// The key of the tuple must be a string.
+	Debug(msg string, keyVals ...any)
+
+	// With returns a new wrapped logger with additional context provided by a set.
+	With(keyVals ...any) Service
+
+	// Impl returns the underlying logger implementation.
+	// It is used to access the full functionalities of the underlying logger.
+	// Advanced users can type cast the returned value to the actual logger.
+	Impl() any
+}
+```
+
+Modules using this service should not need to add any context related to the module name,
+as the runtime will do this when providing, following the current pattern in the SDK:
+
+```go
+func ProvideLoggerService(key depinject.ModuleKey, app *AppBuilder) log.Service {
+	return LoggerService{app.app.Logger().With("module", fmt.Sprintf("x/%s", key.Name()))}
+}
+```
+
 ### Core `AppModule` extension interfaces
 
 

go.mod

@@ -171,6 +171,7 @@ replace (
 	github.com/gin-gonic/gin => github.com/gin-gonic/gin v1.8.1
 	// Downgraded to avoid bugs in following commits which caused simulations to fail.
 	github.com/syndtr/goleveldb => github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7
+	cosmossdk.io/core => ./core
 )
 
 retract (

runtime/logger.go

@@ -0,0 +1,30 @@
+package runtime
+
+import (
+	corelog "cosmossdk.io/core/log"
+	"cosmossdk.io/log"
+)
+
+type LoggerService struct {
+	logger log.Logger
+}
+
+func (ls LoggerService) Info(msg string, keyVals ...any) {
+	ls.logger.Info(msg, keyVals...)
+}
+
+func (ls LoggerService) Error(msg string, keyVals ...any) {
+	ls.logger.Error(msg, keyVals...)
+}
+
+func (ls LoggerService) Debug(msg string, keyVals ...any) {
+	ls.logger.Debug(msg, keyVals...)
+}
+
+func (ls LoggerService) With(keyVals ...any) corelog.Service {
+	return LoggerService{logger: ls.logger.With(keyVals...)}
+}
+
+func (ls LoggerService) Impl() any {
+	return ls.logger
+}

runtime/module.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"os"
 
+	"cosmossdk.io/core/log"
 	"cosmossdk.io/core/store"
 	"github.com/cosmos/gogoproto/proto"
 	"google.golang.org/protobuf/reflect/protodesc"
@@ -65,6 +66,7 @@ func init() {
 			ProvideMemoryStoreService,
 			ProvideTransientStoreService,
 			ProvideEventService,
+			ProvideLoggerService,
 		),
 		appmodule.Invoke(SetupAppBuilder),
 	)
@@ -209,3 +211,7 @@ func ProvideTransientStoreService(key depinject.ModuleKey, app *AppBuilder) stor
 func ProvideEventService() event.Service {
 	return EventService{}
 }
+
+func ProvideLoggerService(key depinject.ModuleKey, app *AppBuilder) log.Service {
+	return LoggerService{app.app.Logger().With("module", fmt.Sprintf("x/%s", key.Name()))}
+}