logs

package
v0.0.0-...-d032931 Latest Latest
Warning

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

Go to latest
Published: Jun 1, 2018 License: GPL-3.0 Imports: 14 Imported by: 2

Documentation

Overview

Usage:

import "github.com/CloudWise-OpenSource/GoCrab/Core/logs"

log := NewLogger(10000)
log.SetLogger("console", "")

> the first params stand for how many channel

Use it like this:

log.Trace("trace")
log.Info("info")
log.Warn("warning")
log.Debug("debug")
log.Critical("critical")

Index

Constants

View Source
const (
	LevelEmergency = iota
	LevelAlert
	LevelCritical
	LevelError
	LevelWarning
	LevelNotice
	LevelInformational
	LevelDebug
)

RFC5424 log message levels.

View Source
const (
	LevelInfo  = LevelInformational
	LevelTrace = LevelDebug
	LevelWarn  = LevelWarning
)

Legacy loglevel constants to ensure backwards compatibility.

Deprecated: will be removed in 1.5.0.

Variables

This section is empty.

Functions

func Register

func Register(name string, log loggerType)

Register makes a log provide available by the provided name. If Register is called twice with the same name or if driver is nil, it panics.

Types

type Brush

type Brush func(string) string

func NewBrush

func NewBrush(color string) Brush

type ConnWriter

type ConnWriter struct {
	ReconnectOnMsg bool   `json:"reconnectOnMsg"`
	Reconnect      bool   `json:"reconnect"`
	Net            string `json:"net"`
	Addr           string `json:"addr"`
	Level          int    `json:"level"`
	// contains filtered or unexported fields
}

ConnWriter implements LoggerInterface. it writes messages in keep-live tcp connection.

func (*ConnWriter) Destroy

func (c *ConnWriter) Destroy()

destroy connection writer and close tcp listener.

func (*ConnWriter) Flush

func (c *ConnWriter) Flush()

implementing method. empty.

func (*ConnWriter) Init

func (c *ConnWriter) Init(jsonconfig string) error

init connection writer with json config. json config only need key "level".

func (*ConnWriter) WriteMsg

func (c *ConnWriter) WriteMsg(msg string, level int) error

write message in connection. if connection is down, try to re-connect.

type ConsoleWriter

type ConsoleWriter struct {
	Level int `json:"level"`
	// contains filtered or unexported fields
}

ConsoleWriter implements LoggerInterface and writes messages to terminal.

func (*ConsoleWriter) Destroy

func (c *ConsoleWriter) Destroy()

implementing method. empty.

func (*ConsoleWriter) Flush

func (c *ConsoleWriter) Flush()

implementing method. empty.

func (*ConsoleWriter) Init

func (c *ConsoleWriter) Init(jsonconfig string) error

init console logger. jsonconfig like '{"level":LevelTrace}'.

func (*ConsoleWriter) WriteMsg

func (c *ConsoleWriter) WriteMsg(msg string, level int) error

write message in console.

type FileLogWriter

type FileLogWriter struct {
	*log.Logger

	// The opened file
	Filename string `json:"filename"`

	Maxlines int `json:"maxlines"`

	// Rotate at size
	Maxsize int `json:"maxsize"`

	// Rotate daily
	Daily   bool  `json:"daily"`
	Maxdays int64 `json:"maxdays"`

	Rotate bool `json:"rotate"`

	Level int `json:"level"`
	// contains filtered or unexported fields
}

FileLogWriter implements LoggerInterface. It writes messages by lines limit, file size limit, or time frequency.

func (*FileLogWriter) Destroy

func (w *FileLogWriter) Destroy()

destroy file logger, close file writer.

func (*FileLogWriter) DoRotate

func (w *FileLogWriter) DoRotate() error

DoRotate means it need to write file in new file. new file name like xx.log.2013-01-01.2

func (*FileLogWriter) Flush

func (w *FileLogWriter) Flush()

flush file logger. there are no buffering messages in file logger in memory. flush file means sync file from disk.

func (*FileLogWriter) Init

func (w *FileLogWriter) Init(jsonconfig string) error

