logs

package
v1.12.3 Latest Latest
Warning

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

 Go to latest Published: Nov 3, 2020 License: Apache-2.0 Imports: 20 Imported by: 4,118

README

logs

logs is a Go logs manager. It can use many logs adapters. The repo is inspired by database/sql .

How to install?

go get github.com/astaxie/beego/logs

What adapters are supported?

As of now this logs support console, file,smtp and conn.

How to use it?

First you must import it

import (
	"github.com/astaxie/beego/logs"
)

Then init a Log (example with console adapter)

log := logs.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")

File adapter

Configure file adapter like this:

log := NewLogger(10000)
log.SetLogger("file", `{"filename":"test.log"}`)

Conn adapter

Configure like this:

log := NewLogger(1000)
log.SetLogger("conn", `{"net":"tcp","addr":":7020"}`)
log.Info("info")

Smtp adapter

Configure like this:

log := NewLogger(10000)
log.SetLogger("smtp", `{"username":"beegotest@gmail.com","password":"xxxxxxxx","host":"smtp.gmail.com:587","sendTos":["xiemengjun@gmail.com"]}`)
log.Critical("sendmail critical")
time.Sleep(time.Second * 30)

Documentation

Overview

Package logs provide a general log interface Usage:

import "github.com/astaxie/beego/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")

 more docs http://beego.me/docs/module/logs.md

Index

Constants

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

RFC5424 log message levels.

View Source 
const (
	AdapterConsole   = "console"
	AdapterFile      = "file"
	AdapterMultiFile = "multifile"
	AdapterMail      = "smtp"
	AdapterConn      = "conn"
	AdapterEs        = "es"
	AdapterJianLiao  = "jianliao"
	AdapterSlack     = "slack"
	AdapterAliLS     = "alils"
)

Name for adapter with beego official support

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

Legacy log level constants to ensure backwards compatibility.

Variables

This section is empty.

Functions

func AccessLog added in v1.9.2 

func AccessLog(r *AccessLogRecord, format string)

AccessLog - Format and print access log.

func Alert added in v1.7.0 

func Alert(f interface{}, v ...interface{})

Alert logs a message at alert level.

func ColorByMethod added in v1.7.0 

func ColorByMethod(method string) string

ColorByMethod return color by http code

func ColorByStatus added in v1.7.0 

func ColorByStatus(code int) string

ColorByStatus return color by http code 2xx return Green 3xx return White 4xx return Yellow 5xx return Red

func Critical added in v1.7.0 

func Critical(f interface{}, v ...interface{})

Critical logs a message at critical level.

func Debug added in v1.7.0 

func Debug(f interface{}, v ...interface{})

Debug logs a message at debug level.

func Emergency added in v1.7.0 

func Emergency(f interface{}, v ...interface{})

Emergency logs a message at emergency level.

func EnableFuncCallDepth added in v1.7.0 

func EnableFuncCallDepth(b bool)

EnableFuncCallDepth enable log funcCallDepth

func Error added in v1.7.0 

func Error(f interface{}, v ...interface{})

Error logs a message at error level.

func GetLogger added in v1.7.0 

func GetLogger(prefixes ...string) *log.Logger

GetLogger returns the default BeeLogger

func Info added in v1.7.0 

func Info(f interface{}, v ...interface{})

Info compatibility alias for Warning()

func Informational added in v1.7.0 

func Informational(f interface{}, v ...interface{})

Informational logs a message at info level.

func Notice added in v1.7.0 

func Notice(f interface{}, v ...interface{})

Notice logs a message at notice level.

func Register 

func Register(name string, log newLoggerFunc)

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.

func Reset added in v1.7.0 

func Reset()

Reset will remove all the adapter

func ResetColor added in v1.12.0 

func ResetColor() string

ResetColor return reset color

func SetLevel added in v1.7.0 

func SetLevel(l int)

SetLevel sets the global log level used by the simple logger.

func SetLogFuncCall added in v1.7.0 

func SetLogFuncCall(b bool)

SetLogFuncCall set the CallDepth, default is 4

func SetLogFuncCallDepth added in v1.7.0 

func SetLogFuncCallDepth(d int)

SetLogFuncCallDepth set log funcCallDepth

func SetLogger added in v1.7.0 

func SetLogger(adapter string, config ...string) error

SetLogger sets a new logger.

func SetPrefix added in v1.10.0 

