signalfxexporter: Update exclude_metrics option to use dpfilters.MetricFilter

exporter/signalfxexporter/README.md

@@ -41,9 +41,10 @@ The following configuration options can also be configured:
   configuration option for [SignalFx
   receiver](../../receiver/signalfxreceiver/README.md) to preserve datapoint
   origin.
-- `exclude_metrics`: metric names that will be excluded from sending
-  to Signalfx backend. If `send_compatible_metrics` or `translation_rules`
-  options are enabled, the exclusion will be applied on translated metrics.
+- `exclude_metrics`: List of metric filters that will determine metrics to be
+  excluded from sending to Signalfx backend. If `send_compatible_metrics`
+  or `translation_rules` options are enabled, the exclusion will be applied
+  on translated metrics. See [here](./testdata/config.yaml) for examples.
 - `headers` (no default): Headers to pass in the payload.
 - `log_dimension_updates` (default = `false`): Whether or not to log dimension
   updates.

exporter/signalfxexporter/config.go

@@ -25,6 +25,7 @@ import (
 
 	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/signalfxexporter/correlation"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/signalfxexporter/translation"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/signalfxexporter/translation/dpfilters"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/splunk"
 )
 
@@ -85,10 +86,11 @@ type Config struct {
 	//            And keep `override=true` in resourcedetection config.
 	SyncHostMetadata bool `mapstructure:"sync_host_metadata"`
 
-	// ExcludeMetrics defines metrics that will be excluded from sending to Signalfx
-	// backend. If translations enabled with SendCompatibleMetrics or TranslationRules
-	// options, the exclusion will be applied on translated metrics.
-	ExcludeMetrics []string `mapstructure:"exclude_metrics"`
+	// ExcludeMetrics defines dpfilter.MetricFilters that will determine metrics to be
+	// excluded from sending to SignalFx backend. If translations enabled with
+	// SendCompatibleMetrics or TranslationRules options, the exclusion will be applied
+	// on translated metrics.
+	ExcludeMetrics []dpfilters.MetricFilter `mapstructure:"exclude_metrics"`
 
 	// Correlation configuration for syncing traces service and environment to metrics.
 	Correlation *correlation.Config `mapstructure:"correlation"`

exporter/signalfxexporter/config_test.go

@@ -34,6 +34,7 @@ import (
 
 	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/signalfxexporter/correlation"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/signalfxexporter/translation"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/signalfxexporter/translation/dpfilters"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/splunk"
 )
 
@@ -94,6 +95,26 @@ func TestLoadConfig(t *testing.T) {
 				},
 			},
 		},
