startup_base

Documentation

Index

• Variables
• func Close(closer io.Closer, onErrorMessage string)
• func Errorf(msg string, args ...interface{}) error
• func FatalOnError(err error, reason string, args ...interface{})
• func GetEnvironment() string
• func IsDevelopment() bool
• func IsProduction() bool
• func IsStaging() bool
• func IsTesting() bool
• func OpenWriter(name string) (*os.File, error)
• func PanicOnError(err error, msg string, args ...interface{})
• func Panicf(msg string, args ...interface{})
• type BaseOptions
  • func (opts *BaseOptions) Initialize()
• type LazyHandler
  • func (v *LazyHandler) Enabled(ctx context.Context, level slog.Level) bool
  • func (v *LazyHandler) Handle(ctx context.Context, record slog.Record) error
  • func (v *LazyHandler) WithAttrs(attrs []slog.Attr) slog.Handler
  • func (v *LazyHandler) WithGroup(name string) slog.Handler
• type StartupError

Variables

var (
	BuildPackage       string
	BuildGitHash       string
	BuildVersion       string
	BuildUnixTimestamp string
)

var LogLevel slog.LevelVar

Functions

func Close

func Close(closer io.Closer, onErrorMessage string)

func Errorf

func Errorf(msg string, args ...interface{}) error

func FatalOnError

func FatalOnError(err error, reason string, args ...interface{})

func GetEnvironment

func GetEnvironment() string

func IsDevelopment

func IsDevelopment() bool

func IsProduction

func IsProduction() bool

func IsStaging

func IsStaging() bool

func IsTesting

func IsTesting() bool

func OpenWriter

func OpenWriter(name string) (*os.File, error)

func PanicOnError

func PanicOnError(err error, msg string, args ...interface{})

func Panicf

func Panicf(msg string, args ...interface{})

Types

type BaseOptions

type BaseOptions struct {
	Logfile       string `long:"log-file" description:"Write logs to a different file. Defaults to stdout."`
	ForceColor    bool   `long:"log-color" description:"Forces colored output even on non TTYs."`
	JSONFormatter bool   `long:"log-json" description:"Log using the logrus json formatter."`

	Verbose     bool   `long:"verbose" description:"Show verbose logging output."`
	Version     bool   `long:"version" description:"Prints the build information about this application if available."`
	Environment string `long:"environment" description:"The environment this application is running in."`
}

func (*BaseOptions) Initialize

func (opts *BaseOptions) Initialize()

type LazyHandler

type LazyHandler struct {
	Delegate func() slog.Handler
}

func (*LazyHandler) Enabled

func (v *LazyHandler) Enabled(ctx context.Context, level slog.Level) bool

func (*LazyHandler) Handle

func (v *LazyHandler) Handle(ctx context.Context, record slog.Record) error

func (*LazyHandler) WithAttrs

func (v *LazyHandler) WithAttrs(attrs []slog.Attr) slog.Handler

func (*LazyHandler) WithGroup

func (v *LazyHandler) WithGroup(name string) slog.Handler

type StartupError

type StartupError error