Fixed labels and annotations filter

Signed-off-by: Yuri Sa <[email protected]>

Author: yuriolisa

.chloggen/fix-filter-labels-annotations.yaml

@@ -0,0 +1,17 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: 'bug_fix'
+
+# The name of the component, or a single word describing the area of concern, (e.g. collector, target allocator, auto-instrumentation, opamp, github action)
+component: operator
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Fix of Labels and Annotations filter
+
+# One or more tracking issues related to the change
+issues: [2770]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext: Changed the approach from regexp.MatchString, which was representing a high resource cost and |
+confusing the users to strings.Contains, which turned out to be simpler and more efficient.

.github/workflows/e2e.yaml

@@ -37,7 +37,7 @@ jobs:
          - group: e2e-multi-instrumentation
            setup: "add-operator-arg OPERATOR_ARG=--enable-multi-instrumentation prepare-e2e"
          - group: e2e-metadata-filters
-           setup: "add-operator-arg OPERATOR_ARG='--annotations-filter=*filter.out --labels=*filter.out' prepare-e2e"
+           setup: "add-operator-arg OPERATOR_ARG='--annotations-filter=filter.out --labels=filter.out' prepare-e2e"
 
     steps:
     - name: Check out code into the Go module directory

internal/manifests/collector/daemonset_test.go

@@ -227,7 +227,7 @@ func TestDaemonsetFilterLabels(t *testing.T) {
 		Spec: v1beta1.OpenTelemetryCollectorSpec{},
 	}
 
