logger

type AnsiCode ¶

type AnsiCode string

const (
	TXT_BLACK   AnsiCode = "30m"
	TXT_RED     AnsiCode = "31m"
	TXT_GREEN   AnsiCode = "32m"
	TXT_YELLOW  AnsiCode = "33m"
	TXT_BLUE    AnsiCode = "34m"
	TXT_MAGENTA AnsiCode = "35m"
	TXT_CYAN    AnsiCode = "36m"
	TXT_WHITE   AnsiCode = "37m"

	BG_BLACK   AnsiCode = "40"
	BG_RED     AnsiCode = "41"
	BG_GREEN   AnsiCode = "42"
	BG_YELLOW  AnsiCode = "43"
	BG_BLUE    AnsiCode = "44"
	BG_MAGENTA AnsiCode = "45"
	BG_CYAN    AnsiCode = "46"
	BG_WHITE   AnsiCode = "47"

	CLR_START AnsiCode = "\033["
	CLR_RESET AnsiCode = "\033[0m"

	CLR_NONE AnsiCode = "" // No format
)

func (c AnsiCode) String() string

type AnsiColorScheme ¶

type AnsiColorScheme struct {
	// contains filtered or unexported fields
}

AnsiColorScheme implements ColorScheme for ANSI styles It provides a mapping of log levels to ANSI styles for console output. It allows for easy customization of log output colors using identifiers. The default identifiers used are listed here for reference:

• debug
• info
• warning
• error
• fatal
• deprecate
• deprecate_warning
• deprecate_error
• deprecate_fatal
• deprecate_reason
• lava
• lava_hot
• lava_cold
• lava_dry
• time
• file
• line
• version
• message
• context-key
• context-value
• default (used when no specific style is found)

You may add identifiers as needed for your custom formatters.

func (cs AnsiColorScheme) GetStyle(name string) AnsiStyle

type AnsiStyle ¶

type AnsiStyle struct {
	Background AnsiCode
	Text       AnsiCode
	NoStop     bool
}

func (s AnsiStyle) Apply(text string) string

type CloseFunc ¶

type CloseFunc func() error

type ColorScheme ¶

type ColorScheme[S Style] interface {
	GetStyle(name string) S
}

type ConsoleColorFormatterBuilder ¶

type ConsoleColorFormatterBuilder struct {
	// contains filtered or unexported fields
}

var ConsoleColorFormatter ConsoleColorFormatterBuilder = ConsoleColorFormatterBuilder{
	// contains filtered or unexported fields
}

func (b ConsoleColorFormatterBuilder) AddColor(nameID string, colorCode AnsiStyle) ConsoleColorFormatterBuilder

func (b ConsoleColorFormatterBuilder) BaseFormatter(formatter Formatter) ConsoleColorFormatterBuilder

func (b ConsoleColorFormatterBuilder) DefaultColor(colorCode AnsiStyle) ConsoleColorFormatterBuilder

func (b ConsoleColorFormatterBuilder) New() Formatter

func (b ConsoleColorFormatterBuilder) Next(formatter Formatter) FormatterBuilder

type ConsoleWriterBuilder ¶

type ConsoleWriterBuilder struct {
	// contains filtered or unexported fields
}

var ConsoleWriter ConsoleWriterBuilder

func (b ConsoleWriterBuilder) FormatString(format string) ConsoleWriterBuilder

func (b ConsoleWriterBuilder) New() Writer

func (b ConsoleWriterBuilder) NewLine() ConsoleWriterBuilder

type FileWriterBuilder ¶

type FileWriterBuilder struct {
	// contains filtered or unexported fields
}

var FileWriter FileWriterBuilder

func (b FileWriterBuilder) FilePath(path string) FileWriterBuilder

func (b FileWriterBuilder) FormatString(format string) FileWriterBuilder

func (b FileWriterBuilder) New() Writer

func (b FileWriterBuilder) NewLine() FileWriterBuilder

type FormatRecord ¶

type FormatRecord struct {
	LogLevel     string
	Time         string
	File         string
	Line         string
	Message      string
	AppVersion   string
	Context      map[string](datatypes.SPair[string])
	ContextBegin string
	ContextEnd   string
}

type Formatter ¶

type Formatter interface {
	Format(original *Record, formatRecord ...*FormatRecord) (string, error)
	Next() Formatter
	SetNext(next Formatter)
}

Formatter interface defines the methods required for custom formatter implementations. This interface also provides a guide on what chained formatters for a correct interaction between them.

type FormatterBase ¶

type FormatterBase struct {
	// contains filtered or unexported fields
}

FormatterBase provides a base implementation for the Formatter interface. It includes common formatting methods and a next formatter for chaining. You can use this as a base for your custom formatters to ensure that they implement the Formatter interface correctly. It is not needed if you want to implement a custom formatter.

> Keep in mind the golang method overriding behavior

func (f *FormatterBase) DateFormat() string

func (f *FormatterBase) DefaultFormat() string

func (f *FormatterBase) FinalString(original *Record, formatRecord *FormatRecord) string

func (f *FormatterBase) Format(r *Record, formatRecord ...*FormatRecord) (string, error)

func (f *FormatterBase) Next() Formatter

func (f *FormatterBase) SetNext(next Formatter)

type FormatterBuilder ¶

type FormatterBuilder interface {
	Next(Formatter) FormatterBuilder
	New() Formatter
}

type Record ¶

type Record struct {
	LogLevel   logLevel
	Time       time.Time
	Message    string
	File       string
	Line       int
	AppVersion version.Version
	Context    map[string]string
}

func NewRecord(msg string, extra ...datatypes.SPair[string]) Record

type Style ¶

type Style interface {
	Apply(text string) string
}

type Writer ¶

type Writer interface {
	CreationError() error
	Write(text string) error
	Close() error
}

type WriterBuilder ¶

type WriterBuilder interface {
	New() Writer
}