wlog

README

Intrucdutions

日志组件

日志级别

1. Info 普通级别，用户打印功能日志，方便用户排错
2. Debug 开发阶段日志，上线不会打印。方便调试
3. Warning 告警日志。这个级别的日志可以用来进行监控告警
4. Error 错误日志，出现业务错误时，方便差错

v1.0.0 版本功能

1. 满足基本的日志功能 -. 日志输出 （文件，控制台)

v1.0.1 版本

1. 支持GA模块封装

v1.0.2 版本

1. 支持夜莺上报

Documentation

Index

• Constants
• Variables
• func AppID(string)
• func Date(string)
• func ErrorCode(string)
• func ErrorMsg(string)
• func EventID(string)
• func Host(string)
• func Metadata(map[string]string)
• func NameSpace(string)
• func Object(interface{})
• func Package(string)
• func RequestID(string)
• func Route(string)
• func ServerID(string)
• func Timestamp(int64)
• func UserAgent(string)
• func UserID(string)
• type AdapterLogger
• type Elk
• type Entry
  • func (entry *Entry) Debug(msg string)
  • func (entry *Entry) Error(msg string)
  • func (elk *Entry) ErrorMsg(value string) *Entry
  • func (elk *Entry) ErrorReport(value string) *Entry
  • func (elk *Entry) EventId(value string) *Entry
  • func (elk *Entry) EventParam(params interface{}) *Entry
  • func (entry *Entry) Flush() *Entry
  • func (entry *Entry) Info(msg string)
  • func (entry *Entry) Int(key string, value int) *Entry
  • func (entry *Entry) Int32(key string, value int32) *Entry
  • func (entry *Entry) Int64(key string, value int64) *Entry
  • func (elk *Entry) Metadata(data map[string]string) *Entry
  • func (entry *Entry) MustAppend() *Entry
  • func (elk *Entry) MustAppendContext(ctx context.Context) *Entry
  • func (elk *Entry) MustAppendFromGinContext(ctx *gin.Context) *Entry
  • func (elk *Entry) NameSpace(value string) *Entry
  • func (entry *Entry) Object(key string, value interface{}) *Entry
  • func (elk *Entry) Rparam(params interface{}) *Entry
  • func (entry *Entry) String(key string, value string) *Entry
  • func (elk *Entry) SubEventId(value string) *Entry
  • func (elk *Entry) UseID(value string) *Entry
  • func (entry *Entry) Warning(msg string)
• type Level
• type Log
  • func NewLogger(adapterLogger AdapterLogger, msg string) *Log
  • func (log *Log) WithElkEntry(msg string) *Entry
  • func (log *Log) WithEntry(msg string) *Entry
• type Logger
• type TYFields

Constants

const Version = "v1.0.2"

Variables

var ErrorAdapter = errors.New("please set log adapter")

Functions

func AppID

func AppID(string)

func Date

func Date(string)

func ErrorCode

func ErrorCode(string)

func ErrorMsg

func ErrorMsg(string)

func EventID

func EventID(string)

func Host

func Host(string)

func Metadata

func Metadata(map[string]string)

func NameSpace

func NameSpace(string)

func Object

func Object(interface{})

func Package

func Package(string)

func RequestID

func RequestID(string)

func Route

func Route(string)

func ServerID

func ServerID(string)

func Timestamp

func Timestamp(int64)

func UserAgent

func UserAgent(string)

func UserID

func UserID(string)

Types

type AdapterLogger

type AdapterLogger interface {
	Info(level Level, msg string, field TYFields)
}

type Elk

type Elk struct {
	*Entry
}

type Entry

type Entry struct {
	Data   TYFields
	Logger *Log
	// contains filtered or unexported fields
}

func (*Entry) Debug

func (entry *Entry) Debug(msg string)

Debug 打印调试日志

func (*Entry) Error

func (entry *Entry) Error(msg string)

Error 打印错误日志

func (*Entry) ErrorMsg

func (elk *Entry) ErrorMsg(value string) *Entry

ErrorMsg 错误信息

func (*Entry) ErrorReport

func (elk *Entry) ErrorReport(value string) *Entry

ErrorReport 错误上报

func (*Entry) EventId

func (elk *Entry) EventId(value string) *Entry

EventId 事件id

func (*Entry) EventParam

func (elk *Entry) EventParam(params interface{}) *Entry

EventParam 时间参数

func (*Entry) Flush

func (entry *Entry) Flush() *Entry

Flush 输出日志

func (*Entry) Info

func (entry *Entry) Info(msg string)

Info 打印普通日志

func (*Entry) Int

func (entry *Entry) Int(key string, value int) *Entry

Int 类型

func (*Entry) Int32

func (entry *Entry) Int32(key string, value int32) *Entry

Int32 值类型的数据

func (*Entry) Int64

func (entry *Entry) Int64(key string, value int64) *Entry

Int64 类型

func (*Entry) Metadata

func (elk *Entry) Metadata(data map[string]string) *Entry

Metadata

func (*Entry) MustAppend

func (entry *Entry) MustAppend() *Entry

MustAppend 预定义字段

func (*Entry) MustAppendContext

func (elk *Entry) MustAppendContext(ctx context.Context) *Entry

MustAppendContext context

func (*Entry) MustAppendFromGinContext

func (elk *Entry) MustAppendFromGinContext(ctx *gin.Context) *Entry

MustAppendFromGinContext 使用gin context

func (*Entry) NameSpace

func (elk *Entry) NameSpace(value string) *Entry

NameSpace 项目ID

func (*Entry) Object

func (entry *Entry) Object(key string, value interface{}) *Entry

Object 类数据

func (*Entry) Rparam

func (elk *Entry) Rparam(params interface{}) *Entry

Rparam 时间参数

func (*Entry) String

func (entry *Entry) String(key string, value string) *Entry

String 类型

func (*Entry) SubEventId

func (elk *Entry) SubEventId(value string) *Entry

SubEventId subeventId

func (*Entry) UseID

func (elk *Entry) UseID(value string) *Entry

NameSpace 项目ID

func (*Entry) Warning

func (entry *Entry) Warning(msg string)

Warning 打印警告日志

type Level

type Level int

const (
	DEBUG Level = iota + 1
	INFO
	WARNING
	ERROR
)

type Log

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

log tylog日志

func NewLogger

func NewLogger(adapterLogger AdapterLogger, msg string) *Log

NewLogger 创建新的日志组件

func (*Log) WithElkEntry

func (log *Log) WithElkEntry(msg string) *Entry

NewEntry creates a elk entry

func (*Log) WithEntry

func (log *Log) WithEntry(msg string) *Entry

NewEntry creates a new entry

type Logger

type Logger interface {
	Info(msg string)
	Debug(msg string)
	Warning(msg string)
	Error(msg string)
}

type TYFields

type TYFields map[string]interface{}

TYFileds type, used to pass to `WithFields`.