重置注释

common/level.go

@@ -59,14 +59,10 @@ func (o Level) Int() int {
 
 // String
 // 转字符串.
-func (o Level) String() string {
-	return string(o)
-}
+func (o Level) String() string { return string(o) }
 
 // Upper
 // 转大写.
 //
 // Level("debug").Upper() <-> Level("DEBUG")
-func (o Level) Upper() Level {
-	return Level(strings.ToUpper(string(o)))
-}
+func (o Level) Upper() Level { return Level(strings.ToUpper(string(o))) }

common/stack.go

@@ -40,10 +40,20 @@ type (
 	// StackItem
 	// 栈元素.
 	StackItem struct {
+		// 是否内部.
+		// true 表示元素是 fuyibing/log 包中的文件.
 		Internal bool
-		Call     string
-		File     string
-		Line     int
+
+		// 函数名称.
+		// 例如: main.main()
+		Call string
+
+		// 文件路径.
+		// 例如: /home/app/github.com/fuyibing/log/v5/field.go
+		File string
+
+		// 触发行号.
+		Line int
 	}
 )
 

loggers/executor.go

@@ -27,11 +27,11 @@ type (
 		// 类进程.
 		//
 		// 获取具体执行器的类进程, 基于此类进程启动/退出服务.
-		Processor() process.Processor
+		Processor() (processor process.Processor)
 
 		// Publish
 		// 发布日志.
-		Publish(logs ...Log) error
+		Publish(logs ...Log) (err error)
 
 		// SetFormatter
 		// 设置格式.

loggers/formatter.go

@@ -25,6 +25,6 @@ type (
 
 		// String
 		// 转字符串.
-		String(vs ...Log) (string, error)
+		String(vs ...Log) (str string, err error)
 	}
 )

loggers/log.go

@@ -64,9 +64,9 @@ type (
 	}
 )
 
