docs: Document the Kratos logging adapter

coopnorge · Sep 16, 2024 · af79082 · af79082
1 parent 295e6d6
commit af79082
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/adapter/kratos/log.go b/adapter/kratos/log.go
@@ -21,6 +21,7 @@ type LoggerKratosAdapter struct {
 //
 //	import (
 //		"github.com/coopnorge/go-logger"
+//		"github.com/coopnorge/go-logger/adapter/kratos"
 //		"github.com/go-kratos/kratos/v2/log"
 //	)
 //

diff --git a/docs/index.md b/docs/index.md
@@ -141,6 +141,25 @@ func main() {
 }
 ```
 
+### Kratos
+
+To ensure that Kratos outputs logs in the correct format Kratos must be
+configured with a custom logger.
+
+```go
+	package main
+
+	import (
+		"github.com/coopnorge/go-logger"
+		"github.com/coopnorge/go-logger/adapter/kratos"
+		"github.com/go-kratos/kratos/v2/log"
+	)
+
+	func main() {
+		log.SetLogger(logs.NewLoggerKratosAdapter(logger.Global()))
+	}
+```
+
 ## Hooks
 
 Hooks are functions that are triggered on all log-entries and allow for data to