logger

README

MailHedgehog logger

Log helper for MailHedgehog package. Can be reused in any other app/package.

Usage

Full usage expects creation custom labeled logger for each package and then execute:

package main

import (
    "github.com/mailhedgehog/logger"
)

var configuredLogger *logger.Logger

func logManager() *logger.Logger {
    if configuredLogger == nil {
        configuredLogger = logger.CreateLogger("server.api")
    }
    return configuredLogger
}

func main() {
    logManager().Emergency("I see error!")
}

Direct quick usage:

package main

import (
    "github.com/mailhedgehog/logger"
)

func main() {
    logger.CreateLogger("server.api").Emergency("I see error!")
}

package main

import (
    "github.com/mailhedgehog/logger"
)

func main() {
    logger.Emergency("I see error!")
}

Development

go mod tidy
go mod verify
go mod vendor
go test --cover

Credits

• 

Documentation

Index

• Variables
• func Alert(message string, context ...interface{})
• func Color(colorString string) func(...interface{}) string
• func Critical(message string, context ...interface{})
• func Debug(message string, context ...interface{})
• func Emergency(message string, context ...interface{})
• func Error(message string, context ...interface{})
• func Info(message string, context ...interface{})
• func Log(level LogLevel, message string, context ...interface{})
• func Notice(message string, context ...interface{})
• func PanicIfError(e error)
• func Warning(message string, context ...interface{})
• type LogLevel
• type Logger
  • func CreateLogger(logGroup string) *Logger
  • func (logger *Logger) Alert(message string, context ...interface{})
  • func (logger *Logger) Critical(message string, context ...interface{})
  • func (logger *Logger) Debug(message string, context ...interface{})
  • func (logger *Logger) Emergency(message string, context ...interface{})
  • func (logger *Logger) Error(message string, context ...interface{})
  • func (logger *Logger) Info(message string, context ...interface{})
  • func (logger *Logger) Log(level LogLevel, message string, context ...interface{})
  • func (logger *Logger) Notice(message string, context ...interface{})
  • func (logger *Logger) Warning(message string, context ...interface{})

Variables

var (
	LogHandler          func(message string, context ...interface{})
	LogEmergencyHandler func(message string, context ...interface{})
	LogAlertHandler     func(message string, context ...interface{})
	LogCriticalHandler  func(message string, context ...interface{})
	LogErrorHandler     func(message string, context ...interface{})
	LogWarningHandler   func(message string, context ...interface{})
	LogNoticeHandler    func(message string, context ...interface{})
	LogInfoHandler      func(message string, context ...interface{})
	LogDebugHandler     func(message string, context ...interface{})
)

var (
	EmergencyColor = Red
	AlertColor     = Red
	CriticalColor  = Red
	ErrorColor     = Red
	WarningColor   = Yellow
	InfoColor      = Teal
	NoticeColor    = Purple
	DebugColor     = Green
)

var (
	Red    = Color("\033[1;31m%s\033[0m")
	Green  = Color("\033[1;32m%s\033[0m")
	Yellow = Color("\033[1;33m%s\033[0m")
	Purple = Color("\033[1;34m%s\033[0m")
	Teal   = Color("\033[1;36m%s\033[0m")
)

var MinLogLevel = INFO

MinLogLevel minimal level to display

Functions

func Alert

func Alert(message string, context ...interface{})

func Color

func Color(colorString string) func(...interface{}) string

func Critical

func Critical(message string, context ...interface{})

func Debug

func Debug(message string, context ...interface{})

func Emergency

func Emergency(message string, context ...interface{})

func Error

func Error(message string, context ...interface{})

func Info

func Info(message string, context ...interface{})

func Log

func Log(level LogLevel, message string, context ...interface{})

func Notice

func Notice(message string, context ...interface{})

func PanicIfError

func PanicIfError(e error)

func Warning

func Warning(message string, context ...interface{})

Types

type LogLevel

type LogLevel = string

LogLevel represents an log level name

const (
	EMERGENCY LogLevel = "emergency"
	ALERT     LogLevel = "alert"
	CRITICAL  LogLevel = "critical"
	ERROR     LogLevel = "error"
	WARNING   LogLevel = "warning"
	NOTICE    LogLevel = "notice"
	INFO      LogLevel = "info"
	DEBUG     LogLevel = "debug"
)

type Logger

type Logger struct {
	LogGroup string
}

func CreateLogger

func CreateLogger(logGroup string) *Logger

func (*Logger) Alert

func (logger *Logger) Alert(message string, context ...interface{})

func (*Logger) Critical

func (logger *Logger) Critical(message string, context ...interface{})

func (*Logger) Debug

func (logger *Logger) Debug(message string, context ...interface{})

func (*Logger) Emergency

func (logger *Logger) Emergency(message string, context ...interface{})

func (*Logger) Error

func (logger *Logger) Error(message string, context ...interface{})

func (*Logger) Info

func (logger *Logger) Info(message string, context ...interface{})

func (*Logger) Log

func (logger *Logger) Log(level LogLevel, message string, context ...interface{})

func (*Logger) Notice

func (logger *Logger) Notice(message string, context ...interface{})

func (*Logger) Warning

func (logger *Logger) Warning(message string, context ...interface{})