logger

README

logger

Logger is a small, straightforward library to enhance your Go applications with powerful logging features.

Overview

Logger is a library providing a simple interface to add feature rich and customizable logging support to your application.

Logger is composed of modular Handlers, each of which implement a different mechanism by which your application can output logging information.

Currently supported handlers include:

• Standard Out / Standard Error
• File Logging

Logger also includes a number of modular Formatters, which transform your log messages into standards-compliant formats before they are logged.

Currently supported formatters include:

• Logger Structured Log Format
• JSON
• Graylog Extended Format
• Kubernetes Structured Log Format

Usage Documentation

Installation

Using this package requires a working Go environment. See the install instructions for Go.

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

Documentation

Index

• Constants
• type EntryBatch
  • func (e *EntryBatch) AddMessage(severity int)
  • func (e *EntryBatch) Debug(message string) error
  • func (e *EntryBatch) Error(err error) error
  • func (e *EntryBatch) Fatal(message string) error
  • func (e *EntryBatch) Handle() error
  • func (e *EntryBatch) Info(message string) error
  • func (e *EntryBatch) Trace(message string) error
  • func (e *EntryBatch) Warning(message string) error
  • func (e *EntryBatch) WithBatchId(id string) *EntryBatch
  • func (e *EntryBatch) WithMessage(severity int, message string) *EntryBatch
• type Logger
  • func (l *Logger) Batch(id string) *EntryBatch
  • func (l *Logger) CreateEntry(severity int, message string) *EntryBatch
  • func (l *Logger) Debug(message string) error
  • func (l *Logger) Debugf(format string, arguments ...any) error
  • func (l *Logger) Error(err error) error
  • func (l *Logger) Fatal(message string) error
  • func (l *Logger) Fatalf(format string, arguments ...any) error
  • func (l *Logger) Info(message string) error
  • func (l *Logger) Infof(format string, arguments ...any) error
  • func (l *Logger) Init() error
  • func (l *Logger) Initialize() error
  • func (l *Logger) LogAndExit(message interface{}) int
  • func (l *Logger) Trace(message string) error
  • func (l *Logger) Tracef(format string, arguments ...any) error
  • func (l *Logger) Warning(message string) error
  • func (l *Logger) Warningf(format string, arguments ...any) error
• type Message

Constants

const (
	LOG_TRACE = iota
	LOG_DEBUG
	LOG_INFO
	LOG_WARNING
	LOG_ERROR
	LOG_FATAL
)

Types

type EntryBatch

type EntryBatch struct {
	IsFormatted bool
	Format      formats.Format
	BatchId     string
	Messages    []*Message
	IsHandled   bool
	Handler     handlers.Handler
}

func (*EntryBatch) AddMessage

func (e *EntryBatch) AddMessage(severity int)

func (*EntryBatch) Debug

func (e *EntryBatch) Debug(message string) error

Debug Message Accessors

func (*EntryBatch) Error

func (e *EntryBatch) Error(err error) error

Error Message Accessors

func (*EntryBatch) Fatal

func (e *EntryBatch) Fatal(message string) error

Fatal Message Accessors

func (*EntryBatch) Handle

func (e *EntryBatch) Handle() error

func (*EntryBatch) Info

func (e *EntryBatch) Info(message string) error

Info Message Accessors

func (*EntryBatch) Trace

func (e *EntryBatch) Trace(message string) error

Trace Message Accessors

func (*EntryBatch) Warning

func (e *EntryBatch) Warning(message string) error

Warning Message Accessors

func (*EntryBatch) WithBatchId

func (e *EntryBatch) WithBatchId(id string) *EntryBatch

func (*EntryBatch) WithMessage

func (e *EntryBatch) WithMessage(severity int, message string) *EntryBatch

type Logger

type Logger struct {
	Name     string
	Level    int
	Handler  handlers.Handler
	Format   formats.Format
	Fallback *handlers.FallbackHandler
}

func (*Logger) Batch

func (l *Logger) Batch(id string) *EntryBatch

func (*Logger) CreateEntry

func (l *Logger) CreateEntry(severity int, message string) *EntryBatch

func (*Logger) Debug

func (l *Logger) Debug(message string) error

Debug Message Accessors

func (*Logger) Debugf

func (l *Logger) Debugf(format string, arguments ...any) error

func (*Logger) Error

func (l *Logger) Error(err error) error

Error Message Accessors

func (*Logger) Fatal

func (l *Logger) Fatal(message string) error

Fatal Message Accessors

func (*Logger) Fatalf

func (l *Logger) Fatalf(format string, arguments ...any) error

func (*Logger) Info

func (l *Logger) Info(message string) error

Info Message Accessors

func (*Logger) Infof

func (l *Logger) Infof(format string, arguments ...any) error

func (*Logger) Init

func (l *Logger) Init() error

func (*Logger) Initialize

func (l *Logger) Initialize() error

func (*Logger) LogAndExit

func (l *Logger) LogAndExit(message interface{}) int

func (*Logger) Trace

func (l *Logger) Trace(message string) error

Trace Message Accessors

func (*Logger) Tracef

func (l *Logger) Tracef(format string, arguments ...any) error

func (*Logger) Warning

func (l *Logger) Warning(message string) error

Warning Message Accessors

func (*Logger) Warningf

func (l *Logger) Warningf(format string, arguments ...any) error

type Message

type Message struct {
	Formatted  string
	Severity   string
	Raw        string
	Time       time.Time
	Parameters map[string]string
}