log

Documentation

Overview

Package log 表示经过封装的日志功能

Index

• Constants
• Variables
• func CloneContextForConcurrency(ctx context.Context) context.Context
• func CloneContextForDetach(ctx context.Context) context.Context
• func Debug(v ...any)
• func DebugContext(ctx context.Context, v ...any)
• func DebugContextf(ctx context.Context, f string, v ...any)
• func Debugf(f string, v ...any)
• func Error(v ...any)
• func ErrorContext(ctx context.Context, v ...any)
• func ErrorContextf(ctx context.Context, f string, v ...any)
• func Errorf(f string, v ...any)
• func Fatal(v ...any)
• func FatalContext(ctx context.Context, v ...any)
• func FatalContextf(ctx context.Context, f string, v ...any)
• func Fatalf(f string, v ...any)
• func Info(v ...any)
• func InfoContext(ctx context.Context, v ...any)
• func InfoContextf(ctx context.Context, f string, v ...any)
• func Infof(f string, v ...any)
• func RegisterTraceLogFilter()
• func SetLevel(levelString string)
• func ToErrJSON(e error) fmt.Stringer
• func ToJSON(v any) fmt.Stringer
• func ToJSONString(v any) fmt.Stringer
• func Warn(v ...any)
• func WarnContext(ctx context.Context, v ...any)
• func WarnContextf(ctx context.Context, f string, v ...any)
• func Warnf(f string, v ...any)
• func WithLogger(ctx context.Context, l *Logger) context.Context
• type Logger
  • func GetLogger(ctx context.Context) *Logger
  • func New() *Logger
  • func (l *Logger) Debug()
  • func (l *Logger) DebugContext(ctx context.Context)
  • func (l *Logger) Err(err error) *Logger
  • func (l *Logger) Error()
  • func (l *Logger) ErrorContext(ctx context.Context)
  • func (l *Logger) Fatal()
  • func (l *Logger) FatalContext(ctx context.Context)
  • func (l *Logger) Format(f string, a ...any) *Logger
  • func (l *Logger) Info()
  • func (l *Logger) InfoContext(ctx context.Context)
  • func (l *Logger) Text(txt string) *Logger
  • func (l *Logger) Warn()
  • func (l *Logger) WarnContext(ctx context.Context)
  • func (l *Logger) With(key string, value any) *Logger
  • func (l *Logger) WithCallerStack() *Logger
  • func (l *Logger) WithJSON(key string, v any) *Logger

Constants

const (
	// tracelog 的 filter 名称
	FilterName = "tracelog"
	// TraceIDMetadataKey 定义用于传递 trace ID 的 trpc metadata 字段
	TraceIDStackMetadataKey = "trace_id_stack"
)

Variables

var EnsureTraceID = trace.EnsureTraceID

EnsureTraceID 确保 context 中有一个 trace ID

var TraceID = trace.TraceID

TraceID 从 context 中读取 trace ID

var WithTraceID = trace.WithTraceID

WithTraceID 更新 trace ID

Functions

func CloneContextForConcurrency

func CloneContextForConcurrency(ctx context.Context) context.Context

CloneContextForConcurrency 复制一个用于并发操作的新的 ctx, 包含 timeout 和 cancel 同步

func CloneContextForDetach

func CloneContextForDetach(ctx context.Context) context.Context

CloneContextForDetach 复制一个用于分离操作的新的 ctx, 不包含 timeout 和 cancel 同步

func Debug

func Debug(v ...any)

Debug 输出 debug 级别参数列表日志

func DebugContext

func DebugContext(ctx context.Context, v ...any)

DebugContext 输出 debug 级别参数列表日志

func DebugContextf

func DebugContextf(ctx context.Context, f string, v ...any)

DebugContextf 格式化输出 debug 级别日志

func Debugf

func Debugf(f string, v ...any)

Debugf 格式化输出 debug 级别日志

func Error

func Error(v ...any)

Error 输出 error 级别参数列表日志

func ErrorContext

