use otel_annotations

Author: zeitlinger

.chloggen/operator-resource-attributes.yaml

@@ -11,5 +11,5 @@ subtext: |
   
   If you are using the file log receiver, you can now create the same resource attributes as traces (via OTLP) received
   from an application instrumented with the OpenTelemetry Operator -
-  simply by adding the `extract: { automatic_attributes: { enabled: true }}` configuration to the `k8sattributesprocessor` processor.
+  simply by adding the `extract: { otel_annotations: true }` configuration to the `k8sattributesprocessor` processor.
   See the [documentation](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/k8sattributesprocessor/README.md#config-example) for more details.

processor/k8sattributesprocessor/README.md

@@ -275,10 +275,8 @@ k8sattributes/2:
       - tag_name: app.label.component
         key: app.kubernetes.io/component
         from: pod
-    automatic_attributes:
-      # Apply the operator rules - see https://github.com/open-telemetry/semantic-conventions/blob/main/docs/non-normative/k8s-attributes.md
-      enabled: true
-      annotation_prefixes: ["foo/"] # default is ["resource.opentelemetry.io/"] - use empty list to disable
+    # Apply the operator rules - see https://github.com/open-telemetry/semantic-conventions/blob/main/docs/non-normative/k8s-attributes.md
+    otel_annotations: true # default is false - use true to enable
   pod_association:
     - sources:
         # This rule associates all resources containing the 'k8s.pod.ip' attribute with the matching pods. If this attribute is not present in the resource, this rule will not be able to find the matching pod.

processor/k8sattributesprocessor/config.go

@@ -167,7 +167,9 @@ type ExtractConfig struct {
 	// documentation for more details.
 	Labels []FieldExtractConfig `mapstructure:"labels"`
 
-	AutomaticRules kube.AutomaticRules `mapstructure:"automatic_attributes"`
+	// OtelAnnotations extracts all pod annotations with the prefix "resource.opentelemetry.io" as resource attributes
+	// E.g. "resource.opentelemetry.io/foo" becomes "foo"
+	OtelAnnotations bool `mapstructure:"otel_annotations"`
 }
 
 // FieldExtractConfig allows specifying an extraction rule to extract a resource attribute from pod (or namespace)

processor/k8sattributesprocessor/factory.go

@@ -192,7 +192,7 @@ func createProcessorOpts(cfg component.Config) []option {
 	opts = append(opts, withExtractMetadata(oCfg.Extract.Metadata...))
 	opts = append(opts, withExtractLabels(oCfg.Extract.Labels...))
 	opts = append(opts, withExtractAnnotations(oCfg.Extract.Annotations...))
-	opts = append(opts, withAutomaticRules(oCfg.Extract.AutomaticRules))
+	opts = append(opts, withOtelAnnotations(oCfg.Extract.OtelAnnotations))
 
 	// filters
 	opts = append(opts, withFilterNode(oCfg.Filter.Node, oCfg.Filter.NodeFromEnvVar))

processor/k8sattributesprocessor/internal/kube/automatic.go

@@ -12,7 +12,9 @@ type AutomaticRules struct {
 	AnnotationPrefixes []string `mapstructure:"annotation_prefixes"`
 }
 
-const DefaultAnnotationPrefix = "resource.opentelemetry.io/"
+const (
+	DefaultAnnotationPrefix = "resource.opentelemetry.io/"
+)
 
 func AutomaticAnnotationRule(prefix string) FieldExtractionRule {
 	return FieldExtractionRule{

processor/k8sattributesprocessor/options.go

@@ -198,17 +198,10 @@ func withExtractMetadata(fields ...string) option {
 	}
 }
 
-func withAutomaticRules(rules kube.AutomaticRules) option {
+func withOtelAnnotations(enabled bool) option {
 	return func(p *kubernetesprocessor) error {
-		if rules.Enabled {
-			p.rules.AutomaticRules = rules
-			prefixes := rules.AnnotationPrefixes
-			if len(prefixes) == 0 {
-				prefixes = []string{kube.DefaultAnnotationPrefix}
-			}
-			for _, prefix := range prefixes {
-				p.rules.Annotations = append(p.rules.Annotations, kube.AutomaticAnnotationRule(prefix))
-			}
+		if enabled {
+			p.rules.Annotations = append(p.rules.Annotations, kube.AutomaticAnnotationRule(kube.DefaultAnnotationPrefix))
 		}
 		return nil
 	}

processor/k8sattributesprocessor/options_test.go

@@ -747,21 +747,18 @@ func TestWithExcludes(t *testing.T) {
 	}
 }
 
-func Test_withAutomaticRules(t *testing.T) {
+func TestOtelAnnotations(t *testing.T) {
 	tests := []struct {
 		name            string
-		rules           kube.AutomaticRules
+		enabled         bool
 		wantAnnotations []kube.FieldExtractionRule
 	}{
 		{
-			name:  "no automatic rules",
-			rules: kube.AutomaticRules{},
+			name: "no automatic rules",
 		},
 		{
-			name: "default automatic rules",
-			rules: kube.AutomaticRules{
-				Enabled: true,
-			},
+			name:    "default automatic rules",
+			enabled: true,
 			wantAnnotations: []kube.FieldExtractionRule{
 				{
 					Name:                 "$1",
@@ -771,26 +768,11 @@ func Test_withAutomaticRules(t *testing.T) {
 				},
 			},
 		},
-		{
-			name: "custom automatic rules",
-			rules: kube.AutomaticRules{
-				Enabled:            true,
-				AnnotationPrefixes: []string{"custom.prefix/"},
-			},
-			wantAnnotations: []kube.FieldExtractionRule{
-				{
-					Name:                 "$1",
-					KeyRegex:             regexp.MustCompile(`^custom\.prefix/(.+)$`),
-					HasKeyRegexReference: true,
-					From:                 kube.MetadataFromPod,
-				},
-			},
-		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			p := kubernetesprocessor{}
-			rules := withAutomaticRules(tt.rules)
+			rules := withOtelAnnotations(tt.enabled)
 			err := rules(&p)
 			assert.NoError(t, err)
 			assert.Equal(t, tt.wantAnnotations, p.rules.Annotations)