func SetPrefix(s string)

SetPrefix sets the prefix

func Trace added in v1.7.0 

func Trace(f interface{}, v ...interface{})

Trace logs a message at trace level. compatibility alias for Warning()

func Warn added in v1.7.0 

func Warn(f interface{}, v ...interface{})

Warn compatibility alias for Warning()

func Warning added in v1.7.0 

func Warning(f interface{}, v ...interface{})

Warning logs a message at warning level.

Types

type AccessLogRecord added in v1.9.2 

type AccessLogRecord struct {
	RemoteAddr     string        `json:"remote_addr"`
	RequestTime    time.Time     `json:"request_time"`
	RequestMethod  string        `json:"request_method"`
	Request        string        `json:"request"`
	ServerProtocol string        `json:"server_protocol"`
	Host           string        `json:"host"`
	Status         int           `json:"status"`
	BodyBytesSent  int64         `json:"body_bytes_sent"`
	ElapsedTime    time.Duration `json:"elapsed_time"`
	HTTPReferrer   string        `json:"http_referrer"`
	HTTPUserAgent  string        `json:"http_user_agent"`
	RemoteUser     string        `json:"remote_user"`
}

AccessLogRecord struct for holding access log data.

type BeeLogger 

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

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

func Async added in v1.7.0 

func Async(msgLen ...int64) *BeeLogger

Async set the beelogger with Async mode and hold msglen messages

func GetBeeLogger added in v1.7.0 

func GetBeeLogger() *BeeLogger

GetBeeLogger returns the default BeeLogger

func NewLogger 

func NewLogger(channelLens ...int64) *BeeLogger

NewLogger returns a new BeeLogger. channelLen means the number of messages in chan(used where asynchronous is true). if the buffering chan is full, logger adapters write to file or other way.

func (*BeeLogger) Alert added in v1.4.0 

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

Alert Log ALERT level message.

func (*BeeLogger) Async added in v1.5.0 

func (bl *BeeLogger) Async(msgLen ...int64) *BeeLogger

Async set the log to asynchronous and start the goroutine

func (*BeeLogger) Close 

func (bl *BeeLogger) Close()

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

func (*BeeLogger) Critical 

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

Critical Log CRITICAL level message.

func (*BeeLogger) Debug 

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

Debug Log DEBUG level message.

func (*BeeLogger) DelLogger 

func (bl *BeeLogger) DelLogger(adapterName string) error

DelLogger remove a logger adapter in BeeLogger.

func (*BeeLogger) Emergency added in v1.4.0 

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

Emergency Log EMERGENCY level message.

func (*BeeLogger) EnableFuncCallDepth 

func (bl *BeeLogger) EnableFuncCallDepth(b bool)

EnableFuncCallDepth enable log funcCallDepth

func (*BeeLogger) Error 

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

Error Log ERROR level message.

func (*BeeLogger) Flush 

func (bl *BeeLogger) Flush()

Flush flush all chan data.

func (*BeeLogger) GetLevel added in v1.10.0 

func (bl *BeeLogger) GetLevel() int

GetLevel Get Current log message level.

func (*BeeLogger) GetLogFuncCallDepth added in v1.5.0 

func (bl *BeeLogger) GetLogFuncCallDepth() int

GetLogFuncCallDepth return log funcCallDepth for wrapper

func (*BeeLogger) Info 

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

Info Log INFO level message. compatibility alias for Informational()

func (*BeeLogger) Informational added in v1.4.0 

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

Informational Log INFORMATIONAL level message.

func (*BeeLogger) Notice added in v1.4.0 

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

Notice Log NOTICE level message.

func (*BeeLogger) Reset added in v1.6.1 

func (bl *BeeLogger) Reset()

Reset close all outputs, and set bl.outputs to nil

func (*BeeLogger) SetLevel 

func (bl *BeeLogger) SetLevel(l int)

SetLevel 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 (*BeeLogger) SetLogFuncCallDepth 

func (bl *BeeLogger) SetLogFuncCallDepth(d int)

SetLogFuncCallDepth set log funcCallDepth

func (*BeeLogger) SetLogger 

func (bl *BeeLogger) SetLogger(adapterName string, configs ...string) error

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

func (*BeeLogger) SetPrefix added in v1.10.0 

func (bl *BeeLogger) SetPrefix(s string)

set prefix

func (*BeeLogger) Trace 

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

