config file support

Signed-off-by: Muxian Wu <muxianw@twitter.com>

Author: WUMUXIAN

changelogs/unreleased/7373-WUMUXIAN-minor.md

@@ -0,0 +1,3 @@
+## Allow configurable client_sampling and random_sampling for tracing
+
+Added support for configuring client_sampling and random_sampling in Contour's tracing configuration, allowing more granular control over trace sampling rates as per Envoy's tracing documentation.

cmd/contour/servecontext.go

@@ -413,6 +413,8 @@ func (ctx *serveContext) convertToContourConfigurationSpec() contour_v1alpha1.Co
 			IncludePodDetail: ctx.Config.Tracing.IncludePodDetail,
 			ServiceName:      ctx.Config.Tracing.ServiceName,
 			OverallSampling:  ctx.Config.Tracing.OverallSampling,
+			ClientSampling:   ctx.Config.Tracing.ClientSampling,
+			RandomSampling:   ctx.Config.Tracing.RandomSampling,
 			MaxPathTagLength: ctx.Config.Tracing.MaxPathTagLength,
 			CustomTags:       customTags,
 			ExtensionService: &contour_v1alpha1.NamespacedName{

cmd/contour/servecontext_test.go

@@ -833,6 +833,8 @@ func TestConvertServeContext(t *testing.T) {
 					IncludePodDetail: ptr.To(false),
 					ServiceName:      ptr.To("contour"),
 					OverallSampling:  ptr.To("100"),
+					ClientSampling:   ptr.To("100"),
+					RandomSampling:   ptr.To("100"),
 					MaxPathTagLength: ptr.To(uint32(256)),
 					CustomTags: []config.CustomTag{
 						{
@@ -853,6 +855,8 @@ func TestConvertServeContext(t *testing.T) {
 					IncludePodDetail: ptr.To(false),
 					ServiceName:      ptr.To("contour"),
 					OverallSampling:  ptr.To("100"),
+					ClientSampling:   ptr.To("100"),
+					RandomSampling:   ptr.To("100"),
 					MaxPathTagLength: ptr.To(uint32(256)),
 					CustomTags: []*contour_v1alpha1.CustomTag{
 						{

pkg/config/parameters.go

@@ -19,6 +19,7 @@ import (
 	"io"
 	"os"
 	"path/filepath"
+	"strconv"
 	"strings"
 	"time"
 
@@ -727,6 +728,14 @@ type Tracing struct {
 	// the default value is 100.
 	OverallSampling *string `yaml:"overallSampling,omitempty"`
 
+	// ClientSampling defines the client sampling rate of trace data.
+	// the default value is 100.
+	ClientSampling *string `yaml:"clientSampling,omitempty"`
+
+	// RandomSampling defines the random sampling rate of trace data.
+	// the default value is 100.
+	RandomSampling *string `yaml:"randomSampling,omitempty"`
+
 	// MaxPathTagLength defines maximum length of the request path
 	// to extract and include in the HttpUrl tag.
 	// the default value is 256.
@@ -908,6 +917,20 @@ func (t *Tracing) Validate() error {
 		return errors.New("tracing.extensionService must be defined")
 	}
 
+	if t.ClientSampling != nil {
+		_, err := strconv.ParseFloat(*t.ClientSampling, 64)
+		if err != nil {
+			return fmt.Errorf("invalid tracing client sampling: %v", err)
+		}
+	}
+
+	if t.RandomSampling != nil {
+		_, err := strconv.ParseFloat(*t.RandomSampling, 64)
+		if err != nil {
+			return fmt.Errorf("invalid tracing random sampling: %v", err)
+		}
+	}
+
 	var customTagNames []string
 
 	for _, customTag := range t.CustomTags {

pkg/config/parameters_test.go

@@ -682,6 +682,8 @@ func TestTracingConfigValidation(t *testing.T) {
 		IncludePodDetail: ptr.To(false),
 		ServiceName:      ptr.To("contour"),
 		OverallSampling:  ptr.To("100"),
+		ClientSampling:   ptr.To("100"),
+		RandomSampling:   ptr.To("100"),
 		MaxPathTagLength: ptr.To(uint32(256)),
 		CustomTags:       nil,
 		ExtensionService: "projectcontour/otel-collector",
@@ -692,6 +694,8 @@ func TestTracingConfigValidation(t *testing.T) {
 		IncludePodDetail: ptr.To(false),
 		ServiceName:      ptr.To("contour"),
 		OverallSampling:  ptr.To("100"),
+		ClientSampling:   ptr.To("100"),
+		RandomSampling:   ptr.To("100"),
 		MaxPathTagLength: ptr.To(uint32(256)),
 		CustomTags:       nil,
 	}
@@ -700,6 +704,8 @@ func TestTracingConfigValidation(t *testing.T) {
 	trace = &Tracing{
 		IncludePodDetail: ptr.To(false),
 		OverallSampling:  ptr.To("100"),
+		ClientSampling:   ptr.To("100"),
+		RandomSampling:   ptr.To("100"),
 		MaxPathTagLength: ptr.To(uint32(256)),
 		CustomTags:       nil,
 		ExtensionService: "projectcontour/otel-collector",
@@ -708,6 +714,8 @@ func TestTracingConfigValidation(t *testing.T) {
 
 	trace = &Tracing{
 		OverallSampling:  ptr.To("100"),
+		ClientSampling:   ptr.To("100"),
+		RandomSampling:   ptr.To("100"),
 		MaxPathTagLength: ptr.To(uint32(256)),
 		CustomTags: []CustomTag{
 			{
@@ -722,6 +730,8 @@ func TestTracingConfigValidation(t *testing.T) {
 
 	trace = &Tracing{
 		OverallSampling:  ptr.To("100"),
+		ClientSampling:   ptr.To("100"),
+		RandomSampling:   ptr.To("100"),
 		MaxPathTagLength: ptr.To(uint32(256)),
 		CustomTags: []CustomTag{
 			{
@@ -735,6 +745,8 @@ func TestTracingConfigValidation(t *testing.T) {
 	trace = &Tracing{
 		IncludePodDetail: ptr.To(true),
 		OverallSampling:  ptr.To("100"),
+		ClientSampling:   ptr.To("100"),
+		RandomSampling:   ptr.To("100"),
 		MaxPathTagLength: ptr.To(uint32(256)),
 		CustomTags: []CustomTag{
 			{