apis/v1alpha1: rename instrumentation sampler config

Signed-off-by: Benedikt Bongartz <[email protected]>
open-telemetry · Sep 11, 2024 · 86a975c · 86a975c
1 parent e203cbc
commit 86a975c
Show file tree

Hide file tree

Showing 8 changed files with 33 additions and 33 deletions.
diff --git a/apis/v1alpha1/instrumentation_types.go b/apis/v1alpha1/instrumentation_types.go
@@ -36,9 +36,9 @@ type InstrumentationSpec struct {
 	// +optional
 	Propagators []Propagator `json:"propagators,omitempty"`
 
-	// Sampler defines sampling configuration.
+	// SamplerConfig defines sampling configuration.
 	// +optional
-	Sampler `json:"sampler,omitempty"`
+	SamplerConfig `json:"sampler,omitempty"`
 
 	// Env defines common env vars. There are four layers for env vars' definitions and
 	// the precedence order is: `original container env vars` > `language specific env vars` > `common env vars` > `instrument spec configs' vars`.
@@ -98,8 +98,8 @@ type Exporter struct {
 	Endpoint string `json:"endpoint,omitempty"`
 }
 
-// Sampler defines sampling configuration.
-type Sampler struct {
+// SamplerConfig defines sampling configuration.
+type SamplerConfig struct {
 	// Type defines sampler type.
 	// The value will be set in the OTEL_TRACES_SAMPLER env var.
 	// The value can be for instance parentbased_always_on, parentbased_always_off, parentbased_traceidratio...

diff --git a/apis/v1alpha1/instrumentation_webhook.go b/apis/v1alpha1/instrumentation_webhook.go
@@ -209,32 +209,32 @@ func (w InstrumentationWebhook) defaulter(r *Instrumentation) error {
 
 func (w InstrumentationWebhook) validate(r *Instrumentation) (admission.Warnings, error) {
 	var warnings []string
-	switch r.Spec.Sampler.Type {
+	switch r.Spec.SamplerConfig.Type {
 	case "":
 		warnings = append(warnings, "sampler type not set")
 	case TraceIDRatio, ParentBasedTraceIDRatio:
-		if r.Spec.Sampler.Argument != "" {
-			rate, err := strconv.ParseFloat(r.Spec.Sampler.Argument, 64)
+		if r.Spec.SamplerConfig.Argument != "" {
+			rate, err := strconv.ParseFloat(r.Spec.SamplerConfig.Argument, 64)
 			if err != nil {
-				return warnings, fmt.Errorf("spec.sampler.argument is not a number: %s", r.Spec.Sampler.Argument)
+				return warnings, fmt.Errorf("spec.sampler.argument is not a number: %s", r.Spec.SamplerConfig.Argument)
 			}
 			if rate < 0 || rate > 1 {
-				return warnings, fmt.Errorf("spec.sampler.argument should be in rage [0..1]: %s", r.Spec.Sampler.Argument)
+				return warnings, fmt.Errorf("spec.sampler.argument should be in rage [0..1]: %s", r.Spec.SamplerConfig.Argument)
 			}
 		}
 	case JaegerRemote, ParentBasedJaegerRemote:
 		// value is a comma separated list of endpoint, pollingIntervalMs, initialSamplingRate
 		// Example: `endpoint=http://localhost:14250,pollingIntervalMs=5000,initialSamplingRate=0.25`
-		if r.Spec.Sampler.Argument != "" {
-			err := validateJaegerRemoteSamplerArgument(r.Spec.Sampler.Argument)
+		if r.Spec.SamplerConfig.Argument != "" {
+			err := validateJaegerRemoteSamplerArgument(r.Spec.SamplerConfig.Argument)
 
 			if err != nil {
-				return warnings, fmt.Errorf("spec.sampler.argument is not a valid argument for sampler %s: %w", r.Spec.Sampler.Type, err)
+				return warnings, fmt.Errorf("spec.sampler.argument is not a valid argument for sampler %s: %w", r.Spec.SamplerConfig.Type, err)
 			}
 		}
 	case AlwaysOn, AlwaysOff, ParentBasedAlwaysOn, ParentBasedAlwaysOff, XRaySampler:
 	default:
-		return warnings, fmt.Errorf("spec.sampler.type is not valid: %s", r.Spec.Sampler.Type)
+		return warnings, fmt.Errorf("spec.sampler.type is not valid: %s", r.Spec.SamplerConfig.Type)
 	}
 	return warnings, nil
 }

diff --git a/apis/v1alpha1/instrumentation_webhook_test.go b/apis/v1alpha1/instrumentation_webhook_test.go
@@ -63,7 +63,7 @@ func TestInstrumentationValidatingWebhook(t *testing.T) {
 			name: "sampler configuration not present",
 			inst: Instrumentation{
 				Spec: InstrumentationSpec{
-					Sampler: Sampler{},
+					SamplerConfig: SamplerConfig{},
 				},
 			},
 			warnings: []string{"sampler type not set"},
@@ -73,7 +73,7 @@ func TestInstrumentationValidatingWebhook(t *testing.T) {
 			err:  "spec.sampler.argument is not a number",
 			inst: Instrumentation{
 				Spec: InstrumentationSpec{
-					Sampler: Sampler{
+					SamplerConfig: SamplerConfig{
 						Type:     ParentBasedTraceIDRatio,
 						Argument: "abc",
 					},
@@ -85,7 +85,7 @@ func TestInstrumentationValidatingWebhook(t *testing.T) {
 			err:  "spec.sampler.argument should be in rage [0..1]",
 			inst: Instrumentation{
 				Spec: InstrumentationSpec{
-					Sampler: Sampler{
+					SamplerConfig: SamplerConfig{
 						Type:     ParentBasedTraceIDRatio,
 						Argument: "1.99",
 					},
@@ -96,7 +96,7 @@ func TestInstrumentationValidatingWebhook(t *testing.T) {
 			name: "argument is a number",
 			inst: Instrumentation{
 				Spec: InstrumentationSpec{
-					Sampler: Sampler{
+					SamplerConfig: SamplerConfig{
 						Type:     ParentBasedTraceIDRatio,
 						Argument: "0.99",
 					},
@@ -107,7 +107,7 @@ func TestInstrumentationValidatingWebhook(t *testing.T) {
 			name: "argument is missing",
 			inst: Instrumentation{
 				Spec: InstrumentationSpec{
-					Sampler: Sampler{
+					SamplerConfig: SamplerConfig{
 						Type: ParentBasedTraceIDRatio,
 					},
 				},
@@ -172,7 +172,7 @@ func TestInstrumentationJaegerRemote(t *testing.T) {
 			t.Run(test.name, func(t *testing.T) {
 				inst := Instrumentation{
 					Spec: InstrumentationSpec{
-						Sampler: Sampler{
+						SamplerConfig: SamplerConfig{
 							Type:     sampler,
 							Argument: test.arg,
 						},

diff --git a/apis/v1alpha1/zz_generated.deepcopy.go b/apis/v1alpha1/zz_generated.deepcopy.go
diff --git a/docs/api.md b/docs/api.md
@@ -176,7 +176,7 @@ Enum=tracecontext;baggage;b3;b3multi;jaeger;xray;ottrace;none<br/>
         <td><b><a href="#instrumentationspecsampler">sampler</a></b></td>
         <td>object</td>
         <td>
-          Sampler defines sampling configuration.<br/>
+          SamplerConfig defines sampling configuration.<br/>
         </td>
         <td>false</td>
       </tr></tbody>
@@ -4016,7 +4016,7 @@ For example environment: dev<br/>
 
 
 
-Sampler defines sampling configuration.
+SamplerConfig defines sampling configuration.
 
 <table>
     <thead>

diff --git a/pkg/instrumentation/sdk.go b/pkg/instrumentation/sdk.go
@@ -382,17 +382,17 @@ func (i *sdkInjector) injectCommonSDKConfig(ctx context.Context, otelinst v1alph
 
 	idx = getIndexOfEnv(container.Env, constants.EnvOTELTracesSampler)
 	// configure sampler only if it is configured in the CR
-	if idx == -1 && otelinst.Spec.Sampler.Type != "" {
+	if idx == -1 && otelinst.Spec.SamplerConfig.Type != "" {
 		idxSamplerArg := getIndexOfEnv(container.Env, constants.EnvOTELTracesSamplerArg)
 		if idxSamplerArg == -1 {
 			container.Env = append(container.Env, corev1.EnvVar{
 				Name:  constants.EnvOTELTracesSampler,
-				Value: string(otelinst.Spec.Sampler.Type),
+				Value: string(otelinst.Spec.SamplerConfig.Type),
 			})
-			if otelinst.Spec.Sampler.Argument != "" {
+			if otelinst.Spec.SamplerConfig.Argument != "" {
 				container.Env = append(container.Env, corev1.EnvVar{
 					Name:  constants.EnvOTELTracesSamplerArg,
-					Value: otelinst.Spec.Sampler.Argument,
+					Value: otelinst.Spec.SamplerConfig.Argument,
 				})
 			}
 		}

diff --git a/pkg/instrumentation/sdk_test.go b/pkg/instrumentation/sdk_test.go
@@ -133,7 +133,7 @@ func TestSDKInjection(t *testing.T) {
 						AddK8sUIDAttributes: true,
 					},
 					Propagators: []v1alpha1.Propagator{"b3", "jaeger"},
-					Sampler: v1alpha1.Sampler{
+					SamplerConfig: v1alpha1.SamplerConfig{
 						Type:     "parentbased_traceidratio",
 						Argument: "0.25",
 					},
@@ -241,7 +241,7 @@ func TestSDKInjection(t *testing.T) {
 						},
 					},
 					Propagators: []v1alpha1.Propagator{"jaeger"},
-					Sampler: v1alpha1.Sampler{
+					SamplerConfig: v1alpha1.SamplerConfig{
 						Type:     "parentbased_traceidratio",
 						Argument: "0.25",
 					},
@@ -521,7 +521,7 @@ func TestSDKInjection(t *testing.T) {
 						},
 					},
 					Propagators: []v1alpha1.Propagator{"jaeger"},
-					Sampler: v1alpha1.Sampler{
+					SamplerConfig: v1alpha1.SamplerConfig{
 						Type:     "parentbased_traceidratio",
 						Argument: "0.25",
 					},

diff --git a/pkg/instrumentation/upgrade/upgrade_test.go b/pkg/instrumentation/upgrade/upgrade_test.go
@@ -48,7 +48,7 @@ func TestUpgrade(t *testing.T) {
 			Namespace: nsName,
 		},
 		Spec: v1alpha1.InstrumentationSpec{
-			Sampler: v1alpha1.Sampler{
+			SamplerConfig: v1alpha1.SamplerConfig{
 				Type: v1alpha1.ParentBasedAlwaysOff,
 			},
 		},