logger

README

Logger: custom logger package for Go.

Logger package help you easier write log to io.Writer. All methods fully support standard log package, but have extra features.

Install

For install logger, just run go get -u github.com/neliseev/logger or glide get github.com/neliseev/logger

Usage

Simple in main file you should initialise logger.

package main

import "github.com/neliseev/logger"

var log *logger.Log // Using log subsystem

func init() {
	// Initialization log system
	var err error

	if log, err = logger.NewFileLogger("/var/log/example/main.log", 8); err != nil {
		panic(err)
	}
}

func main() {
    log.Info("Starting main packge")
...
}

Logger automatically create all subfolder by defined path.

For re-use current initialised logger, just define var log *logger.Log, example:

package example

import "github.com/neliseev/logger"

var log *logger.Log // Using log subsystem

func Some() {
    log.Debug("Hello, Wold!")
}

License

Copyright (C) 2017 Nikita Eliseev

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Documentation

Index

• Constants
• type Log
  • func New(filePath string, level int) (Log, error)
  • func (log *Log) Alert(a ...interface{})
  • func (log *Log) Close()
  • func (log *Log) Critical(a ...interface{})
  • func (log *Log) Debug(a ...interface{})
  • func (log *Log) Emergency(a ...interface{})
  • func (log *Log) Error(a ...interface{})
  • func (log *Log) GetPtr(level int) (*log.Logger, error)
  • func (log *Log) Info(a ...interface{})
  • func (log *Log) Notice(a ...interface{})
  • func (log *Log) PrintfOnErr(level int, fn func() error, format string, a ...interface{})
  • func (log *Log) PrintlnOnErr(level int, fn func() error, a ...interface{})
  • func (log *Log) Trace(msg string) func()
  • func (log *Log) Warning(a ...interface{})

Constants

const (
	EMERGENCY = iota // 0
	ALERT            // 1
	CRITICAL         // 2
	ERROR            // 3
	WARNING          // 4
	NOTICE           // 5
	INFO             // 6
	DEBUG            // 7
	TRACE            // 8
)

log level constants

Types

type Log

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

Log struct represents application logger

func New

func New(filePath string, level int) (Log, error)

New constructor for application logger

Fields:

path  - path to log file
level - log level, possible levels:
  0 - Emergency, with panic exit.
  1 - Alert, with exit 2.
  2 - Critical, with ext 1.
  3 - Errors.
  4 - Warnings.
  5 - Notice.
  6 - Info.
  7 - Debug.
  8 - Trace.

func main() {
  // initialization application log system
  var err error
  logger := logger.Log{}
  if logger, err = logger.NewLogger("/some/path", 0); err != nil {
    panic(err)
  }
}

func (*Log) Alert

func (log *Log) Alert(a ...interface{})

Alert wraps println

func (*Log) Close

func (log *Log) Close()

Close the log file if used

func (*Log) Critical

func (log *Log) Critical(a ...interface{})

Critical wraps println

func (*Log) Debug

func (log *Log) Debug(a ...interface{})

Debug wraps println

func (*Log) Emergency

func (log *Log) Emergency(a ...interface{})

Emergency wraps println

func (*Log) Error

func (log *Log) Error(a ...interface{})

Error wraps println

func (*Log) GetPtr

func (log *Log) GetPtr(level int) (*log.Logger, error)

GetPtr returns raw *log.Logger object ptr for specified logging level

func (*Log) Info

func (log *Log) Info(a ...interface{})

Info wraps println

func (*Log) Notice

func (log *Log) Notice(a ...interface{})

Notice wraps println

func (*Log) PrintfOnErr

func (log *Log) PrintfOnErr(level int, fn func() error, format string, a ...interface{})

PrintfOnErr is a function wrap helper; it takes a function that can return an error and additional error description if wrapped function return an error we write a message describes event and handle behavior according to specified logging level further

func (*Log) PrintlnOnErr

func (log *Log) PrintlnOnErr(level int, fn func() error, a ...interface{})

PrintlnOnErr is a function wrap helper; it takes a function that can return an error and additional error description if wrapped function return an error we write a message describes event and handle behavior according to specified logging level further

func (*Log) Trace

func (log *Log) Trace(msg string) func()

Trace logging a performance each function (simple profiler), usage defer trace("Message")()

func (*Log) Warning

func (log *Log) Warning(a ...interface{})

Warning wraps println