-func NewLog(level common.Level, text string, args ...interface{}) Log {
+func NewLog(level common.Level, format string, args ...interface{}) Log {
 	return (&log{
-		level: level, text: fmt.Sprintf(text, args...),
+		level: level, text: fmt.Sprintf(format, args...),
 		time: time.Now(),
 	}).init()
 }

loggers/operator.go

@@ -33,15 +33,15 @@ type (
 	OperatorManager interface {
 		// GetExecutor
 		// 执行器.
-		GetExecutor() Executor
+		GetExecutor() (executor Executor)
 
 		// Push
 		// 推送日志.
 		Push(kv Kv, level common.Level, format string, args ...interface{})
 
 		// SetExecutor
 		// 设置执行器.
-		SetExecutor(v Executor)
+		SetExecutor(executor Executor)
 	}
 
 	operator struct {
@@ -71,7 +71,7 @@ func (o *operator) init() *operator {
 //
 //   1. 日志级别
 //   2. 绑定执行器
-func (o *operator) send(kv Kv, level common.Level, text string, args ...interface{}) {
+func (o *operator) send(kv Kv, level common.Level, format string, args ...interface{}) {
 	// 日志禁用.
 	// 1. 级别不匹配
 	// 2. 执行器未定义
@@ -80,7 +80,7 @@ func (o *operator) send(kv Kv, level common.Level, text string, args ...interfac
 	}
 
 	// 建立日志.
-	v := NewLog(level, text, args...)
+	v := NewLog(level, format, args...)
 
 	// 绑定KV.
 	if kv != nil {

manager.go

@@ -66,12 +66,11 @@ type (
 	}
 
 	manager struct {
-		config configurer.Configuration
-		logger loggers.OperatorManager
-		tracer tracers.OperatorManager
-
+		config    configurer.Configuration
+		logger    loggers.OperatorManager
 		name      string
 		processor process.Processor
+		tracer    tracers.OperatorManager
 	}
 )
 
@@ -174,22 +173,19 @@ func (o *manager) onPanic(_ context.Context, v interface{}) {
 func (o *manager) init() *manager {
 	o.config = configurer.Config
 	o.logger = loggers.Operator
-	o.tracer = tracers.Operator
-
 	o.name = "manager"
 	o.processor = process.New(o.name).
 		Before(o.onBeforeLogger, o.onBeforeTracer).
 		Callback(o.onCall).
 		Panic(o.onPanic)
-
+	o.tracer = tracers.Operator
 	return o
 }
 
 func (o *manager) start(ctx context.Context) {
 	// 并行启动.
 	go func() {
 		common.InternalInfo("<%s> start", o.name)
-
 		if err := o.processor.Start(ctx); err != nil {
 			common.InternalInfo("<%s> stopped: %v", o.name, err)
 		} else {
@@ -202,7 +198,6 @@ func (o *manager) start(ctx context.Context) {
 	ms := time.Millisecond
 	for i := 0; i < mx; i++ {
 		time.Sleep(ms)
-
 		if func() bool {
 			if o.logger.GetExecutor() != nil {
 				return o.logger.GetExecutor().Processor().Healthy()
@@ -229,7 +224,6 @@ func (o *manager) stop() {
 	ms := time.Millisecond * 100
 	for i := 0; i < mx; i++ {
 		time.Sleep(ms)
-
 		if func() bool {
 			if o.logger.GetExecutor() != nil {
 				return o.logger.GetExecutor().Processor().Stopped()

tracers/executor.go

@@ -27,11 +27,11 @@ type (
 		// 类进程.
 		//
 		// 获取具体执行器的类进程, 基于此类进程启动/退出服务.
-		Processor() process.Processor
+		Processor() (processor process.Processor)
 
 		// Publish
 		// 发布链路.
-		Publish(spans ...Span) error
+		Publish(spans ...Span) (err error)
 
 		// SetFormatter
 		// 设置格式.

tracers/formatter.go

@@ -25,6 +25,6 @@ type (
 
 		// String
 		// 转字符串.
-		String(vs ...Span) (string, error)
+		String(vs ...Span) (str string, err error)
 	}
 )

tracers/operator.go

@@ -41,23 +41,23 @@ type (
 	OperatorManager interface {
 		// Generator
 		// ID生成器.
-		Generator() *id
+		Generator() (generator *id)
 
 		// GetExecutor
 		// 执行器.
-		GetExecutor() Executor
+		GetExecutor() (executor Executor)
 
 		// GetResource
 		// 基础资源.
-		GetResource() loggers.Kv
+		GetResource() (kv loggers.Kv)
 
 		// Push
 		// 推送跨度.
 		Push(span Span)
 
 		// SetExecutor
 		// 设置执行器.
-		SetExecutor(v Executor)
+		SetExecutor(executor Executor)
 	}
 
 	operator struct {
@@ -68,11 +68,15 @@ type (
 	}
 )
 
-func (o *operator) Generator() *id          { return o.generator }
-func (o *operator) GetExecutor() Executor   { return o.executor }
-func (o *operator) GetResource() loggers.Kv { return o.resource }
-func (o *operator) Push(span Span)          { o.push(span) }
-func (o *operator) SetExecutor(v Executor)  { o.executor = v }
+// /////////////////////////////////////////////////////////////////////////////
+// Interface methods
+// /////////////////////////////////////////////////////////////////////////////
+
+func (o *operator) Generator() (generator *id)       { return o.generator }
+func (o *operator) GetExecutor() (executor Executor) { return o.executor }
+func (o *operator) GetResource() (kv loggers.Kv)     { return o.resource }
+func (o *operator) Push(span Span)                   { o.push(span) }
+func (o *operator) SetExecutor(executor Executor)    { o.executor = executor }
 
 // /////////////////////////////////////////////////////////////////////////////
 // Access and constructor

tracers/span_id.go

@@ -28,12 +28,8 @@ type (
 
 // IsValid
 // 校验跨度ID.
-func (o SpanId) IsValid() bool {
-	return !bytes.Equal(o[:], nilSpanId[:])
-}
+func (o SpanId) IsValid() bool { return !bytes.Equal(o[:], nilSpanId[:]) }
 
 // String
 // 转成16进制字符串.
-func (o SpanId) String() string {
-	return hex.EncodeToString(o[:])
-}
+func (o SpanId) String() string { return hex.EncodeToString(o[:]) }

tracers/span_logger.go

@@ -59,11 +59,11 @@ func (o *spanLogger) Add(key string, value interface{}) SpanLogger {
 	return o
 }
 
-func (o *spanLogger) Debug(text string, args ...interface{}) { o.send(common.Debug, text, args...) }
-func (o *spanLogger) Info(text string, args ...interface{})  { o.send(common.Info, text, args...) }
-func (o *spanLogger) Warn(text string, args ...interface{})  { o.send(common.Warn, text, args...) }
-func (o *spanLogger) Error(text string, args ...interface{}) { o.send(common.Error, text, args...) }
-func (o *spanLogger) Fatal(text string, args ...interface{}) { o.send(common.Fatal, text, args...) }
+func (o *spanLogger) Debug(format string, args ...interface{}) { o.send(common.Debug, format, args...) }
+func (o *spanLogger) Info(format string, args ...interface{})  { o.send(common.Info, format, args...) }
+func (o *spanLogger) Warn(format string, args ...interface{})  { o.send(common.Warn, format, args...) }
+func (o *spanLogger) Error(format string, args ...interface{}) { o.send(common.Error, format, args...) }
+func (o *spanLogger) Fatal(format string, args ...interface{}) { o.send(common.Fatal, format, args...) }
 
 // /////////////////////////////////////////////////////////////////////////////
 // Access and constructor
@@ -79,13 +79,13 @@ func (o *spanLogger) before(span *span) {
 	o.span = span
 }
 
-func (o *spanLogger) send(level common.Level, text string, args ...interface{}) {
+func (o *spanLogger) send(level common.Level, format string, args ...interface{}) {
 	// 直推日志.
-	loggers.Operator.Push(o.kv, level, text, args...)
+	loggers.Operator.Push(o.kv, level, format, args...)
 
 	// 跨度日志.
 	if configurer.Config.LevelEnabled(level) {
-		log := loggers.NewLog(level, text, args...)
+		log := loggers.NewLog(level, format, args...)
 
 		// 日志属性.
 		if len(o.kv) > 0 {

tracers/trace_id.go

@@ -28,12 +28,8 @@ type (
 
 // IsValid
 // 校验链路ID.
-func (o TraceId) IsValid() bool {
-	return !bytes.Equal(o[:], nilTraceId[:])
-}
+func (o TraceId) IsValid() bool { return !bytes.Equal(o[:], nilTraceId[:]) }
 
 // String
 // 转成16进制字符串.
-func (o TraceId) String() string {
-	return hex.EncodeToString(o[:])
-}
+func (o TraceId) String() string { return hex.EncodeToString(o[:]) }