logger

README

Logger

A simple log file

Basic Usage:

    import(
      "github.com/random9s/cinder/logger"
    )

    func main() {
        var l, err = logger.New("testlog")
	    if err != nil {
		    log.Fatal(err)
	    }
        defer l.Close()

        //General logging use
        l.Trace("Trace level message")
        l.Info("Info level message")
        l.Warning("Warning level message")
        l.Error("Error level message")

        //Stop flow of control and log
        l.Fatal("Fatal level message")
        l.Panic("Panic level message")
    }

Documentation

Index

• Constants
• type Levels
  • func DefaultLevels(file *os.File) Levels
• type Log
  • func New(path string) (*Log, error)
  • func (l *Log) Close() error
  • func (l *Log) Error(p ...interface{})
  • func (l *Log) Fatal(p ...interface{})
  • func (l *Log) GzipClose() error
  • func (l *Log) Info(p ...interface{})
  • func (l *Log) Open(path string) (*Log, error)
  • func (l *Log) Panic(p ...interface{})
  • func (l *Log) Printf(format string, v ...interface{})
  • func (l *Log) Size() int64
  • func (l *Log) Trace(p ...interface{})
  • func (l *Log) Warning(p ...interface{})
  • func (l *Log) Write(b []byte) (int, error)
• type LogLevel
  • func (ll *LogLevel) Build(file *os.File) *log.Logger
  • func (ll *LogLevel) Prefix() string
• type Logger

Constants

const (
	TRACE = "TRACE"
	INFO  = "INFO"
	WARN  = "WARNING"
	ERR   = "ERROR"
	FATAL = "FATAL"
	PANIC = "PANIC"
)

Loglevel types

Types

type Levels

type Levels map[string]*log.Logger

Levels contain each log level

func DefaultLevels

func DefaultLevels(file *os.File) Levels

DefaultLevels initializes and returns the available log levels

type Log

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

Log is used to log information to one or several files

func New

func New(path string) (*Log, error)

New returns a newly initialized log

func (*Log) Close

func (l *Log) Close() error

Close log file

func (*Log) Error

func (l *Log) Error(p ...interface{})

Error level log entry

func (*Log) Fatal

func (l *Log) Fatal(p ...interface{})

Fatal level log entry

func (*Log) GzipClose

func (l *Log) GzipClose() error

GzipClose zips the old data before closing

func (*Log) Info

func (l *Log) Info(p ...interface{})

Info level log entry

func (*Log) Open

func (l *Log) Open(path string) (*Log, error)

Open opens the specified log file

func (*Log) Panic

func (l *Log) Panic(p ...interface{})

Panic level log entry

func (*Log) Printf

func (l *Log) Printf(format string, v ...interface{})

Printf is similar to fmt printf

func (*Log) Size

func (l *Log) Size() int64

Size returns size of log file

func (*Log) Trace

func (l *Log) Trace(p ...interface{})

Trace level log entry

func (*Log) Warning

func (l *Log) Warning(p ...interface{})

Warning level log entry

func (*Log) Write

func (l *Log) Write(b []byte) (int, error)

Write ...

type LogLevel

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

LogLevel contains info about a log level

func (*LogLevel) Build

func (ll *LogLevel) Build(file *os.File) *log.Logger

Build creates individual logger

func (*LogLevel) Prefix

func (ll *LogLevel) Prefix() string

Prefix ...

type Logger

type Logger interface {
	Open(string) (*Log, error)
	Trace(...interface{})
	Info(...interface{})
	Warning(...interface{})
	Error(...interface{})
	Fatal(...interface{})
	Panic(...interface{})
	Write([]byte) (int, error)
	Printf(format string, v ...interface{})
	Size() int64
	GzipClose() error
	Close() error
}

Logger is used for all logging