logger

Documentation

Index

• Constants
• func AddHook(hook Hook)
• func Debugf(ctx context.Context, format string, args ...interface{})
• func Errorf(ctx context.Context, format string, args ...interface{})
• func Fatalf(ctx context.Context, format string, args ...interface{})
• func FromSpanIDContext(ctx context.Context) string
• func FromTraceIDContext(ctx context.Context) string
• func FromUserIDContext(ctx context.Context) string
• func Infof(ctx context.Context, format string, args ...interface{})
• func NewSpanIDContext(ctx context.Context, spanID string) context.Context
• func NewTraceIDContext(ctx context.Context, traceID string) context.Context
• func NewUserIDContext(ctx context.Context, userID string) context.Context
• func Printf(ctx context.Context, format string, args ...interface{})
• func SetFormatter(format string)
• func SetLevel(level int)
• func SetOutput(out io.Writer)
• func SetTraceIDFunc(fn TraceIDFunc)
• func SetVersion(v string)
• func StartSpanWithCall(ctx context.Context, opts ...SpanOption) func() *Entry
• func Warnf(ctx context.Context, format string, args ...interface{})
• type Entry
  • func StartSpan(ctx context.Context, opts ...SpanOption) *Entry
  • func (e *Entry) Debugf(format string, args ...interface{})
  • func (e *Entry) Errorf(format string, args ...interface{})
  • func (e *Entry) Fatalf(format string, args ...interface{})
  • func (e *Entry) Finish()
  • func (e *Entry) Infof(format string, args ...interface{})
  • func (e *Entry) Printf(format string, args ...interface{})
  • func (e *Entry) Warnf(format string, args ...interface{})
  • func (e *Entry) WithField(key string, value interface{}) *Entry
  • func (e *Entry) WithFields(fields map[string]interface{}) *Entry
• type Hook
• type Logger
  • func StandardLogger() *Logger
• type SpanOption
  • func SetSpanFuncName(funcName string) SpanOption
  • func SetSpanTitle(title string) SpanOption
• type TraceIDFunc

Constants

const (
	StartedAtKey     = "started_at"
	TraceIDKey       = "trace_id"
	UserIDKey        = "user_id"
	SpanIDKey        = "span_id"
	SpanTitleKey     = "span_title"
	SpanFunctionKey  = "span_function"
	VersionKey       = "version"
	TimeConsumingKey = "time_consuming"
)

定义键名

Functions

func AddHook

func AddHook(hook Hook)

AddHook 增加日志钩子

func Debugf

func Debugf(ctx context.Context, format string, args ...interface{})

Debugf 写入调试日志

func Errorf

func Errorf(ctx context.Context, format string, args ...interface{})

Errorf 写入错误日志

func Fatalf

func Fatalf(ctx context.Context, format string, args ...interface{})

Fatalf 写入重大错误日志

func FromSpanIDContext

func FromSpanIDContext(ctx context.Context) string

FromSpanIDContext 从上下文中获取跟踪单元ID

func FromTraceIDContext

func FromTraceIDContext(ctx context.Context) string

FromTraceIDContext 从上下文中获取跟踪ID

func FromUserIDContext

func FromUserIDContext(ctx context.Context) string

FromUserIDContext 从上下文中获取用户ID

func Infof

func Infof(ctx context.Context, format string, args ...interface{})

Infof 写入消息日志

func NewSpanIDContext

func NewSpanIDContext(ctx context.Context, spanID string) context.Context

NewSpanIDContext 创建跟踪单元ID上下文

func NewTraceIDContext

func NewTraceIDContext(ctx context.Context, traceID string) context.Context

NewTraceIDContext 创建跟踪ID上下文

func NewUserIDContext

func NewUserIDContext(ctx context.Context, userID string) context.Context

NewUserIDContext 创建用户ID上下文

func Printf

func Printf(ctx context.Context, format string, args ...interface{})

Printf 写入消息日志

func SetFormatter

func SetFormatter(format string)

SetFormatter 设定日志输出格式

func SetLevel

func SetLevel(level int)

SetLevel 设定日志级别

func SetOutput

func SetOutput(out io.Writer)

SetOutput 设定日志输出

func SetTraceIDFunc

func SetTraceIDFunc(fn TraceIDFunc)

SetTraceIDFunc 设定追踪ID的处理函数

func SetVersion

func SetVersion(v string)

SetVersion 设定版本

func StartSpanWithCall

func StartSpanWithCall(ctx context.Context, opts ...SpanOption) func() *Entry

StartSpanWithCall 开始一个追踪单元（回调执行）

func Warnf

func Warnf(ctx context.Context, format string, args ...interface{})

Warnf 写入警告日志

Types

type Entry

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

Entry 定义统一的日志写入方式

func StartSpan

func StartSpan(ctx context.Context, opts ...SpanOption) *Entry

StartSpan 开始一个追踪单元

func (*Entry) Debugf

func (e *Entry) Debugf(format string, args ...interface{})

Debugf 写入调试日志

func (*Entry) Errorf

func (e *Entry) Errorf(format string, args ...interface{})

Errorf 错误日志

func (*Entry) Fatalf

func (e *Entry) Fatalf(format string, args ...interface{})

Fatalf 重大错误日志

func (*Entry) Finish

func (e *Entry) Finish()

Finish 完成，如果没有触发写入则手动触发Info级别的日志写入

func (*Entry) Infof

func (e *Entry) Infof(format string, args ...interface{})

Infof 消息日志

func (*Entry) Printf

func (e *Entry) Printf(format string, args ...interface{})

Printf 消息日志

func (*Entry) Warnf

func (e *Entry) Warnf(format string, args ...interface{})

Warnf 警告日志

func (*Entry) WithField

func (e *Entry) WithField(key string, value interface{}) *Entry

WithField 结构化字段写入

func (*Entry) WithFields

func (e *Entry) WithFields(fields map[string]interface{}) *Entry

WithFields 结构化字段写入

type Hook

type Hook = logrus.Hook

Hook 定义日志钩子别名

type Logger

type Logger = logrus.Logger

Logger 定义日志别名

func StandardLogger

func StandardLogger() *Logger

StandardLogger 获取标准日志

type SpanOption

type SpanOption func(*spanOptions)

SpanOption 定义跟踪单元的数据项

func SetSpanFuncName

func SetSpanFuncName(funcName string) SpanOption

SetSpanFuncName 设置跟踪单元的函数名

func SetSpanTitle

func SetSpanTitle(title string) SpanOption

SetSpanTitle 设置跟踪单元的标题

type TraceIDFunc

type TraceIDFunc func() string

TraceIDFunc 定义获取跟踪ID的函数