+		ExcludeMetrics: []dpfilters.MetricFilter{
+			{
+				MetricName: "metric1",
+			},
+			{
+				MetricNames: []string{"metric2", "metric3"},
+			},
+			{
+				MetricName: "metric4",
+				Dimensions: map[string]interface{}{
+					"dimension_key": "dimension_val",
+				},
+			},
+			{
+				MetricName: "metric5",
+				Dimensions: map[string]interface{}{
+					"dimension_key": []interface{}{"dimension_val1", "dimension_val2"},
+				},
+			},
+		},
 		DeltaTranslationTTL: 3600,
 		Correlation: &correlation.Config{
 			HTTPClientSettings: confighttp.HTTPClientSettings{

exporter/signalfxexporter/exporter.go

@@ -90,6 +90,11 @@ func newSignalFxExporter(
 
 	headers := buildHeaders(config)
 
+	converter, err := translation.NewMetricsConverter(logger, options.metricTranslator, config.ExcludeMetrics)
+	if err != nil {
+		return nil, fmt.Errorf("failed to create metric converter: %v", err)
+	}
+
 	dpClient := &sfxDPClient{
 		sfxClientBase: sfxClientBase{
 			ingestURL: options.ingestURL,
@@ -103,7 +108,7 @@ func newSignalFxExporter(
 		},
 		logger:                 logger,
 		accessTokenPassthrough: config.AccessTokenPassthrough,
-		converter:              translation.NewMetricsConverter(logger, options.metricTranslator),
+		converter:              converter,
 	}
 
 	dimClient := dimensions.NewDimensionClient(

exporter/signalfxexporter/exporter_test.go

@@ -41,6 +41,7 @@ import (
 
 	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/signalfxexporter/dimensions"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/signalfxexporter/translation"
+	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/signalfxexporter/translation/dpfilters"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/common/metrics"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/splunk"
 )
@@ -64,6 +65,15 @@ func TestNew(t *testing.T) {
 			},
 			wantErr: true,
 		},
+		{
+			name: "fails to create metrics converter",
+			config: &Config{
+				AccessToken:    "test",
+				Realm:          "realm",
+				ExcludeMetrics: []dpfilters.MetricFilter{{}},
+			},
+			wantErr: true,
+		},
 		{
 			name: "successfully create exporter",
 			config: &Config{
@@ -184,6 +194,9 @@ func TestConsumeMetrics(t *testing.T) {
 			serverURL, err := url.Parse(server.URL)
 			assert.NoError(t, err)
 
+			c, err := translation.NewMetricsConverter(zap.NewNop(), nil, nil)
+			require.NoError(t, err)
+			require.NotNil(t, c)
 			dpClient := &sfxDPClient{
 				sfxClientBase: sfxClientBase{
 					ingestURL: serverURL,
@@ -196,7 +209,7 @@ func TestConsumeMetrics(t *testing.T) {
 					}},
 				},
 				logger:    zap.NewNop(),
-				converter: translation.NewMetricsConverter(zap.NewNop(), nil),
+				converter: c,
 			}
 
 			numDroppedTimeSeries, err := dpClient.pushMetricsData(context.Background(), tt.md)
@@ -961,6 +974,9 @@ func BenchmarkExporterConsumeData(b *testing.B) {
 	serverURL, err := url.Parse(server.URL)
 	assert.NoError(b, err)
 
+	c, err := translation.NewMetricsConverter(zap.NewNop(), nil, nil)
+	require.NoError(b, err)
+	require.NotNil(b, c)
 	dpClient := &sfxDPClient{
 		sfxClientBase: sfxClientBase{
 			ingestURL: serverURL,
@@ -972,7 +988,7 @@ func BenchmarkExporterConsumeData(b *testing.B) {
 			}},
 		},
 		logger:    zap.NewNop(),
-		converter: translation.NewMetricsConverter(zap.NewNop(), nil),
+		converter: c,
 	}
 
 	for i := 0; i < b.N; i++ {

exporter/signalfxexporter/factory.go

@@ -151,10 +151,6 @@ func setTranslationRules(cfg *Config) error {
 		}
 		cfg.TranslationRules = defaultRules
 	}
-	if len(cfg.ExcludeMetrics) > 0 {
-		cfg.TranslationRules = append(cfg.TranslationRules,
-			translation.GetExcludeMetricsRule(cfg.ExcludeMetrics))
-	}
 	return nil
 }
 

exporter/signalfxexporter/factory_test.go

@@ -236,57 +236,6 @@ func TestCreateMetricsExporterWithSpecifiedTranslaitonRules(t *testing.T) {
 	assert.Equal(t, "new_dimension", config.TranslationRules[0].Mapping["old_dimension"])
 }
 
-func TestCreateMetricsExporterWithExcludedMetrics(t *testing.T) {
-	config := &Config{
-		ExporterSettings: configmodels.ExporterSettings{
-			TypeVal: configmodels.Type(typeStr),
-			NameVal: typeStr,
-		},
-		AccessToken:    "testToken",
-		Realm:          "us1",
-		ExcludeMetrics: []string{"metric1"},
-	}
-
-	te, err := createMetricsExporter(context.Background(), component.ExporterCreateParams{Logger: zap.NewNop()}, config)
-	require.NoError(t, err)
-	require.NotNil(t, te)
-
-	assert.Equal(t, 1, len(config.TranslationRules))
-	assert.Equal(t, translation.ActionDropMetrics, config.TranslationRules[0].Action)
-	assert.Equal(t, 1, len(config.TranslationRules[0].MetricNames))
-	assert.True(t, config.TranslationRules[0].MetricNames["metric1"])
-}
-
-func TestCreateMetricsExporterWithDefinedRulesAndExcludedMetrics(t *testing.T) {
-	config := &Config{
-		ExporterSettings: configmodels.ExporterSettings{
-			TypeVal: configmodels.Type(typeStr),
-			NameVal: typeStr,
-		},
-		AccessToken: "testToken",
-		Realm:       "us1",
-		TranslationRules: []translation.Rule{
-			{
-				Action: translation.ActionRenameDimensionKeys,
-				Mapping: map[string]string{
-					"old_dimension": "new_dimension",
-				},
-			},
-		},
-		ExcludeMetrics: []string{"metric1"},
-	}
-
-	te, err := createMetricsExporter(context.Background(), component.ExporterCreateParams{Logger: zap.NewNop()}, config)
-	require.NoError(t, err)
-	require.NotNil(t, te)
-
-	assert.Equal(t, 2, len(config.TranslationRules))
-	assert.Equal(t, translation.ActionRenameDimensionKeys, config.TranslationRules[0].Action)
-	assert.Equal(t, translation.ActionDropMetrics, config.TranslationRules[1].Action)
-	assert.Equal(t, 1, len(config.TranslationRules[1].MetricNames))
-	assert.True(t, config.TranslationRules[1].MetricNames["metric1"])
-}
-
 func TestDefaultTranslationRules(t *testing.T) {
 	rules, err := loadDefaultTranslationRules()
 	require.NoError(t, err)
@@ -295,7 +244,8 @@ func TestDefaultTranslationRules(t *testing.T) {
 	require.NoError(t, err)
 	data := testMetricsData()
 
-	c := translation.NewMetricsConverter(zap.NewNop(), tr)
+	c, err := translation.NewMetricsConverter(zap.NewNop(), tr, nil)
+	require.NoError(t, err)
 	translated := c.MetricDataToSignalFxV2(data)
 	require.NotNil(t, translated)
 

exporter/signalfxexporter/testdata/config.yaml

@@ -29,6 +29,17 @@ exporters:
     - action: rename_dimension_keys
       mapping:
         k8s.cluster.name: kubernetes_cluster
+    exclude_metrics:
+      - metric_name: metric1
+      - metric_names: [metric2, metric3]
+      - metric_name: metric4
+        dimensions:
+          dimension_key: dimension_val
+      - metric_name: metric5
+        dimensions:
+          dimension_key: [dimension_val1, dimension_val2]
+
+
 
 service:
   pipelines:

exporter/signalfxexporter/translation/converter.go

@@ -27,6 +27,7 @@ import (
 	tracetranslator "go.opentelemetry.io/collector/translator/trace"
 	"go.uber.org/zap"
 
+	"github.com/open-telemetry/opentelemetry-collector-contrib/exporter/signalfxexporter/translation/dpfilters"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/internal/splunk"
 )
 
@@ -51,13 +52,18 @@ var (
 type MetricsConverter struct {
 	logger           *zap.Logger
 	metricTranslator *MetricTranslator
+	filterSet        *dpfilters.FilterSet
 }
 
 // NewMetricsConverter creates a MetricsConverter from the passed in logger and
 // MetricTranslator. Pass in a nil MetricTranslator to not use translation
 // rules.
-func NewMetricsConverter(logger *zap.Logger, t *MetricTranslator) *MetricsConverter {
-	return &MetricsConverter{logger: logger, metricTranslator: t}
+func NewMetricsConverter(logger *zap.Logger, t *MetricTranslator, excludes []dpfilters.MetricFilter) (*MetricsConverter, error) {
+	fs, err := dpfilters.NewFilterSet(excludes)
+	if err != nil {
+		return nil, err
+	}
+	return &MetricsConverter{logger: logger, metricTranslator: t, filterSet: fs}, nil
 }
 
 // MetricDataToSignalFxV2 converts the passed in MetricsData to SFx datapoints,
@@ -111,6 +117,21 @@ func (c *MetricsConverter) metricToSfxDataPoints(metric pdata.Metric, extraDimen
 		dps = c.metricTranslator.TranslateDataPoints(c.logger, dps)
 	}
 
+	// TODO:
+	// 1) Add hard coded list of metrics to be excluded to omit non-default metrics
+	// 2) Add an include_metrics options that will serve as an override to the exclude
+	// list. This will help to include metrics that are excluded by default.
+	resultSliceLen := 0
+	for i, dp := range dps {
+		if !c.filterSet.Matches(dp) {
+			if resultSliceLen < i {
+				dps[resultSliceLen] = dp
+			}
+			resultSliceLen++
+		}
+	}
+	dps = dps[:resultSliceLen]
+
 	return dps
 }