Add a flag in tracing config to use service instead of pod name

tracing/config/tracing.go

@@ -31,11 +31,12 @@ const (
 	// ConfigName is the name of the configmap
 	ConfigName = "config-tracing"
 
-	enableKey         = "enable"
-	backendKey        = "backend"
-	zipkinEndpointKey = "zipkin-endpoint"
-	debugKey          = "debug"
-	sampleRateKey     = "sample-rate"
+	enableKey            = "enable"
+	backendKey           = "backend"
+	zipkinEndpointKey    = "zipkin-endpoint"
+	debugKey             = "debug"
+	sampleRateKey        = "sample-rate"
+	useServingServiceKey = "use-serving-service"
 )
 
 // BackendType specifies the backend to use for tracing
@@ -54,8 +55,9 @@ type Config struct {
 	Backend        BackendType
 	ZipkinEndpoint string
 
-	Debug      bool
-	SampleRate float64
+	Debug             bool
+	SampleRate        float64
+	UseServingService bool
 }
 
 // Equals returns true if two Configs are identical
@@ -66,9 +68,10 @@ func (cfg *Config) Equals(other *Config) bool {
 // NoopConfig returns a new noop config
 func NoopConfig() *Config {
 	return &Config{
-		Backend:    None,
-		Debug:      false,
-		SampleRate: 0.1,
+		Backend:           None,
+		Debug:             false,
+		SampleRate:        0.1,
+		UseServingService: false,
 	}
 }
 
@@ -98,6 +101,7 @@ func NewTracingConfigFromMap(cfgMap map[string]string) (*Config, error) {
 		cm.AsString(zipkinEndpointKey, &tc.ZipkinEndpoint),
 		cm.AsBool(debugKey, &tc.Debug),
 		cm.AsFloat64(sampleRateKey, &tc.SampleRate),
+		cm.AsBool(useServingServiceKey, &tc.UseServingService),
 	); err != nil {
 		return nil, err
 	}
@@ -152,6 +156,7 @@ func TracingConfigToJSON(cfg *Config) (string, error) {
 	}
 	out[debugKey] = strconv.FormatBool(cfg.Debug)
 	out[sampleRateKey] = fmt.Sprint(cfg.SampleRate)
+	out[useServingServiceKey] = strconv.FormatBool(cfg.UseServingService)
 
 	jsonCfg, err := json.Marshal(out)
 	return string(jsonCfg), err

tracing/config/tracing_test.go

@@ -62,30 +62,34 @@ func TestNewConfigSuccess(t *testing.T) {
 	}, {
 		name: "Everything enabled (legacy)",
 		input: map[string]string{
-			enableKey:         "true",
-			zipkinEndpointKey: "some-endpoint",
-			debugKey:          "true",
-			sampleRateKey:     "0.5",
+			enableKey:            "true",
+			zipkinEndpointKey:    "some-endpoint",
+			debugKey:             "true",
+			sampleRateKey:        "0.5",
+			useServingServiceKey: "true",
 		},
 		output: &Config{
-			Backend:        Zipkin,
-			Debug:          true,
-			ZipkinEndpoint: "some-endpoint",
-			SampleRate:     0.5,
+			Backend:           Zipkin,
+			Debug:             true,
+			ZipkinEndpoint:    "some-endpoint",
+			SampleRate:        0.5,
+			UseServingService: true,
 		},
 	}, {
 		name: "Everything enabled (zipkin)",
 		input: map[string]string{
-			backendKey:        "zipkin",
-			zipkinEndpointKey: "some-endpoint",
-			debugKey:          "true",
-			sampleRateKey:     "0.5",
+			backendKey:           "zipkin",
+			zipkinEndpointKey:    "some-endpoint",
+			debugKey:             "true",
+			sampleRateKey:        "0.5",
+			useServingServiceKey: "true",
 		},
 		output: &Config{
-			Backend:        Zipkin,
-			Debug:          true,
-			ZipkinEndpoint: "some-endpoint",
-			SampleRate:     0.5,
+			Backend:           Zipkin,
+			Debug:             true,
+			ZipkinEndpoint:    "some-endpoint",
+			SampleRate:        0.5,
+			UseServingService: true,
 		},
 	}}
 
@@ -116,30 +120,34 @@ func TestNewConfigJSON(t *testing.T) {
 	}, {
 		name: "Everything enabled (legacy)",
 		input: map[string]string{
-			enableKey:         "true",
-			zipkinEndpointKey: "some-endpoint",
-			debugKey:          "true",
-			sampleRateKey:     "0.5",
+			enableKey:            "true",
+			zipkinEndpointKey:    "some-endpoint",
+			debugKey:             "true",
+			sampleRateKey:        "0.5",
+			useServingServiceKey: "true",
 		},
 		output: &Config{
-			Backend:        Zipkin,
-			Debug:          true,
-			ZipkinEndpoint: "some-endpoint",
-			SampleRate:     0.5,
+			Backend:           Zipkin,
+			Debug:             true,
+			ZipkinEndpoint:    "some-endpoint",
+			SampleRate:        0.5,
+			UseServingService: true,
 		},
 	}, {
 		name: "Everything enabled (zipkin)",
 		input: map[string]string{
-			backendKey:        "zipkin",
-			zipkinEndpointKey: "some-endpoint",
-			debugKey:          "true",
-			sampleRateKey:     "0.5",
+			backendKey:           "zipkin",
+			zipkinEndpointKey:    "some-endpoint",
+			debugKey:             "true",
+			sampleRateKey:        "0.5",
+			useServingServiceKey: "true",
 		},
 		output: &Config{
-			Backend:        Zipkin,
-			Debug:          true,
-			ZipkinEndpoint: "some-endpoint",
-			SampleRate:     0.5,
+			Backend:           Zipkin,
+			Debug:             true,
+			ZipkinEndpoint:    "some-endpoint",
+			SampleRate:        0.5,
+			UseServingService: true,
 		},
 	}}
 
@@ -206,6 +214,11 @@ func TestNewConfigFailures(t *testing.T) {
 		input: map[string]string{
 			enableKey: "dot dash dot",
 		},
+	}, {
+		name: "useServingService invalid value",
+		input: map[string]string{
+			enableKey: "not a boolean",
+		},
 	}}
 	for _, tc := range tests {
 		t.Run(tc.name, func(t *testing.T) {