[1.18] 6748-spawn-upstream-span-backport (#10566)

Author: EItanya

changelog/v1.18.4/6748-spawn-upstream-span-backport.yaml

@@ -0,0 +1,10 @@
+
+changelog:
+- type: FIX
+  issueLink: https://github.com/solo-io/solo-projects/issues/6748
+  resolvesIssue: true
+  description: > 
+    Expose spawn_upstream_span on the tracing API. This setting tells
+    envoy to spawn a new span for each upstream request.
+
+

docs/content/reference/api/github.com/solo-io/gloo/projects/gloo/api/v1/options/tracing/tracing.proto.sk.md

@@ -1143,6 +1143,8 @@ spec:
                                   nullable: true
                                   type: string
                                 type: array
+                              spawnUpstreamSpan:
+                                type: boolean
                               tracePercentages:
                                 properties:
                                   clientSamplePercentage:
@@ -1821,6 +1823,8 @@ spec:
                                   nullable: true
                                   type: string
                                 type: array
+                              spawnUpstreamSpan:
+                                type: boolean
                               tracePercentages:
                                 properties:
                                   clientSamplePercentage:
@@ -3165,6 +3169,8 @@ spec:
                                             nullable: true
                                             type: string
                                           type: array
+                                        spawnUpstreamSpan:
+                                          type: boolean
                                         tracePercentages:
                                           properties:
                                             clientSamplePercentage:

install/helm/gloo/crds/gateway.solo.io_v1_Gateway.yaml

@@ -1134,6 +1134,8 @@ spec:
                               nullable: true
                               type: string
                             type: array
+                          spawnUpstreamSpan:
+                            type: boolean
                           tracePercentages:
                             properties:
                               clientSamplePercentage:

install/helm/gloo/crds/gateway.solo.io_v1_HttpListenerOption.yaml

@@ -1137,6 +1137,8 @@ spec:
                                   nullable: true
                                   type: string
                                 type: array
+                              spawnUpstreamSpan:
+                                type: boolean
                               tracePercentages:
                                 properties:
                                   clientSamplePercentage:

install/helm/gloo/crds/gateway.solo.io_v1_MatchableHttpGateway.yaml

@@ -43,6 +43,11 @@ message ListenerTracingSettings {
     repeated TracingTagEnvironmentVariable environment_variables_for_tags = 6;
     // Optional. If specified, Envoy will include the literals with the given tag as tracing tags.
     repeated TracingTagLiteral literals_for_tags = 7;
+    
+    // Optional
+    // Create separate tracing span for each upstream request if true. And if this flag is set to true, the tracing provider will assume that Envoy 
+    // will be independent hop in the trace chain and may set span type to client or server based on this flag. 
+    bool spawn_upstream_span = 10;
 }
 
 // Contains settings for configuring Envoy's tracing capabilities at the route level.

projects/gloo/api/v1/options/tracing/tracing.proto

@@ -19,6 +19,7 @@ import (
 	"github.com/solo-io/gloo/projects/gloo/pkg/plugins/pluginutils"
 	translatorutil "github.com/solo-io/gloo/projects/gloo/pkg/translator"
 	"github.com/solo-io/solo-kit/pkg/api/v1/resources/core"
+	"google.golang.org/protobuf/types/known/wrapperspb"
 )
 
 var (
@@ -86,6 +87,7 @@ func (p *plugin) ProcessHcmNetworkFilter(params plugins.Params, parent *v1.Liste
 		trCfg.RandomSampling = envoySimplePercent(oneHundredPercent)
 		trCfg.OverallSampling = envoySimplePercent(oneHundredPercent)
 	}
+	trCfg.SpawnUpstreamSpan = wrapperspb.Bool(tracingSettings.GetSpawnUpstreamSpan())
 	out.Tracing = trCfg
 	return nil
 }

projects/gloo/pkg/api/v1/options/tracing/tracing.pb.clone.go

@@ -151,11 +151,12 @@ var _ = Describe("Plugin", func() {
 						},
 					},
 				},
-				ClientSampling:  &envoy_type.Percent{Value: 10},
-				RandomSampling:  &envoy_type.Percent{Value: 20},
-				OverallSampling: &envoy_type.Percent{Value: 30},
-				Verbose:         true,
-				Provider:        nil,
+				ClientSampling:    &envoy_type.Percent{Value: 10},
+				RandomSampling:    &envoy_type.Percent{Value: 20},
+				OverallSampling:   &envoy_type.Percent{Value: 30},
+				Verbose:           true,
+				Provider:          nil,
+				SpawnUpstreamSpan: &wrappers.BoolValue{Value: false},
 			},
 		}
 		Expect(cfg).To(Equal(expected))
@@ -171,11 +172,35 @@ var _ = Describe("Plugin", func() {
 		Expect(err).NotTo(HaveOccurred())
 		expected := &envoyhttp.HttpConnectionManager{
 			Tracing: &envoyhttp.HttpConnectionManager_Tracing{
-				ClientSampling:  &envoy_type.Percent{Value: 100},
-				RandomSampling:  &envoy_type.Percent{Value: 100},
-				OverallSampling: &envoy_type.Percent{Value: 100},
-				Verbose:         false,
-				Provider:        nil,
+				ClientSampling:    &envoy_type.Percent{Value: 100},
+				RandomSampling:    &envoy_type.Percent{Value: 100},
+				OverallSampling:   &envoy_type.Percent{Value: 100},
+				Verbose:           false,
+				Provider:          nil,
+				SpawnUpstreamSpan: &wrappers.BoolValue{Value: false},
+			},
+		}
+		Expect(cfg).To(Equal(expected))
+	})
+
+	It("should properly set spawn_upstream_span", func() {
+		cfg := &envoyhttp.HttpConnectionManager{}
+		hcmSettings = &hcm.HttpConnectionManagerSettings{
+			Tracing: &tracing.ListenerTracingSettings{
+				SpawnUpstreamSpan: true,
+			},
+		}
+
+		err := processHcmNetworkFilter(cfg)
+		Expect(err).NotTo(HaveOccurred())
+		expected := &envoyhttp.HttpConnectionManager{
+			Tracing: &envoyhttp.HttpConnectionManager_Tracing{
+				ClientSampling:    &envoy_type.Percent{Value: 100},
+				RandomSampling:    &envoy_type.Percent{Value: 100},
+				OverallSampling:   &envoy_type.Percent{Value: 100},
+				Verbose:           false,
+				Provider:          nil,
+				SpawnUpstreamSpan: &wrappers.BoolValue{Value: true},
 			},
 		}
 		Expect(cfg).To(Equal(expected))