contrib/google.golang.org/grpc: add WithErrorCheck option

contrib/google.golang.org/grpc/client.go

@@ -45,7 +45,7 @@ func (cs *clientStream) RecvMsg(m interface{}) (err error) {
  if p, ok := peer.FromContext(cs.Context()); ok {
  setSpanTargetFromPeer(span, *p)
  }
- defer func() { finishWithError(span, err, cs.cfg) }()
+ defer func() { finishWithError(span, err, cs.method, cs.cfg) }()
  }
  err = cs.ClientStream.RecvMsg(m)
  return err
@@ -64,7 +64,7 @@ func (cs *clientStream) SendMsg(m interface{}) (err error) {
  if p, ok := peer.FromContext(cs.Context()); ok {
  setSpanTargetFromPeer(span, *p)
  }
- defer func() { finishWithError(span, err, cs.cfg) }()
+ defer func() { finishWithError(span, err, cs.method, cs.cfg) }()
  }
  err = cs.ClientStream.SendMsg(m)
  return err
@@ -104,7 +104,7 @@ func StreamClientInterceptor(opts ...Option) grpc.StreamClientInterceptor {
  return err
  })
  if err != nil {
- finishWithError(span, err, cfg)
+ finishWithError(span, err, method, cfg)
  return nil, err
  }
 
@@ -116,7 +116,7 @@ func StreamClientInterceptor(opts ...Option) grpc.StreamClientInterceptor {
 
  go func() {
  <-stream.Context().Done()
- finishWithError(span, stream.Context().Err(), cfg)
+ finishWithError(span, stream.Context().Err(), method, cfg)
  }()
  } else {
  // if call tracing is disabled, just call streamer, but still return
@@ -158,7 +158,7 @@ func UnaryClientInterceptor(opts ...Option) grpc.UnaryClientInterceptor {
  func(ctx context.Context, opts []grpc.CallOption) error {
  return invoker(ctx, method, req, reply, cc, opts...)
  })
- finishWithError(span, err, cfg)
+ finishWithError(span, err, method, cfg)
  return err
  }
 }

contrib/google.golang.org/grpc/grpc.go

