Disable high cardinality metrics in receivers. (#6475)

grafana · Feb 22, 2024 · d476c52 · d476c52
1 parent 90557a8
commit d476c52
Show file tree

Hide file tree

Showing 12 changed files with 378 additions and 2 deletions.
diff --git a/component/otelcol/receiver/jaeger/jaeger.go b/component/otelcol/receiver/jaeger/jaeger.go
@@ -40,6 +40,13 @@ type Arguments struct {
 
 var _ receiver.Arguments = Arguments{}
 
+// SetToDefault implements river.Defaulter.
+func (args *Arguments) SetToDefault() {
+	*args = Arguments{
+		DebugMetrics: otelcol.DefaultDebugMetricsArguments,
+	}
+}
+
 // Validate implements river.Validator.
 func (args *Arguments) Validate() error {
 	if args.Protocols.GRPC == nil &&

diff --git a/component/otelcol/receiver/jaeger/jaeger_test.go b/component/otelcol/receiver/jaeger/jaeger_test.go
@@ -5,6 +5,7 @@ import (
 	"testing"
 	"time"
 
+	"github.com/grafana/agent/component/otelcol"
 	"github.com/grafana/agent/component/otelcol/receiver/jaeger"
 	"github.com/grafana/agent/pkg/flow/componenttest"
 	"github.com/grafana/agent/pkg/util"
@@ -130,3 +131,59 @@ func getFreeAddr(t *testing.T) string {
 
 	return fmt.Sprintf("localhost:%d", portNumber)
 }
+
+func TestDebugMetricsConfig(t *testing.T) {
+	tests := []struct {
+		testName string
+		agentCfg string
+		expected otelcol.DebugMetricsArguments
+	}{
+		{
+			testName: "default",
+			agentCfg: `
+			protocols { thrift_compact {} }
+			output {}
+			`,
+			expected: otelcol.DebugMetricsArguments{
+				DisableHighCardinalityMetrics: true,
+			},
+		},
+		{
+			testName: "explicit_false",
+			agentCfg: `
+			protocols { thrift_compact {} }
+			debug_metrics {
+				disable_high_cardinality_metrics = false
+			}
+			output {}
+			`,
+			expected: otelcol.DebugMetricsArguments{
+				DisableHighCardinalityMetrics: false,
+			},
+		},
+		{
+			testName: "explicit_true",
+			agentCfg: `
+			protocols { thrift_compact {} }
+			debug_metrics {
+				disable_high_cardinality_metrics = true
+			}
+			output {}
+			`,
+			expected: otelcol.DebugMetricsArguments{
+				DisableHighCardinalityMetrics: true,
+			},
+		},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.testName, func(t *testing.T) {
+			var args jaeger.Arguments
+			require.NoError(t, river.Unmarshal([]byte(tc.agentCfg), &args))
+			_, err := args.Convert()
+			require.NoError(t, err)
+
+			require.Equal(t, tc.expected, args.DebugMetricsConfig())
+		})
+	}
+}
diff --git a/component/otelcol/receiver/kafka/kafka.go b/component/otelcol/receiver/kafka/kafka.go
@@ -83,6 +83,7 @@ var DefaultArguments = Arguments{
 		ExtractHeaders: false,
 		Headers:        []string{},
 	},
+	DebugMetrics: otelcol.DefaultDebugMetricsArguments,
 }
 
 // SetToDefault implements river.Defaulter.

diff --git a/component/otelcol/receiver/kafka/kafka_test.go b/component/otelcol/receiver/kafka/kafka_test.go
@@ -4,6 +4,7 @@ import (
 	"testing"
 	"time"
 
+	"github.com/grafana/agent/component/otelcol"
 	"github.com/grafana/agent/component/otelcol/receiver/kafka"
 	"github.com/grafana/river"
 	"github.com/mitchellh/mapstructure"
@@ -373,3 +374,62 @@ func TestArguments_Auth(t *testing.T) {
 		})
 	}
 }
+
+func TestDebugMetricsConfig(t *testing.T) {
+	tests := []struct {
+		testName string
+		agentCfg string
+		expected otelcol.DebugMetricsArguments
+	}{
+		{
+			testName: "default",
+			agentCfg: `
+			brokers = ["10.10.10.10:9092"]
+			protocol_version = "2.0.0"
+			output {}
+			`,
+			expected: otelcol.DebugMetricsArguments{
+				DisableHighCardinalityMetrics: true,
+			},
+		},
+		{
+			testName: "explicit_false",
+			agentCfg: `
+			brokers = ["10.10.10.10:9092"]
+			protocol_version = "2.0.0"
+			debug_metrics {
+				disable_high_cardinality_metrics = false
+			}
+			output {}
+			`,
+			expected: otelcol.DebugMetricsArguments{
+				DisableHighCardinalityMetrics: false,
+			},
+		},
+		{
+			testName: "explicit_true",
+			agentCfg: `
+			brokers = ["10.10.10.10:9092"]
+			protocol_version = "2.0.0"
+			debug_metrics {
+				disable_high_cardinality_metrics = true
+			}
+			output {}
+			`,
+			expected: otelcol.DebugMetricsArguments{
+				DisableHighCardinalityMetrics: true,
+			},
+		},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.testName, func(t *testing.T) {
+			var args kafka.Arguments
+			require.NoError(t, river.Unmarshal([]byte(tc.agentCfg), &args))
+			_, err := args.Convert()
+			require.NoError(t, err)
+
+			require.Equal(t, tc.expected, args.DebugMetricsConfig())
+		})
+	}
+}
diff --git a/component/otelcol/receiver/opencensus/opencensus.go b/component/otelcol/receiver/opencensus/opencensus.go
@@ -47,6 +47,7 @@ var DefaultArguments = Arguments{
 		ReadBufferSize: 512 * units.Kibibyte,
 		// We almost write 0 bytes, so no need to tune WriteBufferSize.
 	},
