logging

Documentation

Overview

Package logging provides wrappers around zap logging.

Index

• type Environment
• type LogLevel
• type Logger
  • func CreateDevelopmentLogger() *Logger
  • func CreateProductionLogger() *Logger
  • func (l *Logger) AuditLog(logLevel LogLevel, phase string, msg string, keysAndValues ...interface{})
  • func (l *Logger) Log(logLevel LogLevel, msg string, keysAndValues ...interface{})

Types

type Environment

type Environment int

Environment enumerates predefined logging configurations.

const (
	// ProductionLogger is a short hand for predefined logging configuration for production use.
	ProductionLogger Environment = iota
	// DevelopmentLogger is a short hand for predefined logging configuration for development use.
	DevelopmentLogger
)

type LogLevel

type LogLevel int

LogLevel enumerates log levels

const (
	// DEBUG is the equivalent of zap.DebugLevel
	DEBUG LogLevel = iota

	// INFO is the equivalent of zap.InfoLevel
	INFO

	// WARN is the equivalent of zap.WarnLevel
	WARN

	// ERROR is the equivalent of zap.ErrorLevel
	ERROR
)

type Logger

type Logger struct {
	*zap.SugaredLogger
}

Logger wraps a zap.SugaredLogger.

func CreateDevelopmentLogger

func CreateDevelopmentLogger() *Logger

CreateDevelopmentLogger creates a new development logger.

func CreateProductionLogger

func CreateProductionLogger() *Logger

CreateProductionLogger creates a new production logger.

func (*Logger) AuditLog

func (l *Logger) AuditLog(logLevel LogLevel, phase string, msg string, keysAndValues ...interface{})

AuditLog is a prepared wrapper to harmonize the audit logging format.

func (*Logger) Log

func (l *Logger) Log(logLevel LogLevel, msg string, keysAndValues ...interface{})

Log is a prepared wrapper to harmonize the logging entrypoint.