log

Documentation

Index

• func ConfigAdd(path string)
• func Register(ctx context.Context, mux *c.Mux) (*chi.Config, error)
• type Log
  • func NewLog() *Log
  • func NewLogWithConfigPath(path string) (*Log, error)
  • func NewLogWithOptions(options *Options) *Log
  • func (i *Log) Register(ctx context.Context, mux *c.Mux) (*chi.Config, error)
• type Options
  • func NewOptions() (*Options, error)
  • func NewOptionsWithPath(path string) (opts *Options, err error)

Functions

func ConfigAdd

func ConfigAdd(path string)

func Register

func Register(ctx context.Context, mux *c.Mux) (*chi.Config, error)

Register registers a new log with default options as a middleware to a new chi config.

Types

type Log

type Log struct {
	// contains filtered or unexported fields
}

Log struct that represents a Log.

func NewLog

func NewLog() *Log

NewLog returns a Log with default options.

func NewLogWithConfigPath

func NewLogWithConfigPath(path string) (*Log, error)

NewLogWithOptions returns a Log with options from config path.

func NewLogWithOptions

func NewLogWithOptions(options *Options) *Log

NewLogWithOptions returns a Log with options.

func (*Log) Register

func (i *Log) Register(ctx context.Context, mux *c.Mux) (*chi.Config, error)

Register registers the log as a middleware to a new chi config.

type Options

type Options struct {
	Enabled bool
	Level   string
}

Options struct that represents a chi log options.

func NewOptions

func NewOptions() (*Options, error)

NewOptions returns options from config file or environment vars.

func NewOptionsWithPath

func NewOptionsWithPath(path string) (opts *Options, err error)

NewOptionsWithPath unmarshals a given key path into options and returns it.