+	DebugMetrics: otelcol.DefaultDebugMetricsArguments,
 }
 
 // SetToDefault implements river.Defaulter.

diff --git a/component/otelcol/receiver/opencensus/opencensus_test.go b/component/otelcol/receiver/opencensus/opencensus_test.go
@@ -5,6 +5,7 @@ import (
 	"testing"
 	"time"
 
+	"github.com/grafana/agent/component/otelcol"
 	"github.com/grafana/agent/component/otelcol/receiver/opencensus"
 	"github.com/grafana/agent/pkg/flow/componenttest"
 	"github.com/grafana/agent/pkg/util"
@@ -97,3 +98,56 @@ func getFreeAddr(t *testing.T) string {
 
 	return fmt.Sprintf("localhost:%d", portNumber)
 }
+
+func TestDebugMetricsConfig(t *testing.T) {
+	tests := []struct {
+		testName string
+		agentCfg string
+		expected otelcol.DebugMetricsArguments
+	}{
+		{
+			testName: "default",
+			agentCfg: `
+			output {}
+			`,
+			expected: otelcol.DebugMetricsArguments{
+				DisableHighCardinalityMetrics: true,
+			},
+		},
+		{
+			testName: "explicit_false",
+			agentCfg: `
+			debug_metrics {
+				disable_high_cardinality_metrics = false
+			}
+			output {}
+			`,
+			expected: otelcol.DebugMetricsArguments{
+				DisableHighCardinalityMetrics: false,
+			},
+		},
+		{
+			testName: "explicit_true",
+			agentCfg: `
+			debug_metrics {
+				disable_high_cardinality_metrics = true
+			}
+			output {}
+			`,
+			expected: otelcol.DebugMetricsArguments{
+				DisableHighCardinalityMetrics: true,
+			},
+		},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.testName, func(t *testing.T) {
+			var args opencensus.Arguments
+			require.NoError(t, river.Unmarshal([]byte(tc.agentCfg), &args))
+			_, err := args.Convert()
+			require.NoError(t, err)
+
+			require.Equal(t, tc.expected, args.DebugMetricsConfig())
+		})
+	}
+}
diff --git a/component/otelcol/receiver/otlp/otlp.go b/component/otelcol/receiver/otlp/otlp.go
@@ -67,6 +67,13 @@ func (args *HTTPConfigArguments) Convert() *otlpreceiver.HTTPConfig {
 
 var _ receiver.Arguments = Arguments{}
 
+// SetToDefault implements river.Defaulter.
+func (args *Arguments) SetToDefault() {
+	*args = Arguments{
+		DebugMetrics: otelcol.DefaultDebugMetricsArguments,
+	}
+}
+
 // Convert implements receiver.Arguments.
 func (args Arguments) Convert() (otelcomponent.Config, error) {
 	return &otlpreceiver.Config{

diff --git a/component/otelcol/receiver/otlp/otlp_test.go b/component/otelcol/receiver/otlp/otlp_test.go
@@ -173,3 +173,65 @@ func TestUnmarshalHttpUrls(t *testing.T) {
 	assert.Equal(t, "custom/metrics", args.HTTP.MetricsURLPath)
 	assert.Equal(t, "custom/traces", args.HTTP.TracesURLPath)
 }
+
+func TestDebugMetricsConfig(t *testing.T) {
+	tests := []struct {
+		testName string
+		agentCfg string
+		expected otelcol.DebugMetricsArguments
+	}{
+		{
+			testName: "default",
+			agentCfg: `
+			grpc {
+				endpoint = "/v1/traces"
+			}
+			output {}
+			`,
+			expected: otelcol.DebugMetricsArguments{
+				DisableHighCardinalityMetrics: true,
+			},
+		},
+		{
+			testName: "explicit_false",
+			agentCfg: `
+			grpc {
+				endpoint = "/v1/traces"
+			}
+			debug_metrics {
+				disable_high_cardinality_metrics = false
+			}
+			output {}
+			`,
+			expected: otelcol.DebugMetricsArguments{
+				DisableHighCardinalityMetrics: false,
+			},
+		},
+		{
+			testName: "explicit_true",
+			agentCfg: `
+			grpc {
+				endpoint = "/v1/traces"
+			}
+			debug_metrics {
+				disable_high_cardinality_metrics = true
+			}
+			output {}
+			`,
+			expected: otelcol.DebugMetricsArguments{
+				DisableHighCardinalityMetrics: true,
+			},
+		},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.testName, func(t *testing.T) {
+			var args otlp.Arguments
+			require.NoError(t, river.Unmarshal([]byte(tc.agentCfg), &args))
+			_, err := args.Convert()
+			require.NoError(t, err)
+
+			require.Equal(t, tc.expected, args.DebugMetricsConfig())
+		})
+	}
+}
diff --git a/component/otelcol/receiver/vcenter/vcenter.go b/component/otelcol/receiver/vcenter/vcenter.go
@@ -267,6 +267,7 @@ var (
 				VcenterVMName:                    ResourceAttributeConfig{Enabled: true},
 			},
 		},
+		DebugMetrics: otelcol.DefaultDebugMetricsArguments,
 	}
 )
-Original file line number
+Diff line change
@@ Expand Up / @@ -267,6 +267,7 @@ var ( @@
     				VcenterVMName:                    ResourceAttributeConfig{Enabled: true},
     			},
     		},
+    		DebugMetrics: otelcol.DefaultDebugMetricsArguments,
     	}
     )
@@ Expand Down @@