-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(logging): integrate slog with fx for structured logging
- Replace bliss.GetFxLogger with logfx.GetFxLogger - Add logfx module for structured logging - Implement RegisterLogger and GetFxLogger functions - Update LoadConfig and RegisterConfig for unified config management - Remove RegisterHttpConfig, integrate HttpConfig provision into LoadConfig - Enhance configfx loader to support boolean type conversion - Replace logger.Info references with slogger
- Loading branch information
Showing
10 changed files
with
357 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
package logfx | ||
|
||
type Config struct { | ||
Level string `conf:"LEVEL" default:"INFO"` | ||
AddSource bool `conf:"ADD_SOURCE" default:"false"` | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,147 @@ | ||
package logfx | ||
|
||
import ( | ||
"log/slog" | ||
|
||
"go.uber.org/fx/fxevent" | ||
) | ||
|
||
type ( | ||
FxLogger struct { | ||
*slog.Logger | ||
} | ||
) | ||
|
||
func GetFxLogger(logger *slog.Logger) fxevent.Logger { //nolint:ireturn | ||
return FxLogger{logger} | ||
} | ||
|
||
func (l FxLogger) LogEvent(event fxevent.Event) { //nolint:cyclop | ||
switch e := event.(type) { //nolint:varnamelen | ||
case *fxevent.OnStartExecuting: | ||
l.logOnStartExecuting(e) | ||
case *fxevent.OnStartExecuted: | ||
l.logOnStartExecuted(e) | ||
case *fxevent.OnStopExecuting: | ||
l.logOnStopExecuting(e) | ||
case *fxevent.OnStopExecuted: | ||
l.logOnStopExecuted(e) | ||
case *fxevent.Supplied: | ||
l.logSupplied(e) | ||
case *fxevent.Provided: | ||
l.logProvided(e) | ||
case *fxevent.Decorated: | ||
l.logDecorated(e) | ||
case *fxevent.Invoking: | ||
l.logInvoking(e) | ||
case *fxevent.Started: | ||
l.logStarted(e) | ||
case *fxevent.LoggerInitialized: | ||
l.logLoggerInitialized(e) | ||
} | ||
} | ||
|
||
func (l *FxLogger) logOnStartExecuting(e *fxevent.OnStartExecuting) { | ||
l.Logger.Debug( | ||
"OnStart hook executing: ", | ||
slog.String("callee", e.FunctionName), | ||
slog.String("caller", e.CallerName), | ||
) | ||
} | ||
|
||
func (l *FxLogger) logOnStartExecuted(e *fxevent.OnStartExecuted) { //nolint:varnamelen | ||
if e.Err != nil { | ||
l.Logger.Debug( | ||
"OnStart hook failed: ", | ||
slog.String("callee", e.FunctionName), | ||
slog.String("caller", e.CallerName), | ||
slog.Any("error", e.Err), | ||
) | ||
|
||
return | ||
} | ||
|
||
l.Logger.Debug( | ||
"OnStart hook executed: ", | ||
slog.String("callee", e.FunctionName), | ||
slog.String("caller", e.CallerName), | ||
slog.String("runtime", e.Runtime.String()), | ||
) | ||
} | ||
|
||
func (l *FxLogger) logOnStopExecuting(e *fxevent.OnStopExecuting) { | ||
l.Logger.Debug( | ||
"OnStop hook executing: ", | ||
slog.String("callee", e.FunctionName), | ||
slog.String("caller", e.CallerName), | ||
) | ||
} | ||
|
||
func (l *FxLogger) logOnStopExecuted(e *fxevent.OnStopExecuted) { //nolint:varnamelen | ||
if e.Err != nil { | ||
l.Logger.Debug( | ||
"OnStop hook failed: ", | ||
slog.String("callee", e.FunctionName), | ||
slog.String("caller", e.CallerName), | ||
slog.Any("error", e.Err), | ||
) | ||
|
||
return | ||
} | ||
|
||
l.Logger.Debug( | ||
"OnStop hook executed: ", | ||
slog.String("callee", e.FunctionName), | ||
slog.String("caller", e.CallerName), | ||
slog.String("runtime", e.Runtime.String()), | ||
) | ||
} | ||
|
||
func (l *FxLogger) logSupplied(e *fxevent.Supplied) { | ||
l.Logger.Debug( | ||
"supplied: ", | ||
slog.String("type", e.TypeName), | ||
slog.Any("error", e.Err), | ||
) | ||
} | ||
|
||
func (l *FxLogger) logProvided(e *fxevent.Provided) { | ||
for _, rtype := range e.OutputTypeNames { | ||
l.Logger.Debug( | ||
"provided: ", | ||
slog.String("constructor", e.ConstructorName), | ||
slog.String("type", rtype), | ||
) | ||
} | ||
} | ||
|
||
func (l *FxLogger) logDecorated(e *fxevent.Decorated) { | ||
for _, rtype := range e.OutputTypeNames { | ||
l.Logger.Debug("decorated: ", | ||
slog.String("decorator", e.DecoratorName), | ||
slog.String("type", rtype), | ||
) | ||
} | ||
} | ||
|
||
func (l *FxLogger) logInvoking(e *fxevent.Invoking) { | ||
l.Logger.Debug( | ||
"invoking: ", | ||
slog.String("function", e.FunctionName), | ||
) | ||
} | ||
|
||
func (l *FxLogger) logStarted(e *fxevent.Started) { | ||
if e.Err == nil { | ||
l.Logger.Debug("started") | ||
} | ||
} | ||
|
||
func (l *FxLogger) logLoggerInitialized(e *fxevent.LoggerInitialized) { | ||
if e.Err == nil { | ||
l.Logger.Debug( | ||
"initialized: custom fxevent.Logger", | ||
slog.String("constructor", e.ConstructorName), | ||
) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
package logfx | ||
|
||
import ( | ||
"log/slog" | ||
"os" | ||
|
||
"go.uber.org/fx" | ||
) | ||
|
||
//nolint:gochecknoglobals | ||
var Module = fx.Module( | ||
"log", | ||
fx.Provide( | ||
RegisterLogger, | ||
), | ||
) | ||
|
||
func RegisterLogger(config *Config) (*slog.Logger, error) { | ||
var level slog.Level | ||
|
||
err := level.UnmarshalText([]byte(config.Level)) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
handler := slog.NewJSONHandler(os.Stderr, &slog.HandlerOptions{ | ||
Level: level, | ||
ReplaceAttr: replaceAttr, | ||
AddSource: config.AddSource, | ||
}) | ||
|
||
logger := slog.New(handler) | ||
|
||
slog.SetDefault(logger) | ||
|
||
return logger, nil | ||
} |
Oops, something went wrong.