logging

README

Logging

Small Golang package to output alternative logs

Installation

go get code.afis.me/logging

Example

package main

import (
 "code.afis.me/logging"
)

var logger *logging.Logger
var maxlogsize int64 = 10000

func init() {
 logger := logging.NewLogger("test", []string{"/code.afis.me/logging/"})
 // if you store logs
 store := logging.NewLogsStore(maxlogsize)
 logger.OutputHandler = func(ps *logging.PushLogs) {
  store.Store(true, ps.ID, ps)
 }
 // end if you store logs
}


func main() {
  
 err := fmt.Errorf("Hello")

 // just display error output
 logger.Error(err)

 // if error not nil, then run os.Exit(2)
 logger.Error(err).Quit(err)

 logger.Debug("Hello from golang")
 logger.Warning("Hello from golang")
 logger.Success("Hello from golang")

}

Documentation

Index

• Constants
• func GetLevelLogName(level int) (lv string)
• func OutputHandlerConsole(ps *PushLogs)
• func ParsingLogs(ps *PushLogs, opt ParsingOption) (raw string)
• func TimeStringDateOnly(dur time.Time) (format string)
• func TimeStringTimeOnly(dur time.Time) (format string)
• func TimeStringWitLongDate(dur time.Time) (format string)
• func TimeStringWithDate(dur time.Time) (format string)
• func TimeToString(s time.Time) (ts string)
• type LogStore
  • func NewLogsStore(maxlogsize int64) *LogStore
  • func (rm *LogStore) ClearLogs(id string, ts []int64)
  • func (rm *LogStore) Count() int64
  • func (rm *LogStore) LoadAll(lid string, start int64, limit int) (value []LogsValue)
  • func (rm *LogStore) RemoveByID(lid string)
  • func (rm *LogStore) Reset()
  • func (rm *LogStore) Store(printWhenStore bool, key string, value interface{})
• type Logger
  • func NewLogger(name string, spli interface{}) *Logger
  • func (cc *Logger) AlwaysShow(level int, msg string) *Logger
  • func (cc *Logger) CreateHash(key string) string
  • func (cc *Logger) Debug(msg string) *Logger
  • func (cc *Logger) Error(err error) *Logger
  • func (cc *Logger) GenerateUUID() string
  • func (cc *Logger) MakeID() string
  • func (cc *Logger) Notice(msg string) *Logger
  • func (cc *Logger) Output(ps *PushLogs) *Logger
  • func (cc *Logger) Quit(err error) error
  • func (cc *Logger) SetLevel(ps int) *Logger
  • func (cc *Logger) Success(msg string) *Logger
  • func (cc *Logger) Warning(msg string) *Logger
• type LogsMap
• type LogsValue
• type ParsingOption
• type PushLogs
• type TimeString
  • func NewTimeString(tt time.Time) *TimeString
  • func (cc *TimeString) Output() (sr string)
  • func (cc *TimeString) WithDate(sp, sp2 string) *TimeString
  • func (cc *TimeString) WithLongDate(sp, sp2 string) *TimeString
  • func (cc *TimeString) WithMilliSecond() *TimeString
  • func (cc *TimeString) WithTime() *TimeString

Constants

const (
	// LOGDEBUG -
	LOGDEBUG = iota
	// LOGWARNING -
	LOGWARNING
	// LOGERROR -
	LOGERROR
	// LOGSUCCESS -
	LOGSUCCESS
	// LOGNOTICE -
	LOGNOTICE
)

const (
	// LEVELDEBUG -
	LEVELDEBUG = iota
	// LEVELWARNING -
	LEVELWARNING
	// LEVELERROR -
	LEVELERROR
	// LEVELNOTICE -
	LEVELNOTICE
)

Functions

func GetLevelLogName

func GetLevelLogName(level int) (lv string)

GetLevelLogName -

func OutputHandlerConsole

func OutputHandlerConsole(ps *PushLogs)

OutputHandlerConsole -

func ParsingLogs

func ParsingLogs(ps *PushLogs, opt ParsingOption) (raw string)

ParsingLogs -

func TimeStringDateOnly

func TimeStringDateOnly(dur time.Time) (format string)

TimeStringDateOnly -

func TimeStringTimeOnly