Trace Log TRACE level message. compatibility alias for Debug()

func (*BeeLogger) Warn 

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

Warn Log WARN level message. compatibility alias for Warning()

func (*BeeLogger) Warning added in v1.4.0 

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

Warning Log WARNING level message.

func (*BeeLogger) Write added in v1.7.0 

func (bl *BeeLogger) Write(p []byte) (n int, err error)

type JLWriter added in v1.7.1 

type JLWriter struct {
	AuthorName  string `json:"authorname"`
	Title       string `json:"title"`
	WebhookURL  string `json:"webhookurl"`
	RedirectURL string `json:"redirecturl,omitempty"`
	ImageURL    string `json:"imageurl,omitempty"`
	Level       int    `json:"level"`
}

JLWriter implements beego LoggerInterface and is used to send jiaoliao webhook

func (*JLWriter) Destroy added in v1.7.1 

func (s *JLWriter) Destroy()

Destroy implementing method. empty.

func (*JLWriter) Flush added in v1.7.1 

func (s *JLWriter) Flush()

Flush implementing method. empty.

func (*JLWriter) Init added in v1.7.1 

func (s *JLWriter) Init(jsonconfig string) error

Init JLWriter with json config string

func (*JLWriter) WriteMsg added in v1.7.1 

func (s *JLWriter) WriteMsg(when time.Time, msg string, level int) error

WriteMsg write message in smtp writer. it will send an email with subject and only this message.

type Logger added in v1.6.0 

type Logger interface {
	Init(config string) error
	WriteMsg(when time.Time, msg string, level int) error
	Destroy()
	Flush()
}

Logger defines the behavior of a log provider.

func NewConn 

func NewConn() Logger

NewConn create new ConnWrite returning as LoggerInterface.

func NewConsole 

func NewConsole() Logger

NewConsole create ConsoleWriter returning as LoggerInterface.

type SLACKWriter added in v1.7.1 

type SLACKWriter struct {
	WebhookURL string `json:"webhookurl"`
	Level      int    `json:"level"`
}

SLACKWriter implements beego LoggerInterface and is used to send jiaoliao webhook

func (*SLACKWriter) Destroy added in v1.7.1 

func (s *SLACKWriter) Destroy()

Destroy implementing method. empty.

func (*SLACKWriter) Flush added in v1.7.1 

func (s *SLACKWriter) Flush()

Flush implementing method. empty.

func (*SLACKWriter) Init added in v1.7.1 

func (s *SLACKWriter) Init(jsonconfig string) error

Init SLACKWriter with json config string

func (*SLACKWriter) WriteMsg added in v1.7.1 

func (s *SLACKWriter) WriteMsg(when time.Time, msg string, level int) error

WriteMsg write message in smtp writer. it will send an email with subject and only this message.

type SMTPWriter added in v1.6.0 

type SMTPWriter struct {
	Username           string   `json:"username"`
	Password           string   `json:"password"`
	Host               string   `json:"host"`
	Subject            string   `json:"subject"`
	FromAddress        string   `json:"fromAddress"`
	RecipientAddresses []string `json:"sendTos"`
	Level              int      `json:"level"`
}

SMTPWriter implements LoggerInterface and is used to send emails via given SMTP-server.

func (*SMTPWriter) Destroy added in v1.6.0 

func (s *SMTPWriter) Destroy()

Destroy implementing method. empty.

func (*SMTPWriter) Flush added in v1.6.0 

func (s *SMTPWriter) Flush()

Flush implementing method. empty.

func (*SMTPWriter) Init added in v1.6.0 

func (s *SMTPWriter) Init(jsonconfig string) error

Init smtp writer with json config. config like: 

{
	"username":"example@gmail.com",
	"password:"password",
	"host":"smtp.gmail.com:465",
	"subject":"email title",
	"fromAddress":"from@example.com",
	"sendTos":["email1","email2"],
	"level":LevelError
}

func (*SMTPWriter) WriteMsg added in v1.6.0 

func (s *SMTPWriter) WriteMsg(when time.Time, msg string, level int) error

WriteMsg write message in smtp writer. it will send an email with subject and only this message.

Source Files

View all Source files

Directories

Path Synopsis
Package alils implements the SDK(v0.5.0) of Simple Log Service(abbr.
 Package alils implements the SDK(v0.5.0) of Simple Log Service(abbr.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.