fxslog

README

fxslog

a small shim package providing a slog logger for uber's fx library

Usage

The WithLogger function returns an fx.Option that configures fx to use a *slog.Logger for logging. Using this option requires that you provide a *slog.Logger.

func main() {
	flag.Parse()

	fx.New(
		//fx.WithLogger(
		//	func(logger *slog.Logger) fxevent.Logger {
		//		return &fxslog.SlogLogger{Logger: logger.With("component", "uber/fx")}
		//	},
		//),
        
        // This is a thin wrapper over the snippet from above.
        fxslog.WithLogger(),
        
        fx.Provide(
            // We still need to provide a logger. The fxslog.WithLogger 
            // returns a fx.Option that consumes *slog.Logger
            func() *slog.Logger{
                return slog.Default()
            },
        )
		...
	).Run()
}

Documentation

Index

• func WithLogger(opts ...Option) fx.Option
• type Option
• type SlogLogger
  • func New(logger *slog.Logger) *SlogLogger
  • func (l *SlogLogger) LogEvent(event fxevent.Event)
  • func (l *SlogLogger) UseContext(ctx context.Context)
  • func (l *SlogLogger) UseErrorLevel(level slog.Level)
  • func (l *SlogLogger) UseLogLevel(level slog.Level)

Functions

func WithLogger

func WithLogger(opts ...Option) fx.Option

WithLogger is an fx.Option that configures fx to

Types

type Option

type Option func(logger *slog.Logger) *slog.Logger

Option is an option to the WithLogger function.

type SlogLogger

type SlogLogger struct {
	Logger *slog.Logger
	// contains filtered or unexported fields
}

SlogLogger is a shim that allows uber/fx to use slog for logging.

func New

func New(logger *slog.Logger) *SlogLogger

New returns a new SlogLogger

func (*SlogLogger) LogEvent

func (l *SlogLogger) LogEvent(event fxevent.Event)

LogEvent logs the given event to the provided Zap logger.

func (*SlogLogger) UseContext

func (l *SlogLogger) UseContext(ctx context.Context)

UseContext sets the context that will be used when logging to slog.

func (*SlogLogger) UseErrorLevel

func (l *SlogLogger) UseErrorLevel(level slog.Level)

UseErrorLevel sets the level of error logs emitted by Fx to level.

func (*SlogLogger) UseLogLevel

func (l *SlogLogger) UseLogLevel(level slog.Level)

UseLogLevel sets the level of non-error logs emitted by Fx to level.