yaglogger

README

yaglogger (Yet another Go Logger)

yaglogger is a simple logger for Go. It allows to log in color to screen and to a file.

Installation

 go get -u github.com/jlentink/yaglogger

Default logger

package main

import (
	"github.com/jlentink/yaglogger"
)

func main() {
    logger := yaglogger.NewLogger()
    logger.Info("Hello world")
}

Custom logger

Or adjust where needed by initializing a new logger with the following options. Referer NewLogger for more information.

package main

import (
	"github.com/jlentink/yaglogger"
)
func main() {
        yalogger.Logger {
            Level:       0,
            OutErr:      nil,
            OutNormal:   nil,
            Output:      yalogger.LevelOutput{},
            ShowLevel:   false,
            ShowDate:    false,
            Color:       false,
            LogToScreen: false,
            LogFilePath: "",
            LogFile:     nil,
        }
	}

Documentation

Index

• Constants
• func Debug(message string, a ...any)
• func Error(message string, a ...any)
• func Fatal(message string, a ...any)
• func Info(message string, a ...any)
• func SetLevel(level level)
• func Trace(message string, a ...any)
• func Warn(message string, a ...any)
• type LevelOutput
• type Logger
  • func New() *Logger
  • func (l *Logger) Debug(message string, a ...any)
  • func (l *Logger) Error(message string, a ...any)
  • func (l *Logger) Fatal(message string, a ...any)
  • func (l *Logger) Info(message string, a ...any)
  • func (l *Logger) IsLogLevelEnabled(level level) bool
  • func (l *Logger) LevelColor(level level, message any) aurora.Value
  • func (l *Logger) LevelName(level level) string
  • func (l *Logger) LevelOutput(level level) io.Writer
  • func (l *Logger) Log(level level, message string, a ...any)
  • func (l *Logger) SetLevel(level level)
  • func (l *Logger) Trace(message string, a ...any)
  • func (l *Logger) Warn(message string, a ...any)

Constants

const (
	LevelFatal level = iota
	LevelError
	LevelWarn
	LevelInfo
	LevelDebug
	LevelTrace
	LevelAll
)

All log levels

Functions

func Debug

func Debug(message string, a ...any)

Debug logs a message with level debug

func Error

func Error(message string, a ...any)

Error logs a message with level error

func Fatal

func Fatal(message string, a ...any)

Fatal logs a message with level fatal

func Info

func Info(message string, a ...any)

Info logs a message with level info

func SetLevel

func SetLevel(level level)

SetLevel sets the log level

func Trace

func Trace(message string, a ...any)

Trace logs a message with level trace

func Warn

func Warn(message string, a ...any)

Warn logs a message with level warn

Types

type LevelOutput

type LevelOutput struct {
	Fatal io.Writer
	Error io.Writer
	Warn  io.Writer
	Info  io.Writer
	Debug io.Writer
	Trace io.Writer
}

LevelOutput defines the output stream for screen

type Logger

type Logger struct {
	Level       level
	Output      LevelOutput
	ShowLevel   bool
	ShowDate    bool
	Color       bool
	LogToScreen bool
	LogFilePath string
	LogFile     *os.File
}

Logger Struture

func New

func New() *Logger

New creates a new logger

func (*Logger) Debug

func (l *Logger) Debug(message string, a ...any)

Debug logs a message with level debug

func (*Logger) Error

func (l *Logger) Error(message string, a ...any)

Error logs a message with level error

func (*Logger) Fatal

func (l *Logger) Fatal(message string, a ...any)

Fatal logs a message with level fatal

func (*Logger) Info

func (l *Logger) Info(message string, a ...any)

Info logs a message with level info

func (*Logger) IsLogLevelEnabled

func (l *Logger) IsLogLevelEnabled(level level) bool

IsLogLevelEnabled returns true if the given level is enabled

func (*Logger) LevelColor

func (l *Logger) LevelColor(level level, message any) aurora.Value

LevelColor returns the color of the given level

func (*Logger) LevelName

func (l *Logger) LevelName(level level) string

LevelName returns the name of the given level

func (*Logger) LevelOutput

func (l *Logger) LevelOutput(level level) io.Writer

LevelOutput returns the output stream for the given level

func (*Logger) Log

func (l *Logger) Log(level level, message string, a ...any)

Log is the generic logging function

func (*Logger) SetLevel

func (l *Logger) SetLevel(level level)

SetLevel sets the log level

func (*Logger) Trace

func (l *Logger) Trace(message string, a ...any)

Trace logs a message with level trace

func (*Logger) Warn

func (l *Logger) Warn(message string, a ...any)

Warn logs a message with level warn