zapfx

Documentation

Index

• Constants
• Variables
• type NewMortarLogParams
• type NewMortarLogResult
  • func NewMortarProxy(p NewMortarLogParams) (NewMortarLogResult, error)
• type NewZapParams
• type NewZapResult
  • func NewZap(p NewZapParams) (NewZapResult, error)

Constants

const (
	// ConfigurationKey is the portion of the configuration that this package reads.
	ConfigurationKey = "logging"
)

Variables

var Module = fx.Options(fx.Provide(NewZap, NewMortarProxy))

Module provides a zap logger for structured logging.

In YAML, logging configuration might look like this:

logging:
  level: info
  development: false
  sampling:
    initial: 100
    thereafter: 100
  encoding: json

Types

type NewMortarLogParams

type NewMortarLogParams struct {
	fx.In

	Logger *zap.Logger
}

type NewMortarLogResult

type NewMortarLogResult struct {
	fx.Out

	Logger mortarLog.Logger
}

func NewMortarProxy

func NewMortarProxy(p NewMortarLogParams) (NewMortarLogResult, error)

type NewZapParams

type NewZapParams struct {
	fx.In

	Config    config.Provider
	Lifecycle fx.Lifecycle
}

NewZapParams defines the dependencies of the zapfx module.

type NewZapResult

type NewZapResult struct {
	fx.Out

	Level  zap.AtomicLevel
	Logger *zap.Logger
}

NewZapResult defines the objects that the zapfx module provides.

func NewZap

func NewZap(p NewZapParams) (NewZapResult, error)

NewZap exports functionality similar to Module, but allows the caller to wrap or modify NewZapResult. Most users should use Module instead.