logger

package module
v0.5.0 Latest Latest
Warning

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

Go to latest
Published: Dec 8, 2016 License: MIT Imports: 9 Imported by: 8

README

logger

version Build Status

Logger library in Go

Installation

Use go get:

$ go get github.com/Travix-International/logger

Usage

You can import the package, and set it up with one or more transports:

package main

import (
    "github.com/Travix-International/logger"
)

func main() {
    myLogger := logger.New()
    myLogger.AddTransport(logger.ConsoleTransport)

    // HTTP:
    // jsonFormat := logger.NewJSONFormat()
    // myLogger.AddTransport(logger.NewHttpTransport(myUrl, jsonFormat))

    // regular logs
    myLogger.Debug("EventName", "message...")
    myLogger.Info("EventName", "message...")
    myLogger.Warn("EventName", "message...")
    myLogger.Error("EventName", "message...")

    // with meta
    meta := map[string]string {
      "key": "value"
    })
    myLogger.DebugWithMeta("EventName", "message...", meta);
    myLogger.InfoWithMeta("EventName", "message...", meta);
    myLogger.WarnWithMeta("EventName", "message...", meta);
    myLogger.ErrorWithMeta("EventName", "message...", meta);

    // custom levels
    myLogger.Log("CustomLevelName", "EventName", "message...", map[string]string {
      "key": "value"
    })
}

Development

Clone the repo to your $GOPATH:

$ git clone git@github.com:Travix-International/logger.git $GOPATH/src/github.com/Travix-International/logger

Run tests:

$ make run-tests

For generating coverage:

$ make cover

License

MIT © Travix International

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrNoLevel   = errors.New("No Level!")
	ErrNoEvent   = errors.New("No Event!")
	ErrNoMessage = errors.New("No Message!")
)
View Source
var DefaultJSONFormat = &JSONFormat{}
View Source
var DefaultStringFormat = &StringFormat{}
View Source
var ErrNilClient = errors.New("Nil HttpClient!")

Functions

This section is empty.

Types

type Entry

type Entry struct {
	Level   string
	Event   string
	Message string
	Meta    map[string]string
}

func NewEntry

func NewEntry(level string, event string, message string, meta map[string]string) *Entry

func (*Entry) String

func (e *Entry) String() string

type Formatter

type Formatter interface {
	Format(entry *Entry) (string, error)
}

type JSONFormat

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

func NewJSONFormat

func NewJSONFormat() *JSONFormat

func (*JSONFormat) Format

func (j *JSONFormat) Format(e *Entry) (string, error)

func (*JSONFormat) SetEventKey

func (j *JSONFormat) SetEventKey(eventKey string) *JSONFormat

func (*JSONFormat) SetLevelKey

func (j *JSONFormat) SetLevelKey(levelKey string) *JSONFormat

func (*JSONFormat) SetMessageKey

func (j *JSONFormat) SetMessageKey(messageKey string) *JSONFormat

type Logger

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

*

  • Base struct

func New

func New() *Logger

*

  • Instantiation

func (*Logger) AddTransport

func (l *Logger) AddTransport(t ...*Transport) *Logger

*

  • Transport methods

func (*Logger) Debug

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

*

  • Level methods

func (*Logger) DebugWithMeta

func (l *Logger) DebugWithMeta(event string, message string, meta map[string]string) error

func (*Logger) Error

func (l *Logger) Error(event string, message string) error

func (*Logger) ErrorWithMeta

func (l *Logger) ErrorWithMeta(event string, message string, meta map[string]string) error

func (*Logger) Info

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

func (*Logger) InfoWithMeta

func (l *Logger) InfoWithMeta(event string, message string, meta map[string]string) error

func (*Logger) Log

func (l *Logger) Log(level string, event string, message string, meta map[string]string) error

*

  • Common log method

func (*Logger) Warn

func (l *Logger) Warn(event string, message string) error

func (*Logger) WarnWithMeta

func (l *Logger) WarnWithMeta(event string, message string, meta map[string]string) error

type StringFormat

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

func NewStringFormat

func NewStringFormat(levelFormat, eventFormat, messageFormat, metaKeyFormat, metaMessageFormat string) *StringFormat

func (*StringFormat) Format

func (s *StringFormat) Format(e *Entry) (out string, err error)

type Transport

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

func NewHttpTransport

func NewHttpTransport(url string, format Formatter) *Transport

func NewTransport

func NewTransport(w io.Writer, f Formatter) *Transport

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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