-	cfg := config.New(config.WithLabelFilters([]string{"foo*", "app.*.bar"}))
+	cfg := config.New(config.WithLabelFilters([]string{"foo", ".bar"}))
 
 	params := manifests.Params{
 		Config:  cfg,
@@ -258,7 +258,7 @@ func TestDaemonsetFilterAnnotations(t *testing.T) {
 		Spec: v1beta1.OpenTelemetryCollectorSpec{},
 	}
 
-	cfg := config.New(config.WithAnnotationFilters([]string{"foo*", "app.*.bar"}))
+	cfg := config.New(config.WithAnnotationFilters([]string{"foo", ".bar"}))
 
 	params := manifests.Params{
 		Config:  cfg,

internal/manifests/collector/deployment_test.go

@@ -309,7 +309,7 @@ func TestDeploymentFilterLabels(t *testing.T) {
 		Spec: v1beta1.OpenTelemetryCollectorSpec{},
 	}
 
-	cfg := config.New(config.WithLabelFilters([]string{"foo*", "app.*.bar"}))
+	cfg := config.New(config.WithLabelFilters([]string{"foo", ".bar"}))
 
 	params := manifests.Params{
 		Config:  cfg,
@@ -340,7 +340,7 @@ func TestDeploymentFilterAnnotations(t *testing.T) {
 		Spec: v1beta1.OpenTelemetryCollectorSpec{},
 	}
 
-	cfg := config.New(config.WithAnnotationFilters([]string{"foo*", "app.*.bar"}))
+	cfg := config.New(config.WithAnnotationFilters([]string{"foo", ".bar"}))
 
 	params := manifests.Params{
 		Config:  cfg,

internal/manifests/collector/statefulset_test.go

@@ -319,7 +319,7 @@ func TestStatefulSetFilterLabels(t *testing.T) {
 		Spec: v1beta1.OpenTelemetryCollectorSpec{},
 	}
 
-	cfg := config.New(config.WithLabelFilters([]string{"foo*", "app.*.bar"}))
+	cfg := config.New(config.WithLabelFilters([]string{"foo", ".bar"}))
 
 	params := manifests.Params{
 		OtelCol: otelcol,
@@ -350,7 +350,7 @@ func TestStatefulSetFilterAnnotations(t *testing.T) {
 		Spec: v1beta1.OpenTelemetryCollectorSpec{},
 	}
 
-	cfg := config.New(config.WithAnnotationFilters([]string{"foo*", "app.*.bar"}))
+	cfg := config.New(config.WithAnnotationFilters([]string{"foo", ".bar"}))
 
 	params := manifests.Params{
 		OtelCol: otelcol,

internal/manifests/manifestutils/annotations_test.go

@@ -160,11 +160,36 @@ func TestAnnotationsPropagateDown(t *testing.T) {
 	assert.Equal(t, "pod_annotation_value", podAnnotations["pod_annotation"])
 }
 
+func TestAnnotationsSingleFilter(t *testing.T) {
+	otelcol := v1beta1.OpenTelemetryCollector{
+		ObjectMeta: metav1.ObjectMeta{
+			Annotations: map[string]string{
+				"test.bar.io":  "foo",
+				"test.io/port": "1234",
+				"test.io/path": "/test",
+			},
+		},
+		Spec: v1beta1.OpenTelemetryCollectorSpec{
+			Mode: "deployment",
+		},
+	}
+
+	// This requires the filter to be in regex match form and not the other simpler wildcard one.
+	annotations, err := Annotations(otelcol, []string{".bar.io"})
+
+	// verify
+	require.NoError(t, err)
+	assert.Len(t, annotations, 6)
+	assert.NotContains(t, annotations, "test.bar.io")
+	assert.Equal(t, "1234", annotations["test.io/port"])
+}
+
 func TestAnnotationsFilter(t *testing.T) {
 	otelcol := v1beta1.OpenTelemetryCollector{
 		ObjectMeta: metav1.ObjectMeta{
 			Annotations: map[string]string{
 				"test.bar.io":  "foo",
+				"test.otel.io": "true",
 				"test.io/port": "1234",
 				"test.io/path": "/test",
 			},
@@ -175,11 +200,12 @@ func TestAnnotationsFilter(t *testing.T) {
 	}
 
 	// This requires the filter to be in regex match form and not the other simpler wildcard one.
-	annotations, err := Annotations(otelcol, []string{".*\\.bar\\.io"})
+	annotations, err := Annotations(otelcol, []string{".bar.io", "otel.io"})
 
 	// verify
 	require.NoError(t, err)
 	assert.Len(t, annotations, 6)
 	assert.NotContains(t, annotations, "test.bar.io")
+	assert.NotContains(t, annotations, "test.otel.io")
 	assert.Equal(t, "1234", annotations["test.io/port"])
 }

internal/manifests/manifestutils/labels.go

@@ -15,7 +15,6 @@
 package manifestutils
 
 import (
-	"regexp"
 	"strings"
 
 	"github.com/open-telemetry/opentelemetry-operator/apis/v1beta1"
@@ -26,8 +25,9 @@ import (
 
 func IsFilteredSet(sourceSet string, filterSet []string) bool {
 	for _, pattern := range filterSet {
-		match, _ := regexp.MatchString(pattern, sourceSet)
-		return match
+		if strings.Contains(sourceSet, pattern) {
+			return true
+		}
 	}
 	return false
 }

internal/manifests/manifestutils/labels_test.go

@@ -147,7 +147,7 @@ func TestLabelsFilter(t *testing.T) {
 	}
 
 	// This requires the filter to be in regex match form and not the other simpler wildcard one.
-	labels := Labels(otelcol.ObjectMeta, collectorName, otelcol.Spec.Image, "opentelemetry-collector", []string{".*.bar.io"})
+	labels := Labels(otelcol.ObjectMeta, collectorName, otelcol.Spec.Image, "opentelemetry-collector", []string{".bar.io"})
 
 	// verify
 	assert.Len(t, labels, 7)

internal/manifests/opampbridge/deployment_test.go

@@ -237,7 +237,7 @@ func TestDeploymentFilterLabels(t *testing.T) {
 		Spec: v1alpha1.OpAMPBridgeSpec{},
 	}
 
-	cfg := config.New(config.WithLabelFilters([]string{"foo*", "app.*.bar"}))
+	cfg := config.New(config.WithLabelFilters([]string{"foo", ".bar"}))
 
 	params := manifests.Params{
 		Config:      cfg,
@@ -268,7 +268,7 @@ func TestDeploymentFilterAnnotations(t *testing.T) {
 		Spec: v1alpha1.OpAMPBridgeSpec{},
 	}
 
-	cfg := config.New(config.WithAnnotationFilters([]string{"foo*", "app.*.bar"}))
+	cfg := config.New(config.WithAnnotationFilters([]string{"foo", ".bar"}))
 
 	params := manifests.Params{
 		Config:      cfg,

main.go

@@ -150,8 +150,8 @@ func main() {
 	stringFlagOrEnv(&autoInstrumentationGo, "auto-instrumentation-go-image", "RELATED_IMAGE_AUTO_INSTRUMENTATION_GO", fmt.Sprintf("ghcr.io/open-telemetry/opentelemetry-go-instrumentation/autoinstrumentation-go:%s", v.AutoInstrumentationGo), "The default OpenTelemetry Go instrumentation image. This image is used when no image is specified in the CustomResource.")
 	stringFlagOrEnv(&autoInstrumentationApacheHttpd, "auto-instrumentation-apache-httpd-image", "RELATED_IMAGE_AUTO_INSTRUMENTATION_APACHE_HTTPD", fmt.Sprintf("ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-apache-httpd:%s", v.AutoInstrumentationApacheHttpd), "The default OpenTelemetry Apache HTTPD instrumentation image. This image is used when no image is specified in the CustomResource.")
 	stringFlagOrEnv(&autoInstrumentationNginx, "auto-instrumentation-nginx-image", "RELATED_IMAGE_AUTO_INSTRUMENTATION_NGINX", fmt.Sprintf("ghcr.io/open-telemetry/opentelemetry-operator/autoinstrumentation-apache-httpd:%s", v.AutoInstrumentationNginx), "The default OpenTelemetry Nginx instrumentation image. This image is used when no image is specified in the CustomResource.")
-	pflag.StringArrayVar(&labelsFilter, "label", []string{}, "Labels to filter away from propagating onto deploys")
-	pflag.StringArrayVar(&annotationsFilter, "annotations-filter", []string{}, "Annotations to filter away from propagating onto deploys. It should be a string array containing patterns, which are literal strings optionally containing a * wildcard character. Example: --annotations-filter=*filter.out will filter out annotations that looks like: annotation.filter.out: true")
+	pflag.StringArrayVar(&labelsFilter, "label", []string{}, "Labels to filter away from propagating onto deploys. It should be a string array containing patterns, which are literal strings. Example: --labels-filter=filter.out will filter out labels that looks like: label.filter.out: true")
+	pflag.StringArrayVar(&annotationsFilter, "annotations-filter", []string{}, "Annotations to filter away from propagating onto deploys. It should be a string array containing patterns, which are literal strings. Example: --annotations-filter=filter.out will filter out annotations that looks like: annotation.filter.out: true")
 	pflag.IntVar(&webhookPort, "webhook-port", 9443, "The port the webhook endpoint binds to.")
 	pflag.StringVar(&tlsOpt.minVersion, "tls-min-version", "VersionTLS12", "Minimum TLS version supported. Value must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants.")
 	pflag.StringSliceVar(&tlsOpt.cipherSuites, "tls-cipher-suites", nil, "Comma-separated list of cipher suites for the server. Values are from tls package constants (https://golang.org/pkg/crypto/tls/#pkg-constants). If omitted, the default Go cipher suites will be used")