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

Direct usage

package main

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

func main() {
	log.Debug("Debug")
}

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

• func Debug(message string, a ...any)
• func Error(message string, a ...any)
• func Fatal(v ...any)
• func Fatalf(format string, v ...any)
• func Fatalln(v ...any)
• func Flags() int
• func Info(message string, a ...any)
• func Output(calldepth int, s string) error
• func Panic(v ...any)
• func Panicf(format string, v ...any)
• func Panicln(v ...any)
• func Prefix() string
• func Print(v ...any)
• func Printf(format string, v ...any)
• func Println(v ...any)
• func SetFlags(flag int)
• func SetLevel(level LogLevel)
• func SetLevelByString(level string)
• func SetLogger(logger *Logger)
• func SetOutput(w io.Writer)
• func SetPrefix(prefix string)
• func Trace(message string, a ...any)
• func Warn(message string, a ...any)
• func Writer() io.Writer
• type Format
• type LevelOutput
• type LogLevel
  • func (l LogLevel) String() string
• type Logger
  • func GetInstance() *Logger
  • func New() *Logger
  • func (l *Logger) CenteredLevelName(level LogLevel) string
  • func (l *Logger) Debug(message string, a ...any)
  • func (l *Logger) EnableColors(c bool)
  • func (l *Logger) Error(message string, a ...any)
  • func (l *Logger) Fatal(v ...any)
  • func (l *Logger) Fatalf(message string, a ...any)
  • func (l *Logger) Fatalln(v ...any)
  • func (l *Logger) Fprint(w io.Writer, a ...any) (n int, err error)
  • func (l *Logger) Fprintf(w io.Writer, format string, a ...any) (n int, err error)
  • func (l *Logger) GetColours() *aurora.Aurora
  • func (l *Logger) GetFileWithLine() string
  • func (l *Logger) Info(message string, a ...any)
  • func (l *Logger) IsLogLevelEnabled(level LogLevel) bool
  • func (l *Logger) LevelColor(level LogLevel, message any) aurora.Value
  • func (l *Logger) LevelOutput(level LogLevel) *os.File
  • func (l *Logger) Log(level LogLevel, message string, a ...any)
  • func (l *Logger) Panic(v ...any)
  • func (l *Logger) Panicf(message string, a ...any)
  • func (l *Logger) Print(v ...any)
  • func (l *Logger) PrintDebug(format any) (n int, err error)
  • func (l *Logger) PrintDebugf(format string, a ...any) (n int, err error)
  • func (l *Logger) Printf(format string, a ...any)
  • func (l *Logger) SetDebug(d bool) *Logger
  • func (l *Logger) SetLevel(level LogLevel) *Logger
  • func (l *Logger) SetLevelByString(level string) LogLevel
  • func (l *Logger) Trace(message string, a ...any)
  • func (l *Logger) Warn(message string, a ...any)

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(v ...any)

Fatal is equivalent to Print() followed by a call to os.Exit(1).

func Fatalf

func Fatalf(format string, v ...any)

Fatalf is equivalent to Printf() followed by a call to os.Exit(1).

func Fatalln

func Fatalln(v ...any)

Fatalln is equivalent to Println() followed by a call to os.Exit(1).

func Flags

func Flags() int

Flags returns the output flags for the standard logger. and is unsupported in this package.

func Info

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

Info logs a message with level info

func Output

func Output(calldepth int, s string) error

func Panic

func Panic(v ...any)

func Panicf

func Panicf(format string, v ...any)

func Panicln

func Panicln(v ...any)

func Prefix

func Prefix() string

func Print

func Print(v ...any)

func Printf

func Printf(format string, v ...any)

func Println

func Println(v ...any)

func SetFlags

func SetFlags(flag int)

func SetLevel

func SetLevel(level LogLevel)

SetLevel sets the log level

func SetLevelByString

func SetLevelByString(level string)

func SetLogger

func SetLogger(logger *Logger)

func SetOutput

func SetOutput(w io.Writer)

func SetPrefix

func SetPrefix(prefix string)

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

func Writer

func Writer() io.Writer

Types

type Format

type Format struct {
	ShowDate   bool
	DateLayout string
	Color      bool
	ShowLevel  bool
	EndOfLine  string
	Prefix     string
}

type LevelOutput

type LevelOutput struct {
	Fatal    *os.File
	Error    *os.File
	Warn     *os.File
	Info     *os.File
	Debug    *os.File
	Trace    *os.File
	Msg      *os.File
	DebugMsg *os.File
}

LevelOutput defines the output stream for screen

type LogLevel

type LogLevel uint

Level type

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

All log levels

func (LogLevel) String

func (l LogLevel) String() string

type Logger

type Logger struct {
	Level       LogLevel
	Output      LevelOutput
	Format      Format
	LogToScreen bool
	LogFilePath string
	LogFile     io.Writer

	ForceNewLine    bool
	ShowLogLocation bool
	// contains filtered or unexported fields
}

Logger Structure

func GetInstance

func GetInstance() *Logger

func New

func New() *Logger

New creates a new logger

func (*Logger) CenteredLevelName

func (l *Logger) CenteredLevelName(level LogLevel) string

CenteredLevelName returns the name of the given level

func (*Logger) Debug

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

Debug logs a message with level debug

func (*Logger) EnableColors

func (l *Logger) EnableColors(c bool)

EnableColors enables/disables colors

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(v ...any)

Fatal logs a message with level fatal

func (*Logger) Fatalf

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

Fatalf logs a message with level fatal

func (*Logger) Fatalln

func (l *Logger) Fatalln(v ...any)

func (*Logger) Fprint

func (l *Logger) Fprint(w io.Writer, a ...any) (n int, err error)

func (*Logger) Fprintf

func (l *Logger) Fprintf(w io.Writer, format string, a ...any) (n int, err error)

func (*Logger) GetColours

func (l *Logger) GetColours() *aurora.Aurora

GetColours returns the aurora instance

func (*Logger) GetFileWithLine

func (l *Logger) GetFileWithLine() string

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 LogLevel) bool

IsLogLevelEnabled returns true if the given level is enabled

func (*Logger) LevelColor

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

LevelColor returns the color of the given level

func (*Logger) LevelOutput

func (l *Logger) LevelOutput(level LogLevel) *os.File

LevelOutput returns the output stream for the given level

func (*Logger) Log

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

Log is the generic logging function

func (*Logger) Panic

func (l *Logger) Panic(v ...any)

Panic logs a message with level fatal

func (*Logger) Panicf

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

Panic logs a message with level fatal

func (*Logger) Print

func (l *Logger) Print(v ...any)

Print prints message

func (*Logger) PrintDebug

func (l *Logger) PrintDebug(format any) (n int, err error)

PrintDebug prints message with debug level

func (*Logger) PrintDebugf

func (l *Logger) PrintDebugf(format string, a ...any) (n int, err error)

PrintDebugf prints message with debug level and formatting

func (*Logger) Printf

func (l *Logger) Printf(format string, a ...any)

Printf prints message with formatting

func (*Logger) SetDebug

func (l *Logger) SetDebug(d bool) *Logger

SetDebug sets the log level to debug

func (*Logger) SetLevel

func (l *Logger) SetLevel(level LogLevel) *Logger

SetLevel sets the log level

func (*Logger) SetLevelByString

func (l *Logger) SetLevelByString(level string) LogLevel

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