Polish error Tracer (#96)

sczyh30 · web-flow · commit 212eca2fbbb8 · 2020-03-18T22:17:14.000+08:00
diff --git a/api/tracer.go b/api/tracer.go
@@ -2,7 +2,9 @@ package api
 
 import (
 	"github.com/alibaba/sentinel-golang/core/base"
+	"github.com/alibaba/sentinel-golang/core/stat"
 	"github.com/alibaba/sentinel-golang/logging"
+	"github.com/alibaba/sentinel-golang/util"
 )
 
 var (
@@ -15,24 +17,50 @@ type TraceErrorOptions struct {
 
 type TraceErrorOption func(*TraceErrorOptions)
 
+// WithCount sets the error count.
 func WithCount(count uint64) TraceErrorOption {
 	return func(opts *TraceErrorOptions) {
 		opts.count = count
 	}
 }
 
+// TraceError records the provided error to the statistic structure of the target resource.
+func TraceError(resource string, err error, opts ...TraceErrorOption) {
+	if util.IsBlank(resource) || err == nil {
+		return
+	}
+	defer func() {
+		if e := recover(); e != nil {
+			logger.Panicf("Fail to traceError, resource: %s, panic error: %+v", resource, e)
+			return
+		}
+	}()
+
+	if node := stat.GetResourceNode(resource); node != nil {
+		var options = TraceErrorOptions{
+			count: 1,
+		}
+		for _, opt := range opts {
+			opt(&options)
+		}
+		traceErrorToNode(node, err, options.count)
+	}
+}
+
+// TraceErrorToEntry records the provided error to the given SentinelEntry.
 func TraceErrorToEntry(entry *base.SentinelEntry, err error, opts ...TraceErrorOption) {
-	if entry == nil {
+	if entry == nil || err == nil {
 		return
 	}
 
 	TraceErrorToCtx(entry.Context(), err, opts...)
 }
 
+// TraceErrorToCtx records the provided error to the given context.
 func TraceErrorToCtx(ctx *base.EntryContext, err error, opts ...TraceErrorOption) {
 	defer func() {
 		if e := recover(); e != nil {
-			logger.Panicf("Fail to execute TraceErrorToCtx, parameter[ctx:%+v, err:%+v, opts:%+v], sentinel internal error: %+v", ctx, err, opts, e)
+			logger.Panicf("Fail to traceErrorToCtx, parameter[ctx: %+v, err: %+v, opts: %+v], panic error: %+v", ctx, err, opts, e)
 			return
 		}
 	}()
@@ -42,7 +70,7 @@ func TraceErrorToCtx(ctx *base.EntryContext, err error, opts ...TraceErrorOption
 	}
 	node := ctx.StatNode
 	if node == nil {
-		logger.Warnf("The StatNode in EntryContext is nil，ctx:%+v, err:%+v,opt:%+v", ctx, err, opts)
+		logger.Warnf("Cannot trace error: nil StatNode in EntryContext, resource: %s", ctx.Resource.String())
 		return
 	}
 
@@ -53,15 +81,15 @@ func TraceErrorToCtx(ctx *base.EntryContext, err error, opts ...TraceErrorOption
 		opt(&options)
 	}
 
-	traceError(node, err, options.count)
+	traceErrorToNode(node, err, options.count)
 }
 
-func traceError(node base.StatNode, err error, cnt uint64) {
+func traceErrorToNode(node base.StatNode, err error, cnt uint64) {
 	if node == nil {
 		return
 	}
 	if cnt <= 0 {
 		return
 	}
-	node.AddMetric(base.MetricEventError, uint64(cnt))
+	node.AddMetric(base.MetricEventError, cnt)
 }
diff --git a/api/tracer_test.go b/api/tracer_test.go
@@ -2,12 +2,12 @@ package api
 
 import (
 	"errors"
-	"github.com/alibaba/sentinel-golang/core/stat"
-	"github.com/stretchr/testify/assert"
 	"testing"
 	"time"
 
 	"github.com/alibaba/sentinel-golang/core/base"
+	"github.com/alibaba/sentinel-golang/core/stat"
+	"github.com/stretchr/testify/assert"
 )
 
 var (
@@ -28,8 +28,8 @@ func TestTraceErrorToCtx(t *testing.T) {
 		{
 			name: "TestTraceErrorToCtx",
 			args: args{
-				ctx: nil,
-				err: nil,
+				ctx:   nil,
+				err:   nil,
 				count: WithCount(10),
 			},
 			want: 10,
@@ -47,7 +47,7 @@ func TestTraceErrorToCtx(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			TraceErrorToCtx(tt.args.ctx, tt.args.err, tt.args.count)
-			assert.True(t, tt.args.ctx.StatNode.GetSum(base.MetricEventError)==tt.want)
+			assert.True(t, tt.args.ctx.StatNode.GetSum(base.MetricEventError) == tt.want)
 		})
 	}
 }
@@ -87,8 +87,8 @@ func TestTraceErrorToEntry(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			TraceErrorToEntry(tt.args.entry, tt.args.err, tt.args.count)
-			time.Sleep(time.Millisecond*10)
-			assert.True(t, ctx.StatNode.GetSum(base.MetricEventError)==tt.want)
+			time.Sleep(time.Millisecond * 10)
+			assert.True(t, ctx.StatNode.GetSum(base.MetricEventError) == tt.want)
 		})
 	}
 }