@@ -34,6 +34,8 @@ func init() {
 // cache a constant option: saves one allocation per call
 var spanTypeRPC = tracer.SpanType(ext.AppTypeRPC)
 
+type fullMethodNameKey struct{}
+
 func (cfg *config) startSpanOptions(opts ...tracer.StartSpanOption) []tracer.StartSpanOption {
  if len(cfg.tags) == 0 && len(cfg.spanOpts) == 0 {
  return opts
@@ -69,16 +71,17 @@ func startSpanFromContext(
  if sctx, err := tracer.Extract(grpcutil.MDCarrier(md)); err == nil {
  opts = append(opts, tracer.ChildOf(sctx))
  }
+ ctx = context.WithValue(ctx, fullMethodNameKey{}, method)
  return tracer.StartSpanFromContext(ctx, operation, opts...)
 }
 
 // finishWithError applies finish option and a tag with gRPC status code, disregarding OK, EOF and Canceled errors.
-func finishWithError(span ddtrace.Span, err error, cfg *config) {
+func finishWithError(span ddtrace.Span, err error, method string, cfg *config) {
  if errors.Is(err, io.EOF) || errors.Is(err, context.Canceled) {
  err = nil
  }
  errcode := status.Code(err)
- if errcode == codes.OK || cfg.nonErrorCodes[errcode] {
+ if errcode == codes.OK || cfg.nonErrorCodes[errcode] || (cfg.nonErrorFunc != nil && cfg.nonErrorFunc(method, err)) {
  err = nil
  }
  span.SetTag(tagCode, errcode.String())

contrib/google.golang.org/grpc/option.go

@@ -29,6 +29,7 @@ type config struct {
  serviceName func() string
  spanName string
  nonErrorCodes map[codes.Code]bool
+ nonErrorFunc func(method string, err error) bool
  traceStreamCalls bool
  traceStreamMessages bool
  noDebugStack bool
@@ -129,6 +130,15 @@ func NonErrorCodes(cs ...codes.Code) InterceptorOption {
  }
 }
 
+// NonErrorFunc sets a custom function to determine whether an error should not be considered as an error for tracing purposes.
+// This function is evaluated when an error occurs, and if it returns true, the error will not be recorded in the trace.
+// f: A function taking the gRPC method and error as arguments, returning a boolean to indicate if the error should be ignored.
+func NonErrorFunc(f func(method string, err error) bool) InterceptorOption {
+ return func(cfg *config) {
+ cfg.nonErrorFunc = f
+ }
+}
+
 // WithAnalytics enables Trace Analytics for all started spans.
 func WithAnalytics(on bool) Option {
  return func(cfg *config) {

contrib/google.golang.org/grpc/server.go

@@ -53,7 +53,7 @@ func (ss *serverStream) RecvMsg(m interface{}) (err error) {
  defer func() {
  withMetadataTags(ss.ctx, ss.cfg, span)
  withRequestTags(ss.cfg, m, span)
- finishWithError(span, err, ss.cfg)
+ finishWithError(span, err, ss.method, ss.cfg)
  }()
  }
  err = ss.ServerStream.RecvMsg(m)
@@ -72,7 +72,7 @@ func (ss *serverStream) SendMsg(m interface{}) (err error) {
  ss.cfg.startSpanOptions(tracer.Measured())...,
  )
  span.SetTag(ext.Component, componentName)
- defer func() { finishWithError(span, err, ss.cfg) }()
+ defer func() { finishWithError(span, err, ss.method, ss.cfg) }()
  }
  err = ss.ServerStream.SendMsg(m)
  return err
@@ -110,7 +110,7 @@ func StreamServerInterceptor(opts ...Option) grpc.StreamServerInterceptor {
  case info.IsClientStream:
  span.SetTag(tagMethodKind, methodKindClientStream)
  }
- defer func() { finishWithError(span, err, cfg) }()
+ defer func() { finishWithError(span, err, info.FullMethod, cfg) }()
  if appsec.Enabled() {
  handler = appsecStreamHandlerMiddleware(span, handler)
  }
@@ -157,7 +157,7 @@ func UnaryServerInterceptor(opts ...Option) grpc.UnaryServerInterceptor {
  handler = appsecUnaryHandlerMiddleware(span, handler)
  }
  resp, err := handler(ctx, req)
- finishWithError(span, err, cfg)
+ finishWithError(span, err, info.FullMethod, cfg)
  return resp, err
  }
 }

contrib/google.golang.org/grpc/stats_client.go

@@ -59,7 +59,15 @@ func (h *clientStatsHandler) HandleRPC(ctx context.Context, rs stats.RPCStats) {
  span.SetTag(ext.TargetPort, port)
  }
  case *stats.End:
- finishWithError(span, rs.Error, h.cfg)
+ val := ctx.Value(fullMethodNameKey{})
+ if val == nil {
+ return
+ }
+ fullMethod, ok := val.(string)
+ if !ok {
+ return
+ }
+ finishWithError(span, rs.Error, fullMethod, h.cfg)
  }
 }
 

contrib/google.golang.org/grpc/stats_server.go

@@ -43,6 +43,7 @@ func (h *serverStatsHandler) TagRPC(ctx context.Context, rti *stats.RPCTagInfo)
  h.cfg.serviceName,
  spanOpts...,
  )
+ ctx = context.WithValue(ctx, fullMethodNameKey{}, rti.FullMethodName)
  return ctx
 }
 
@@ -52,8 +53,16 @@ func (h *serverStatsHandler) HandleRPC(ctx context.Context, rs stats.RPCStats) {
  if !ok {
  return
  }
+ val := ctx.Value(fullMethodNameKey{})
+ if val == nil {
+ return
+ }
+ fullMethod, ok := val.(string)
+ if !ok {
+ return
+ }
  if v, ok := rs.(*stats.End); ok {
- finishWithError(span, v.Error, h.cfg)
+ finishWithError(span, v.Error, fullMethod, h.cfg)
  }
 }