tracelog

Documentation

Overview

Package tracelog 提供带 tracing 功能的日志功能以及一些工具

Index

• Constants
• Variables
• func EnsureTraceID(ctx context.Context) context.Context
• func Fatal(a ...any)
• func FatalContext(ctx context.Context, a ...any)
• func FatalContextf(ctx context.Context, f string, a ...any)
• func Fatalf(f string, a ...any)
• func RegisterTraceLogFilter()
• func ToErrJSON(e error) fmt.Stringer
• func ToJSON(v any) fmt.Stringer
• func ToJSONString(v any) fmt.Stringer
• func TraceID(ctx context.Context) string
• func TraceIDStack(ctx context.Context) []string
• func WithTraceID(ctx context.Context, traceID string) context.Context
• func WithTraceIDStack(ctx context.Context, traceIDStack []string) context.Context

Constants

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

Variables

var (
	DebugContextf = log.DebugContextf
	InfoContextf  = log.InfoContextf
	WarnContextf  = log.WarnContextf
	ErrorContextf = log.ErrorContextf

	DebugContext = log.DebugContext
	InfoContext  = log.InfoContext
	WarnContext  = log.WarnContext
	ErrorContext = log.ErrorContext

	Debugf = log.Debugf
	Infof  = log.Infof
	Warnf  = log.Warnf
	Errorf = log.Errorf

	Debug = log.Debug
	Info  = log.Info
	Warn  = log.Warn
	Error = log.Error
)

Functions

func EnsureTraceID

func EnsureTraceID(ctx context.Context) context.Context

EnsureTraceID 确保 context 中有一个 trace ID, 协程不安全

func Fatal

func Fatal(a ...any)

Fatal 打 fatal 级别日志并退出应用程序

func FatalContext

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

FatalContext 打 fatal 级别日志并退出应用程序

func FatalContextf

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

FatalContextf 打 fatal 级别日志并退出应用程序

func Fatalf

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

Fatalf 打 fatal 级别日志并退出应用程序

func RegisterTraceLogFilter

func RegisterTraceLogFilter()

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

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 TraceID

func TraceID(ctx context.Context) string

TraceID 从 context 中读取 trace ID

func TraceIDStack

func TraceIDStack(ctx context.Context) []string

TraceIDStack 从 context 中读取历史 trace ID 栈

func WithTraceID

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

WithTraceID 更新 trace ID

func WithTraceIDStack

func WithTraceIDStack(ctx context.Context, traceIDStack []string) context.Context

WithTraceIDStack 完全替换整个 trace ID 栈