peertls/tlsopts: disable distributed tracing for verifyIdentity

verifyIdentity uses default, un-parented context, therefore it doesn't make sense to include in distributed traces, it just increases the noise.

To avoid circurlar dependency, this requires to move the excluded.go to a separated package (tracing), but for backward-compatility, a deprecated version is also kept.

Majority of this commit is just package rename. The real change is in `peertls/tlsopts/tls.go` (2 lines).

storj/storj#5722

Change-Id: I6b48f788998adb414f0bd86f6a434fbb6eb1214d

Author: elek

peertls/tlsopts/tls.go

@@ -4,12 +4,14 @@
 package tlsopts
 
 import (
+	"context"
 	"crypto/tls"
 	"crypto/x509"
 
 	"storj.io/common/identity"
 	"storj.io/common/peertls"
 	"storj.io/common/storj"
+	"storj.io/common/tracing"
 )
 
 // StorjApplicationProtocol defines storj's application protocol.
@@ -76,7 +78,8 @@ func (opts *Options) tlsConfig(isServer bool, verificationFuncs ...peertls.PeerC
 
 func verifyIdentity(id storj.NodeID) peertls.PeerCertVerificationFunc {
 	return func(_ [][]byte, parsedChains [][]*x509.Certificate) (err error) {
-		defer mon.TaskNamed("verifyIdentity")(nil)(&err)
+		ctx := tracing.WithoutDistributedTracing(context.Background())
+		defer mon.TaskNamed("verifyIdentity")(&ctx)(&err)
 		peer, err := identity.PeerIdentityFromChain(parsedChains[0])
 		if err != nil {
 			return err

rpc/rpctracing/excluded.go

@@ -7,21 +7,18 @@ import (
 	"context"
 
 	"github.com/spacemonkeygo/monkit/v3"
-)
-
-type contextKey int
 
-var (
-	excludeFromTracing contextKey = 1
+	"storj.io/common/tracing"
 )
 
 // WithoutDistributedTracing disables distributed tracing for the current span.
+// Deprecated: use tracing.WithoutDistributedTracing.
 func WithoutDistributedTracing(ctx context.Context) context.Context {
-	return context.WithValue(ctx, excludeFromTracing, true)
+	return tracing.WithoutDistributedTracing(ctx)
 }
 
 // IsExcluded check if span shouldn't be reported to remote location.
+// Deprecated: use tracing.IsExcluded.
 func IsExcluded(span *monkit.Span) bool {
-	val, ok := span.Value(excludeFromTracing).(bool)
-	return ok && val
+	return tracing.IsExcluded(span)
 }

signing/encode.go

@@ -7,7 +7,7 @@ import (
 	"context"
 
 	"storj.io/common/pb"
-	"storj.io/common/rpc/rpctracing"
+	"storj.io/common/tracing"
 )
 
 // EncodeOrderLimit encodes order limit into bytes for signing. Removes signature from serialized limit.
@@ -52,7 +52,7 @@ func EncodeOrderLimit(ctx context.Context, limit *pb.OrderLimit) (_ []byte, err
 
 // EncodeOrder encodes order into bytes for signing. Removes signature from serialized order.
 func EncodeOrder(ctx context.Context, order *pb.Order) (_ []byte, err error) {
-	ctx = rpctracing.WithoutDistributedTracing(ctx)
+	ctx = tracing.WithoutDistributedTracing(ctx)
 	defer mon.Task()(&ctx)(&err)
 
 	// protobuf has problems with serializing types with nullable=false

signing/sign.go

@@ -9,8 +9,8 @@ import (
 	"github.com/zeebo/errs"
 
 	"storj.io/common/pb"
-	"storj.io/common/rpc/rpctracing"
 	"storj.io/common/storj"
+	"storj.io/common/tracing"
 )
 
 // Error is the default error class for signing package.
@@ -46,7 +46,7 @@ func SignOrderLimit(ctx context.Context, satellite Signer, unsigned *pb.OrderLim
 // SignUplinkOrder signs the order using the specified signer.
 // Signer is an uplink.
 func SignUplinkOrder(ctx context.Context, privateKey storj.PiecePrivateKey, unsigned *pb.Order) (_ *pb.Order, err error) {
-	ctx = rpctracing.WithoutDistributedTracing(ctx)
+	ctx = tracing.WithoutDistributedTracing(ctx)
 	defer mon.Task()(&ctx)(&err)
 
 	bytes, err := EncodeOrder(ctx, unsigned)

signing/verify.go

@@ -7,8 +7,8 @@ import (
 	"context"
 
 	"storj.io/common/pb"
-	"storj.io/common/rpc/rpctracing"
 	"storj.io/common/storj"
+	"storj.io/common/tracing"
 )
 
 var verifyOrderLimitSignatureMon = mon.Task()
@@ -21,7 +21,7 @@ type Signee interface {
 
 // VerifyOrderLimitSignature verifies that the signature inside order limit is valid and  belongs to the satellite.
 func VerifyOrderLimitSignature(ctx context.Context, satellite Signee, signed *pb.OrderLimit) (err error) {
-	ctx = rpctracing.WithoutDistributedTracing(ctx)
+	ctx = tracing.WithoutDistributedTracing(ctx)
 	defer verifyOrderLimitSignatureMon(&ctx)(&err)
 
 	bytes, err := EncodeOrderLimit(ctx, signed)
@@ -50,7 +50,7 @@ func VerifyOrderSignature(ctx context.Context, uplink Signee, signed *pb.Order)
 
 // VerifyUplinkOrderSignature verifies that the signature inside order is valid and belongs to the uplink.
 func VerifyUplinkOrderSignature(ctx context.Context, publicKey storj.PiecePublicKey, signed *pb.Order) (err error) {
-	ctx = rpctracing.WithoutDistributedTracing(ctx)
+	ctx = tracing.WithoutDistributedTracing(ctx)
 	defer mon.Task()(&ctx)(&err)
 
 	if len(signed.XXX_unrecognized) > 0 {
@@ -67,7 +67,7 @@ func VerifyUplinkOrderSignature(ctx context.Context, publicKey storj.PiecePublic
 
 // VerifyPieceHashSignature verifies that the signature inside piece hash is valid and belongs to the signer, which is either uplink or storage node.
 func VerifyPieceHashSignature(ctx context.Context, signee Signee, signed *pb.PieceHash) (err error) {
-	ctx = rpctracing.WithoutDistributedTracing(ctx)
+	ctx = tracing.WithoutDistributedTracing(ctx)
 	defer mon.Task()(&ctx)(&err)
 
 	if len(signed.XXX_unrecognized) > 0 {
@@ -84,7 +84,7 @@ func VerifyPieceHashSignature(ctx context.Context, signee Signee, signed *pb.Pie
 
 // VerifyUplinkPieceHashSignature verifies that the signature inside piece hash is valid and belongs to the signer, which is either uplink or storage node.
 func VerifyUplinkPieceHashSignature(ctx context.Context, publicKey storj.PiecePublicKey, signed *pb.PieceHash) (err error) {
-	ctx = rpctracing.WithoutDistributedTracing(ctx)
+	ctx = tracing.WithoutDistributedTracing(ctx)
 	defer mon.Task()(&ctx)(&err)
 
 	if len(signed.XXX_unrecognized) > 0 {

tracing/excluded.go

@@ -0,0 +1,27 @@
+// Copyright (C) 2022 Storj Labs, Inc.
+// See LICENSE for copying information.
+
+package tracing
+
+import (
+	"context"
+
+	"github.com/spacemonkeygo/monkit/v3"
+)
+
+type contextKey int
+
+var (
+	excludeFromTracing contextKey = 1
+)
+
+// WithoutDistributedTracing disables distributed tracing for the current span.
+func WithoutDistributedTracing(ctx context.Context) context.Context {
+	return context.WithValue(ctx, excludeFromTracing, true)
+}
+
+// IsExcluded check if span shouldn't be reported to remote location.
+func IsExcluded(span *monkit.Span) bool {
+	val, ok := span.Value(excludeFromTracing).(bool)
+	return ok && val
+}