Init file logger with json config. jsonconfig like:

{
"filename":"logs/GoCrab.log",
"maxlines":10000,
"maxsize":1<<30,
"daily":true,
"maxdays":15,
"rotate":true
}

func (*FileLogWriter) WriteMsg

func (w *FileLogWriter) WriteMsg(msg string, level int) error

write logger message into file.

type Logger

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

Logger is default logger in GoCrab application. it can contain several providers and log message into all providers.

func NewLogger

func NewLogger(channellen int64) *Logger

NewLogger returns a new Logger. channellen means the number of messages in chan. if the buffering chan is full, logger adapters write to file or other way.

func (*Logger) Alert

func (bl *Logger) Alert(format string, v ...interface{})

Log ALERT level message.

func (*Logger) Close

func (bl *Logger) Close()

close logger, flush all chan data and destroy all adapters in Logger.

func (*Logger) Critical

func (bl *Logger) Critical(format string, v ...interface{})

Log CRITICAL level message.

func (*Logger) Debug

func (bl *Logger) Debug(format string, v ...interface{})

Log DEBUG level message.

func (*Logger) DelLogger

func (bl *Logger) DelLogger(adaptername string) error

remove a logger adapter in Logger.

func (*Logger) Emergency

func (bl *Logger) Emergency(format string, v ...interface{})

Log EMERGENCY level message.

func (*Logger) EnableFuncCallDepth

func (bl *Logger) EnableFuncCallDepth(b bool)

enable log funcCallDepth

func (*Logger) Error

func (bl *Logger) Error(format string, v ...interface{})

Log ERROR level message.

func (*Logger) Flush

func (bl *Logger) Flush()

flush all chan data.

func (*Logger) Info deprecated

func (bl *Logger) Info(format string, v ...interface{})

Log INFO level message.

Deprecated: compatibility alias for Informational(), Will be removed in 1.5.0.

func (*Logger) Informational

func (bl *Logger) Informational(format string, v ...interface{})

Log INFORMATIONAL level message.

func (*Logger) Notice

func (bl *Logger) Notice(format string, v ...interface{})

Log NOTICE level message.

func (*Logger) SetLevel

func (bl *Logger) SetLevel(l int)

Set log message level.

If message level (such as LevelDebug) is higher than logger level (such as LevelWarning), log providers will not even be sent the message.

func (*Logger) SetLogFuncCallDepth

func (bl *Logger) SetLogFuncCallDepth(d int)

set log funcCallDepth

func (*Logger) SetLogger

func (bl *Logger) SetLogger(adaptername string, config string) error

SetLogger provides a given logger adapter into Logger with config string. config need to be correct JSON as string: {"interval":360}.

func (*Logger) Trace deprecated

func (bl *Logger) Trace(format string, v ...interface{})

Log TRACE level message.

Deprecated: compatibility alias for Debug(), Will be removed in 1.5.0.

func (*Logger) Warn deprecated

func (bl *Logger) Warn(format string, v ...interface{})

Log WARN level message.

Deprecated: compatibility alias for Warning(), Will be removed in 1.5.0.

func (*Logger) Warning

func (bl *Logger) Warning(format string, v ...interface{})

Log WARNING level message.

type LoggerInterface

type LoggerInterface interface {
	Init(config string) error
	WriteMsg(msg string, level int) error
	Destroy()
	Flush()
}

LoggerInterface defines the behavior of a log provider.

func NewConn

func NewConn() LoggerInterface

create new ConnWrite returning as LoggerInterface.

func NewConsole

func NewConsole() LoggerInterface

create ConsoleWriter returning as LoggerInterface.

func NewFileWriter

func NewFileWriter() LoggerInterface

create a FileLogWriter returning as LoggerInterface.

type MuxWriter

type MuxWriter struct {
	sync.Mutex
	// contains filtered or unexported fields
}

an *os.File writer with locker.

func (*MuxWriter) SetFd

func (l *MuxWriter) SetFd(fd *os.File)

set os.File in writer.

func (*MuxWriter) Write

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

write to os.File.

Jump to

Keyboard shortcuts

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