base

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

type Backtrace interface {
	// Count
	// 计算栈元素数量.
	Count() int

	// Empty
	// 返回是否为空.
	Empty() bool

	// Items
	// 返回栈元素列表.
	Items() []*BacktraceItem

	// String
	// 以字符串格式返回栈信息.
	//
	//   0 # main.main1() at /workspace/main.go:12
	//   1 # main.main() at /workspace/main.go:5
	String() string
}

type BacktraceItem struct {
	Line int64
	Path string
	Func string
}

type ClientSpan interface {
	CommonSpan
	LoggerSpan
	Child(name string) ClientSpan
	End()
}

type CommonSpan interface {
	Attr() *Attr
	Context() context.Context
	Name() string
	ParentSpanID() SpanID
	SpanID() SpanID
	TraceID() TraceID
}

type Level string

type Log interface {
	// Clone
	// 从Log上克隆一个新的Log.
	Clone() Log

	// GetBacktrace
	// 读取异常栈.
	GetBacktrace() Backtrace
	GetDuration() time.Duration
	GetLevel() Level
	GetMessage() string
	GetParentSpanID() SpanID
	GetSpanID() SpanID
	GetTime() time.Time
	GetTraceID() TraceID

	Release()

	// CopySpan
	// 复制Span参数.
	//
	// 将Span的链路参数复制到新Log实例中.
	CopySpan(span ReporterSpan) Log

	// CopyDuration
	// 复制Span时长.
	//
	// 将Span的执行时长复制到新Log实例中.
	CopyDuration(duration time.Duration) Log

	// CopyProfile
	// 复制Span信息.
	CopyProfile(p *SpanProfile) Log

	// CopyTime
	// 复制Span时间.
	//
	// 将Span的开始时间复制到新Log实例中.
	CopyTime(t time.Time) Log
}

type LogFormatter interface {
	// Format
	// 将日志转换成字符串(含JSON字符串).
	Format(log Log) string
}

type LogSender interface {
	// Send
	// 发送日志.
	Send(logs ...Log)

	// SetFormatter
	// 设置格式化.
	SetFormatter(formatter LogFormatter)

	// Wait
	// 等待发送完成.
	//
	// 一般在服务退出前显性调用. 发送日志(非TERM模式)是异步、批量提交的, 安全退出时需要
	// 等待内存中未发送或发送中的日志全部处理完成.
	Wait()
}

type LoggerSpan interface {
	Debug(format string, args ...interface{})
	Error(format string, args ...interface{})
	Fatal(format string, args ...interface{})
	Info(format string, args ...interface{})
	Warn(format string, args ...interface{})
}

type Memory[T any] struct {
	// contains filtered or unexported fields
}

type ReporterSpan interface {
	CommonSpan
	Duration() time.Duration
	EndTime() time.Time
	Logs() []Log
	Release()
	Sampled() SpanSampled
	StartTime() time.Time
}

type ReporterType string

type SenderType string

type SpanID []byte

type SpanProfile struct {
	SpanID, ParentSpanID SpanID
	TraceID              TraceID
}

type SpanReporter interface {
	// Publish
	// 批量上报.
	Publish(spans ...ReporterSpan)

	// Wait
	// 等待完成.
	//
	// 一般在服务退出前显性调用. 上报 Span 是异步、批量提交的, 安全退出时需要等待
	// 内存中待上报或上报中的 Span 全部处理完成.
	Wait()
}

type SpanSampled string

type TraceID []byte