func TimeStringTimeOnly(dur time.Time) (format string)

TimeStringTimeOnly -

func TimeStringWitLongDate

func TimeStringWitLongDate(dur time.Time) (format string)

TimeStringWitLongDate -

func TimeStringWithDate

func TimeStringWithDate(dur time.Time) (format string)

TimeStringWithDate -

func TimeToString

func TimeToString(s time.Time) (ts string)

TimeToString -

Types

type LogStore

type LogStore struct {
	Counting  int64
	OnNewLogs func(value interface{})
	sync.RWMutex
	// contains filtered or unexported fields
}

LogStore -

func NewLogsStore

func NewLogsStore(maxlogsize int64) *LogStore

NewLogsStore -

func (*LogStore) ClearLogs

func (rm *LogStore) ClearLogs(id string, ts []int64)

ClearLogs -

func (*LogStore) Count

func (rm *LogStore) Count() int64

Count -

func (*LogStore) LoadAll

func (rm *LogStore) LoadAll(lid string, start int64, limit int) (value []LogsValue)

LoadAll -

func (*LogStore) RemoveByID

func (rm *LogStore) RemoveByID(lid string)

RemoveByID -

func (*LogStore) Reset

func (rm *LogStore) Reset()

Reset -

func (*LogStore) Store

func (rm *LogStore) Store(printWhenStore bool, key string, value interface{})

Store -

type Logger

type Logger struct {
	Name          string
	Splitter      []string
	LogLevel      int
	OutputHandler func(*PushLogs)
}

Logger -

func NewLogger

func NewLogger(name string, spli interface{}) *Logger

NewLogger -

func (*Logger) AlwaysShow

func (cc *Logger) AlwaysShow(level int, msg string) *Logger

AlwaysShow -

func (*Logger) CreateHash

func (cc *Logger) CreateHash(key string) string

CreateHash -

func (*Logger) Debug

func (cc *Logger) Debug(msg string) *Logger

Debug -

func (*Logger) Error

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

func (*Logger) GenerateUUID

func (cc *Logger) GenerateUUID() string

GenerateUUID -

func (*Logger) MakeID

func (cc *Logger) MakeID() string

MakeID -

func (*Logger) Notice

func (cc *Logger) Notice(msg string) *Logger

Notice -

func (*Logger) Output

func (cc *Logger) Output(ps *PushLogs) *Logger

Output -

func (*Logger) Quit

func (cc *Logger) Quit(err error) error

Quit -

func (*Logger) SetLevel

func (cc *Logger) SetLevel(ps int) *Logger

SetLevel -

func (*Logger) Success

func (cc *Logger) Success(msg string) *Logger

Success -

func (*Logger) Warning

func (cc *Logger) Warning(msg string) *Logger

Warning -

type LogsMap

type LogsMap map[time.Time]interface{}

LogsMap -

type LogsValue

type LogsValue struct {
	ID    string
	Time  time.Time
	Value interface{}
}

LogsValue -

type ParsingOption

type ParsingOption struct {
	Name func(string) string
}

ParsingOption -

type PushLogs

type PushLogs struct {
	ID         string    `json:"id"`
	Origin     string    `json:"origin"`
	Name       string    `json:"name"`
	Time       time.Time `json:"time"`
	Level      int       `json:"level"`
	LongFile   string    `json:"longFile"`
	ShortFile  string    `json:"shortFile"`
	LineNumber int       `json:"lineNumber"`
	Message    string    `json:"message"`
}

PushLogs -

type TimeString

type TimeString struct {
	Date time.Time
	// contains filtered or unexported fields
}

TimeString -

func NewTimeString

func NewTimeString(tt time.Time) *TimeString

NewTimeString -

func (*TimeString) Output

func (cc *TimeString) Output() (sr string)

Output -

func (*TimeString) WithDate

func (cc *TimeString) WithDate(sp, sp2 string) *TimeString

WithDate -

func (*TimeString) WithLongDate

func (cc *TimeString) WithLongDate(sp, sp2 string) *TimeString

WithLongDate -

func (*TimeString) WithMilliSecond

func (cc *TimeString) WithMilliSecond() *TimeString

WithMilliSecond -

func (*TimeString) WithTime

func (cc *TimeString) WithTime() *TimeString

WithTime -