fix(breaking): sampling ratio yaml config (#3034)

flipt-io · May 1, 2024 · 188a072 · 188a072
1 parent e262e82
commit 188a072
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 10 deletions.
diff --git a/config/flipt.schema.cue b/config/flipt.schema.cue
@@ -282,9 +282,9 @@ import "strings"
 	}
 
 	#tracing: {
-		enabled?:       bool | *false
-		exporter?:      *"jaeger" | "zipkin" | "otlp"
-		samplingRatio?: float & >=0 & <=1 | *1
+		enabled?:        bool | *false
+		exporter?:       *"jaeger" | "zipkin" | "otlp"
+		sampling_ratio?: float & >=0 & <=1 | *1
 		propagators?: [
 			..."tracecontext" | "baggage" | "b3" | "b3multi" | "jaeger" | "xray" | "ottrace" | "none",
 		] | *["tracecontext", "baggage"]

diff --git a/config/flipt.schema.json b/config/flipt.schema.json
@@ -977,7 +977,7 @@
           "enum": ["jaeger", "zipkin", "otlp"],
           "default": "jaeger"
         },
-        "samplingRatio": {
+        "sampling_ratio": {
           "type": "number",
           "default": 1,
           "minimum": 0,

diff --git a/internal/config/testdata/tracing/otlp.yml b/internal/config/testdata/tracing/otlp.yml
@@ -1,7 +1,7 @@
 tracing:
   enabled: true
   exporter: otlp
-  samplingRatio: 0.5
+  sampling_ratio: 0.5
   otlp:
     endpoint: http://localhost:9999
     headers:

diff --git a/internal/config/testdata/tracing/wrong_sampling_ratio.yml b/internal/config/testdata/tracing/wrong_sampling_ratio.yml
@@ -1,3 +1,3 @@
 tracing:
   enabled: true
-  samplingRatio: 1.1
+  sampling_ratio: 1.1
diff --git a/internal/config/tracing.go b/internal/config/tracing.go
@@ -17,17 +17,17 @@ type TracingConfig struct {
 	Enabled       bool                `json:"enabled" mapstructure:"enabled" yaml:"enabled"`
 	Exporter      TracingExporter     `json:"exporter,omitempty" mapstructure:"exporter" yaml:"exporter,omitempty"`
 	Propagators   []TracingPropagator `json:"propagators,omitempty" mapstructure:"propagators" yaml:"propagators,omitempty"`
-	SamplingRatio float64             `json:"samplingRatio,omitempty" mapstructure:"samplingRatio" yaml:"samplingRatio,omitempty"`
+	SamplingRatio float64             `json:"samplingRatio,omitempty" mapstructure:"sampling_ratio" yaml:"sampling_ratio,omitempty"`
 	Jaeger        JaegerTracingConfig `json:"jaeger,omitempty" mapstructure:"jaeger" yaml:"jaeger,omitempty"`
 	Zipkin        ZipkinTracingConfig `json:"zipkin,omitempty" mapstructure:"zipkin" yaml:"zipkin,omitempty"`
 	OTLP          OTLPTracingConfig   `json:"otlp,omitempty" mapstructure:"otlp" yaml:"otlp,omitempty"`
 }
 
 func (c *TracingConfig) setDefaults(v *viper.Viper) error {
 	v.SetDefault("tracing", map[string]any{
-		"enabled":       false,
-		"exporter":      TracingJaeger,
-		"samplingRatio": 1,
+		"enabled":        false,
+		"exporter":       TracingJaeger,
+		"sampling_ratio": 1,
 		"propagators": []TracingPropagator{
 			TracingPropagatorTraceContext,
 			TracingPropagatorBaggage,