Polish api.Tracer with new error tracing mechanism (#153)

sczyh30 · web-flow · commit 46b892aae907 · 2020-05-22T10:57:18.000+08:00
* Polish api.Tracer with new error tracing mechanism

Signed-off-by: Eric Zhao &lt;sczyh16@gmail.com&gt;
diff --git a/adapter/dubbo/consumer_filter.go b/adapter/dubbo/consumer_filter.go
@@ -44,12 +44,12 @@ func (d *consumerFilter) Invoke(ctx context.Context, invoker protocol.Invoker, i
 func (d *consumerFilter) OnResponse(ctx context.Context, result protocol.Result, _ protocol.Invoker, _ protocol.Invocation) protocol.Result {
 	if methodEntry := ctx.Value(MethodEntryKey); methodEntry != nil {
 		e := methodEntry.(*base.SentinelEntry)
-		sentinel.TraceErrorToEntry(e, result.Error())
+		sentinel.TraceError(e, result.Error())
 		e.Exit()
 	}
 	if interfaceEntry := ctx.Value(InterfaceEntryKey); interfaceEntry != nil {
 		e := interfaceEntry.(*base.SentinelEntry)
-		sentinel.TraceErrorToEntry(e, result.Error())
+		sentinel.TraceError(e, result.Error())
 		e.Exit()
 	}
 	return result
diff --git a/adapter/dubbo/provider_filter.go b/adapter/dubbo/provider_filter.go
@@ -42,12 +42,12 @@ func (d *providerFilter) Invoke(ctx context.Context, invoker protocol.Invoker, i
 func (d *providerFilter) OnResponse(ctx context.Context, result protocol.Result, _ protocol.Invoker, _ protocol.Invocation) protocol.Result {
 	if methodEntry := ctx.Value(MethodEntryKey); methodEntry != nil {
 		e := methodEntry.(*base.SentinelEntry)
-		sentinel.TraceErrorToEntry(e, result.Error())
+		sentinel.TraceError(e, result.Error())
 		e.Exit()
 	}
 	if interfaceEntry := ctx.Value(InterfaceEntryKey); interfaceEntry != nil {
 		e := interfaceEntry.(*base.SentinelEntry)
-		sentinel.TraceErrorToEntry(e, result.Error())
+		sentinel.TraceError(e, result.Error())
 		e.Exit()
 	}
 	return result
diff --git a/adapter/grpc/client.go b/adapter/grpc/client.go
@@ -40,7 +40,7 @@ func NewUnaryClientInterceptor(opts ...Option) grpc.UnaryClientInterceptor {
 
 		err := invoker(ctx, method, req, reply, cc, opts...)
 		if err != nil {
-			sentinel.TraceErrorToEntry(entry, err)
+			sentinel.TraceError(entry, err)
 		}
 		return err
 	}
@@ -78,7 +78,7 @@ func NewStreamClientInterceptor(opts ...Option) grpc.StreamClientInterceptor {
 
 		cs, err := streamer(ctx, desc, cc, method, opts...)
 		if err != nil {
-			sentinel.TraceErrorToEntry(entry, err)
+			sentinel.TraceError(entry, err)
 		}
 
 		return cs, err
diff --git a/adapter/grpc/server.go b/adapter/grpc/server.go
@@ -37,7 +37,7 @@ func NewUnaryServerInterceptor(opts ...Option) grpc.UnaryServerInterceptor {
 
 		res, err := handler(ctx, req)
 		if err != nil {
-			sentinel.TraceErrorToEntry(entry, err)
+			sentinel.TraceError(entry, err)
 		}
 		return res, err
 	}
@@ -72,7 +72,7 @@ func NewStreamServerInterceptor(opts ...Option) grpc.StreamServerInterceptor {
 
 		err := handler(srv, ss)
 		if err != nil {
-			sentinel.TraceErrorToEntry(entry, err)
+			sentinel.TraceError(entry, err)
 		}
 		return err
 	}
diff --git a/api/tracer.go b/api/tracer.go
@@ -2,94 +2,20 @@ 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 (
-	logger = logging.GetDefaultLogger()
-)
-
-type TraceErrorOptions struct {
-	count uint64
-}
-
-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
-	}
+// TraceError records the provided error to the given SentinelEntry.
+func TraceError(entry *base.SentinelEntry, err error) {
 	defer func() {
 		if e := recover(); e != nil {
-			logger.Panicf("Fail to traceError, resource: %s, panic error: %+v", resource, e)
+			logging.GetDefaultLogger().Panicf("Failed to TraceError, panic error: %+v", 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 || 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 traceErrorToCtx, parameter[ctx: %+v, err: %+v, opts: %+v], panic error: %+v", ctx, err, opts, e)
-			return
-		}
-	}()
-
-	if ctx == nil {
-		return
-	}
-	node := ctx.StatNode
-	if node == nil {
-		logger.Warnf("Cannot trace error: nil StatNode in EntryContext, resource: %s", ctx.Resource.String())
-		return
-	}
-
-	var options = TraceErrorOptions{
-		count: 1,
-	}
-	for _, opt := range opts {
-		opt(&options)
-	}
-
-	traceErrorToNode(node, err, options.count)
-}
-
-func traceErrorToNode(node base.StatNode, err error, cnt uint64) {
-	if node == nil {
-		return
-	}
-	if cnt <= 0 {
-		return
-	}
-	node.AddMetric(base.MetricEventError, cnt)
+	entry.SetError(err)
 }
diff --git a/api/tracer_test.go b/api/tracer_test.go
@@ -6,87 +6,46 @@ import (
 	"time"
 
 	"github.com/alibaba/sentinel-golang/core/base"
-	"github.com/alibaba/sentinel-golang/core/stat"
 	"github.com/stretchr/testify/assert"
 )
 
 var (
 	testRes = base.NewResourceWrapper("a", base.ResTypeCommon, base.Inbound)
 )
 
-func TestTraceErrorToCtx(t *testing.T) {
-	type args struct {
-		ctx   *base.EntryContext
-		err   error
-		count TraceErrorOption
-	}
-	tests := []struct {
-		name string
-		args args
-		want int64
-	}{
-		{
-			name: "TestTraceErrorToCtx",
-			args: args{
-				ctx:   nil,
-				err:   nil,
-				count: WithCount(10),
-			},
-			want: 10,
-		},
-	}
-	testStatNode := stat.NewResourceNode("a", base.ResTypeCommon)
-	tests[0].args.ctx = &base.EntryContext{
-		Resource: testRes,
-		StatNode: testStatNode,
-		Input:    nil,
-	}
-	tests[0].args.err = errors.New("biz error")
-
-	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)
-		})
-	}
-}
-
 func TestTraceErrorToEntry(t *testing.T) {
 	type args struct {
 		entry *base.SentinelEntry
 		err   error
-		count TraceErrorOption
 	}
+	te := errors.New("biz error")
 	tests := []struct {
 		name string
 		args args
-		want int64
+		want error
 	}{
 		{
 			name: "TestTraceErrorToEntry",
 			args: args{
 				entry: nil,
 				err:   nil,
-				count: WithCount(10),
 			},
-			want: 10,
+			want: te,
 		},
 	}
 
-	testStatNode := stat.NewResourceNode("a", base.ResTypeCommon)
 	ctx := &base.EntryContext{
 		Resource: testRes,
-		StatNode: testStatNode,
 		Input:    nil,
 	}
 	tests[0].args.entry = base.NewSentinelEntry(ctx, testRes, nil)
-	tests[0].args.err = errors.New("biz error")
+	tests[0].args.err = te
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			TraceErrorToEntry(tt.args.entry, tt.args.err, tt.args.count)
+			TraceError(tt.args.entry, tt.args.err)
 			time.Sleep(time.Millisecond * 10)
-			assert.True(t, ctx.StatNode.GetSum(base.MetricEventError) == tt.want)
+			assert.Equal(t, tests[0].args.entry.Context().Err(), tt.want)
 		})
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ func NewUnaryClientInterceptor(opts ...Option) grpc.UnaryClientInterceptor {`
`40`	`40`
`41`	`41`	`err := invoker(ctx, method, req, reply, cc, opts...)`
`42`	`42`	`if err != nil {`
`43`		`- sentinel.TraceErrorToEntry(entry, err)`
	`43`	`+ sentinel.TraceError(entry, err)`
`44`	`44`	`}`
`45`	`45`	`return err`
`46`	`46`	`}`
`@@ -78,7 +78,7 @@ func NewStreamClientInterceptor(opts ...Option) grpc.StreamClientInterceptor {`
`78`	`78`
`79`	`79`	`cs, err := streamer(ctx, desc, cc, method, opts...)`
`80`	`80`	`if err != nil {`
`81`		`- sentinel.TraceErrorToEntry(entry, err)`
	`81`	`+ sentinel.TraceError(entry, err)`
`82`	`82`	`}`
`83`	`83`
`84`	`84`	`return cs, err`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ func NewUnaryServerInterceptor(opts ...Option) grpc.UnaryServerInterceptor {`
`37`	`37`
`38`	`38`	`res, err := handler(ctx, req)`
`39`	`39`	`if err != nil {`
`40`		`- sentinel.TraceErrorToEntry(entry, err)`
	`40`	`+ sentinel.TraceError(entry, err)`
`41`	`41`	`}`
`42`	`42`	`return res, err`
`43`	`43`	`}`
`@@ -72,7 +72,7 @@ func NewStreamServerInterceptor(opts ...Option) grpc.StreamServerInterceptor {`
`72`	`72`
`73`	`73`	`err := handler(srv, ss)`
`74`	`74`	`if err != nil {`
`75`		`- sentinel.TraceErrorToEntry(entry, err)`
	`75`	`+ sentinel.TraceError(entry, err)`
`76`	`76`	`}`
`77`	`77`	`return err`
`78`	`78`	`}`