func ErrorContext(ctx context.Context, v ...any)

ErrorContext 输出 error 级别参数列表日志

func ErrorContextf

func ErrorContextf(ctx context.Context, f string, v ...any)

ErrorContextf 格式化输出 error 级别日志

func Errorf

func Errorf(f string, v ...any)

Errorf 格式化输出 error 级别日志

func Fatal

func Fatal(v ...any)

Fatal 输出 fatal 级别参数列表日志

func FatalContext

func FatalContext(ctx context.Context, v ...any)

FatalContext 输出 fatal 级别参数列表日志

func FatalContextf

func FatalContextf(ctx context.Context, f string, v ...any)

FatalContextf 格式化输出 fatal 级别日志

func Fatalf

func Fatalf(f string, v ...any)

Fatalf 格式化输出 fatal 级别日志

func Info

func Info(v ...any)

Info 输出 info 级别参数列表日志

func InfoContext

func InfoContext(ctx context.Context, v ...any)

InfoContext 输出 info 级别参数列表日志

func InfoContextf

func InfoContextf(ctx context.Context, f string, v ...any)

InfoContextf 格式化输出 info 级别日志

func Infof

func Infof(f string, v ...any)

Infof 格式化输出 info 级别日志

func RegisterTraceLogFilter

func RegisterTraceLogFilter()

RegisterTraceLogFilter 注册 tracelog filter。请在 trpc.NewServer 之前调用。

func SetLevel

func SetLevel(levelString string)

SetLevel 设置日志级别, 参数为 debug, info, warn, error, fatal 这些

func ToErrJSON

func ToErrJSON(e error) fmt.Stringer

func ToJSON

func ToJSON(v any) fmt.Stringer

ToJSON 在打日志的时候转为 JSON string

func ToJSONString

func ToJSONString(v any) fmt.Stringer

func Warn

func Warn(v ...any)

Warn 输出 warn 级别参数列表日志

func WarnContext

func WarnContext(ctx context.Context, v ...any)

WarnContext 输出 warn 级别参数列表日志

func WarnContextf

func WarnContextf(ctx context.Context, f string, v ...any)

WarnContextf 格式化输出 warn 级别日志

func Warnf

func Warnf(f string, v ...any)

Warnf 格式化输出 warn 级别日志

func WithLogger

func WithLogger(ctx context.Context, l *Logger) context.Context

往 context 中注入 logger

Types

type Logger

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

Logger 结构化 logger

func GetLogger

func GetLogger(ctx context.Context) *Logger

GetLogger 从 context 中读取 logger

func New

func New() *Logger

New 新建一个结构化日志项, 即便是 nil 也是可执行的

func (*Logger) Debug

func (l *Logger) Debug()

func (*Logger) DebugContext

func (l *Logger) DebugContext(ctx context.Context)

func (*Logger) Err

func (l *Logger) Err(err error) *Logger

func (*Logger) Error

func (l *Logger) Error()

func (*Logger) ErrorContext

func (l *Logger) ErrorContext(ctx context.Context)

func (*Logger) Fatal

func (l *Logger) Fatal()

func (*Logger) FatalContext

func (l *Logger) FatalContext(ctx context.Context)

func (*Logger) Format

func (l *Logger) Format(f string, a ...any) *Logger

func (*Logger) Info

func (l *Logger) Info()

func (*Logger) InfoContext

func (l *Logger) InfoContext(ctx context.Context)

func (*Logger) Text

func (l *Logger) Text(txt string) *Logger

func (*Logger) Warn

func (l *Logger) Warn()

func (*Logger) WarnContext

func (l *Logger) WarnContext(ctx context.Context)

func (*Logger) With

func (l *Logger) With(key string, value any) *Logger

With 往 logger 中存入结构化字段

func (*Logger) WithCallerStack

func (l *Logger) WithCallerStack() *Logger

WithCallerStack 往 logger 中存入调用链

func (*Logger) WithJSON

func (l *Logger) WithJSON(key string, v any) *Logger