logger

Documentation

Overview

Package Logger provides a singleton which allows consistent logging across the application.

Index

• func DisableStandardLogs()
• func Get() *sypl.Sypl
• func RedirectStandardLogs()
• func Setup(o *Options) *sypl.Sypl
• type Options
  • func (o *Options) Default()
• type ProxyLogger
  • func (pL *ProxyLogger) Printf(format string, v ...interface{})
• type StandardLogger
  • func (pL *StandardLogger) Write(p []byte) (int, error)

Functions

func DisableStandardLogs

func DisableStandardLogs()

DisableStandardLogs disables logs created with the standard library global logger

func Get

func Get() *sypl.Sypl

Get returns the logger. If the logger isn't configured, it will exit with fatal.

func RedirectStandardLogs

func RedirectStandardLogs()

RedirectStandardLogs redirects logs created with the standard library global logger to the ProxyLogger.

func Setup

func Setup(o *Options) *sypl.Sypl

Setup logger. If it fails to set up, it will exit with fatal.

Types

type Options

type Options struct {
	// Allows to set the internal Logger. For now, it will be straightforward
	// Sypl logger. In the future, could be the `sypl.IBasicPrinter` interface.
	Logger *sypl.Sypl `json:"-"`

	FileLevel string `validate:"required,gte=3"`
	FilePath  string `validate:"required"`
	Level     string `validate:"required,gte=3"`
}

Options for logging .

func (*Options) Default

func (o *Options) Default()

Default sets `Options` default values.

type ProxyLogger

type ProxyLogger struct {
	Logger *sypl.Sypl
}

ProxyLogger exist to satisfy `goproxy` logging interface.

func (*ProxyLogger) Printf

func (pL *ProxyLogger) Printf(format string, v ...interface{})

Printf satisfies `goproxy` logging interface. Default logging level will be `Debug`.

type StandardLogger

type StandardLogger struct {
	Logger *sypl.Sypl
}

func (*StandardLogger) Write

func (pL *StandardLogger) Write(p []byte) (int, error)

Write satisfies the standard logging interface. Default logging level will be `Debug`.