spp_logger

package module

v0.0.0-...-99fe010 Latest Latest Go to latest Published: May 24, 2022 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ONSDigital/spp-logger

Documentation ¶

Index ¶

Constants
Variables
func LoadLevel(level string) logrus.Level
func ValidLevel(level string) bool
func WriteLevel(level logrus.Level) string
type Config
- func NewConfigFromEnv() *Config
type ConfigHook
- func (hook *ConfigHook) Fire(entry *logrus.Entry) error
- func (hook *ConfigHook) Levels() []logrus.Level
type Context
- func NewContext(logLevel, correlationID string) (Context, error)
type Logger
- func NewLogger(config Config, context Context, logLevel string, output io.Writer) (*Logger, error)

Constants ¶

View Source

const (
	DebugLevel    = "DEBUG"
	InfoLevel     = "INFO"
	WarningLevel  = "WARNING"
	ErrorLevel    = "ERROR"
	CriticalLevel = "CRITICAL"
)

Variables ¶

View Source

var AllLevels = []string{
	DebugLevel,
	InfoLevel,
	WarningLevel,
	ErrorLevel,
	CriticalLevel,
}

Functions ¶

func LoadLevel ¶

func LoadLevel(level string) logrus.Level

func ValidLevel ¶

func ValidLevel(level string) bool

func WriteLevel ¶

func WriteLevel(level logrus.Level) string

Types ¶

type Config ¶

type Config struct {
	Service     string
	Component   string
	Environment string
	Deployment  string
	// User        string //TODO
	Timezone string //TODO
}

func NewConfigFromEnv ¶

func NewConfigFromEnv() *Config

type ConfigHook ¶

type ConfigHook struct {
	Config *Config
}

func (*ConfigHook) Fire ¶

func (hook *ConfigHook) Fire(entry *logrus.Entry) error

func (*ConfigHook) Levels ¶

func (hook *ConfigHook) Levels() []logrus.Level

type Context ¶

type Context map[string]string

func NewContext ¶

func NewContext(logLevel, correlationID string) (Context, error)

func (Context) CorrelationID ¶

func (context Context) CorrelationID() string

func (Context) Fire ¶

func (context Context) Fire(entry *logrus.Entry) error

func (Context) IsValid ¶

func (context Context) IsValid() error

func (Context) Keys ¶

func (context Context) Keys() []string

func (Context) Levels ¶

func (context Context) Levels() []logrus.Level

func (Context) LogLevel ¶

func (context Context) LogLevel() string

type Logger ¶

type Logger struct {
	logrus.Logger
	Config Config
	Name   string

	LogLevel string
	// contains filtered or unexported fields
}

func NewLogger ¶

func NewLogger(config Config, context Context, logLevel string, output io.Writer) (*Logger, error)

func (*Logger) Context ¶

func (sppLogger *Logger) Context() Context

func (*Logger) Critical ¶

func (sppLogger *Logger) Critical(args ...interface{})

func (*Logger) CriticalFn ¶

func (sppLogger *Logger) CriticalFn(fn logrus.LogFunction)

func (*Logger) Criticalf ¶

func (sppLogger *Logger) Criticalf(format string, args ...interface{})

func (*Logger) OverrideContext ¶

func (sppLogger *Logger) OverrideContext(context Context) *Logger

func (*Logger) SetContextAttribute ¶

func (sppLogger *Logger) SetContextAttribute(attribute, value string) *Logger

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL