logging

package module
v0.0.0-...-15ee95b Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 1, 2016 License: MPL-2.0 Imports: 6 Imported by: 1

README

Codeship Status for AreaHQ/logging

Logging

A simple leveled logging library with coloured output.

Log levels:

  • INFO (blue)
  • WARNING (pink)
  • ERROR (red)
  • FATAL (red)

Formatters:

  • DefaultFormatter
  • ColouredFormatter

Example usage:

package main

import (
	"github.com/AreaHQ/logging"
)

var (
	plainLogger    *logging.Logger
	colouredLogger *logging.Logger
)

func init() {
	plainLogger = logging.New(nil, nil, nil)
	colouredLogger = logging.New(nil, nil, new(logging.ColouredFormatter))
}

func main() {
	plainLogger.Info("log message")
	plainLogger.Infof("formatted %s %s", "log", "message")
	colouredLogger.Info("log message")
	colouredLogger.Infof("formatted %s %s", "log", "message")

	plainLogger.Warning("log message")
	plainLogger.Warningf("formatted %s %s", "log", "message")
	colouredLogger.Warning("log message")
	colouredLogger.Warningf("formatted %s %s", "log", "message")

	plainLogger.Error("log message")
	plainLogger.Errorf("formatted %s %s", "log", "message")
	colouredLogger.Error("log message")
	colouredLogger.Errorf("formatted %s %s", "log", "message")

	// Not that logger.Fatal/f does not exit program execution
	// To emulate log.Fatal/f, follow with os.Exit(1)
	plainLogger.Fatal("log message")
	plainLogger.Fatalf("formatted %s %s", "log", "message")
	colouredLogger.Fatal("log message")
	colouredLogger.Fatalf("formatted %s %s", "log", "message")
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ColouredFormatter

type ColouredFormatter struct {
}

ColouredFormatter colours log messages with ASCI escape codes and adds filename and line number before the log message See https://en.wikipedia.org/wiki/ANSI_escape_code

func (*ColouredFormatter) Format

func (f *ColouredFormatter) Format(lvl level, v ...interface{}) []interface{}

Format adds filename and line number before the log message

func (*ColouredFormatter) GetPrefix

func (f *ColouredFormatter) GetPrefix(lvl level) string

GetPrefix returns colour escape code

func (*ColouredFormatter) GetSuffix

func (f *ColouredFormatter) GetSuffix(lvl level) string

GetSuffix returns reset sequence code

type DefaultFormatter

type DefaultFormatter struct {
}

DefaultFormatter adds filename and line number before the log message

func (*DefaultFormatter) Format

func (f *DefaultFormatter) Format(lvl level, v ...interface{}) []interface{}

Format adds filename and line number before the log message

func (*DefaultFormatter) GetPrefix

func (f *DefaultFormatter) GetPrefix(lvl level) string

GetPrefix returns ""

func (*DefaultFormatter) GetSuffix

func (f *DefaultFormatter) GetSuffix(lvl level) string

GetSuffix returns ""

type Formatter

type Formatter interface {
	GetPrefix(lvl level) string
	Format(lvl level, v ...interface{}) []interface{}
	GetSuffix(lvl level) string
}

Formatter interface

type Logger

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

Logger ...

func New

func New(out, errOut io.Writer, f Formatter) *Logger

New returns instance of Logger

func (*Logger) Error

func (l *Logger) Error(v ...interface{})

Error logs to ERROR level

func (*Logger) Errorf

func (l *Logger) Errorf(format string, v ...interface{})

Errorf logs a formatted string to ERROR level

func (*Logger) Fatal

func (l *Logger) Fatal(v ...interface{})

Fatal logs to FATAL level

func (*Logger) Fatalf

func (l *Logger) Fatalf(format string, v ...interface{})

Fatalf logs a formatted string to FATAL level

func (*Logger) Info

func (l *Logger) Info(v ...interface{})

Info logs to INFO level

func (*Logger) Infof

func (l *Logger) Infof(format string, v ...interface{})

Infof logs a formatted string to INFO level

func (*Logger) Warning

func (l *Logger) Warning(v ...interface{})

Warning logs to WARNING level

func (*Logger) Warningf

func (l *Logger) Warningf(format string, v ...interface{})

Warningf logs a formatted string to WARNING level

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL