log

package
v2.6.0 Latest Latest
Warning

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

Go to latest
Published: Aug 31, 2023 License: GPL-3.0 Imports: 3 Imported by: 184

README

日志处理

这是一个用来处理日志的库,它引用自beego/logs库,目前支持的引擎有 file、console、net、smtp,可以通过如下方式进行安装:

go get github.com/blocktree/OpenWallet/log

如何使用

通用方式

首先引入包:

import (
	"github.com/blocktree/OpenWallet/log"
)

然后添加输出引擎(log 支持同时输出到多个引擎),这里我们以 console 为例,第一个参数是引擎名(包括:console、file、conn、smtp、es、multifile)

log.SetLogger("console")

添加输出引擎也支持第二个参数,用来表示配置信息,详细的配置请看下面介绍:

log.SetLogger(log.AdapterFile,`{"filename":"project.log","level":7,"maxlines":0,"maxsize":0,"daily":true,"maxdays":10}`)

然后我们就可以在我们的逻辑中开始任意的使用了:

package main

import (
	"github.com/blocktree/OpenWallet/log"
)

func main() {

    log.Debug("my book is bought in the year of ", 2016)
 	log.Info("this %s cat is %v years old", "yellow", 3)
 	log.Warn("json is a type of kv like", map[string]int{"key": 2016})
   	log.Error(1024, "is a very", "good game")
   	log.Critical("oh,crash")
}
多个实例

一般推荐使用通用方式进行日志,但依然支持单独声明来使用独立的日志

    package main

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

    func main() {
    	log := logs.NewLogger()
    	log.SetLogger(log.AdapterConsole)
    	log.Debug("this is a debug message")
    }

输出文件名和行号

日志默认不输出调用的文件名和文件行号,如果你期望输出调用的文件名和文件行号,可以如下设置

log.EnableFuncCallDepth(true)

开启传入参数 true,关闭传入参数 false,默认是关闭的.

如果你的应用自己封装了调用 log 包,那么需要设置 SetLogFuncCallDepth,默认是 2,也就是直接调用的层级,如果你封装了多层,那么需要根据自己的需求进行调整.

log.SetLogFuncCallDepth(3)

异步输出日志

为了提升性能, 可以设置异步输出:

log.Async()

异步输出允许设置缓冲 chan 的大小

log.Async(1e3)

引擎配置设置

  • console 命令行输出,默认输出到os.Stdout

      log.SetLogger(log.AdapterConsole, `{"level":1,"color":true}`)
    

    主要的参数如下说明:

    • level 输出的日志级别
    • color 是否开启打印日志彩色打印(需环境支持彩色输出)
  • file

    设置的例子如下所示:

      log.SetLogger(log.AdapterFile, `{"filename":"test.log"}`)
    

    主要的参数如下说明:

    • filename 保存的文件名
    • maxlines 每个文件保存的最大行数,默认值 1000000
    • maxsize 每个文件保存的最大尺寸,默认值是 1 << 28, //256 MB
    • daily 是否按照每天 logrotate,默认是 true
    • maxdays 文件最多保存多少天,默认保存 7 天
    • rotate 是否开启 logrotate,默认是 true
    • level 日志保存的时候的级别,默认是 Trace 级别
    • perm 日志文件权限
  • multifile

    设置的例子如下所示:

      log.SetLogger(log.AdapterMultiFile, `{"filename":"test.log","separate":["emergency", "alert", "critical", "error", "warning", "notice", "info", "debug"]}`)
    

    主要的参数如下说明(除 separate 外,均与file相同):

    • filename 保存的文件名
    • maxlines 每个文件保存的最大行数,默认值 1000000
    • maxsize 每个文件保存的最大尺寸,默认值是 1 << 28, //256 MB
    • daily 是否按照每天 logrotate,默认是 true
    • maxdays 文件最多保存多少天,默认保存 7 天
    • rotate 是否开启 logrotate,默认是 true
    • level 日志保存的时候的级别,默认是 Trace 级别
    • perm 日志文件权限
    • separate 需要单独写入文件的日志级别,设置后命名类似 test.error.log
  • conn

    网络输出,设置的例子如下所示:

      log.SetLogger(log.AdapterConn, `{"net":"tcp","addr":":7020"}`)
    

    主要的参数说明如下:

    • reconnectOnMsg 是否每次链接都重新打开链接,默认是 false
    • reconnect 是否自动重新链接地址,默认是 false
    • net 发开网络链接的方式,可以使用 tcp、unix、udp 等
    • addr 网络链接的地址
    • level 日志保存的时候的级别,默认是 Trace 级别
  • smtp

    邮件发送,设置的例子如下所示:

      log.SetLogger(log.AdapterMail, `{"username":"beegotest@gmail.com","password":"xxxxxxxx","host":"smtp.gmail.com:587","sendTos":["xiemengjun@gmail.com"]}`)
    

    主要的参数说明如下:

    • username smtp 验证的用户名
    • password smtp 验证密码
    • host 发送的邮箱地址
    • sendTos 邮件需要发送的人,支持多个
    • subject 发送邮件的标题,默认是 Diagnostic message from server
    • level 日志发送的级别,默认是 Trace 级别
  • ElasticSearch

    输出到 ElasticSearch:

      log.SetLogger(log.AdapterEs, `{"dsn":"http://localhost:9200/","level":1}`)
    
  • 简聊

    输出到简聊:

      log.SetLogger(log.AdapterJianLiao, `{"authorname":"xxx","title":"beego", "webhookurl":"https://jianliao.com/xxx", "redirecturl":"https://jianliao.com/xxx","imageurl":"https://jianliao.com/xxx","level":1}`)
    
  • slack

    输出到slack:

      log.SetLogger(log.AdapterSlack, `{"webhookurl":"https://slack.com/xxx","level":1}`)
    

Documentation

Index

Constants

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

Log levels to control the logging output.

Variables

View Source
var Std = newLogger("")

BeeLogger references the used application logger.

Functions

func Alert

func Alert(v ...interface{})

Alert logs a message at alert level.

func Critical

func Critical(v ...interface{})

Critical logs a message at critical level.

func Debug

func Debug(v ...interface{})

Debug logs a message at debug level.

func Debugf

func Debugf(format string, v ...interface{})

Format & debug logs a message at debug level.

func Emergency

func Emergency(v ...interface{})

Emergency logs a message at emergency level.

func Error

func Error(v ...interface{})

Error logs a message at error level.

func Errorf

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

format & Error logs a message at error level.

func Info

func Info(v ...interface{})

Info compatibility alias for Warning()

func Infof

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

func Informational

func Informational(v ...interface{})

Informational logs a message at info level.

func Notice

func Notice(v ...interface{})

Notice logs a message at notice level.

func SetLevel

func SetLevel(l int)

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

func SetLogFuncCall

func SetLogFuncCall(b bool)

SetLogFuncCall set the CallDepth, default is 3

func SetLogger

func SetLogger(adaptername string, config string) error

SetLogger sets a new logger.

func Trace

func Trace(v ...interface{})

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

func Warn

func Warn(v ...interface{})

Warn compatibility alias for Warning()

func Warning

func Warning(v ...interface{})

Warning logs a message at warning level.

func Warningf

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

format & Warning logs a message at warning level.

Types

type OWLogger

type OWLogger struct {
	Std *logger
}

func NewOWLogger

func NewOWLogger(prefix string) *OWLogger

NewOWLogger 初始化一个日志工具,以[prefix]前缀

func (*OWLogger) Alert

func (logger *OWLogger) Alert(v ...interface{})

Alert logs a message at alert level.

func (*OWLogger) Critical

func (logger *OWLogger) Critical(v ...interface{})

Critical logs a message at critical level.

func (*OWLogger) Debug

func (logger *OWLogger) Debug(v ...interface{})

Debug logs a message at debug level.

func (*OWLogger) Debugf

func (logger *OWLogger) Debugf(format string, v ...interface{})

Format & debug logs a message at debug level.

func (*OWLogger) Emergency

func (logger *OWLogger) Emergency(v ...interface{})

Emergency logs a message at emergency level.

func (*OWLogger) Error

func (logger *OWLogger) Error(v ...interface{})

Error logs a message at error level.

func (*OWLogger) Errorf

func (logger *OWLogger) Errorf(format string, v ...interface{})

format & Error logs a message at error level.

func (*OWLogger) Info

func (logger *OWLogger) Info(v ...interface{})

Info compatibility alias for Warning()

func (*OWLogger) Infof

func (logger *OWLogger) Infof(format string, v ...interface{})

func (*OWLogger) Informational

func (logger *OWLogger) Informational(v ...interface{})

Informational logs a message at info level.

func (*OWLogger) Notice

func (logger *OWLogger) Notice(v ...interface{})

Notice logs a message at notice level.

func (*OWLogger) SetLevel

func (logger *OWLogger) SetLevel(l int)

SetLevel 设置打印级别

func (*OWLogger) SetLogFuncCall

func (logger *OWLogger) SetLogFuncCall(b bool)

SetLogFuncCall set the CallDepth, default is 3

func (*OWLogger) SetLogger

func (logger *OWLogger) SetLogger(adaptername string, config string) error

SetLogger sets a new logger.

func (*OWLogger) SetPrefix

func (logger *OWLogger) SetPrefix(prefix string)

SetPrefix 设置前缀

func (*OWLogger) Trace

func (logger *OWLogger) Trace(v ...interface{})

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

func (*OWLogger) Warn

func (logger *OWLogger) Warn(v ...interface{})

Warn compatibility alias for Warning()

func (*OWLogger) Warning

func (logger *OWLogger) Warning(v ...interface{})

Warning logs a message at warning level.

func (*OWLogger) Warningf

func (logger *OWLogger) Warningf(format string, v ...interface{})

format & Warning logs a message at warning level.

Jump to

Keyboard shortcuts

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