feat: Add missing configuration parameter deployment_name_from_replicaset to k8sattributes processor

[dehaansa]

Brief description of Pull Request

Add deployment_name_from_replicaset attribute to k8sattributes processor supporting extraction of deployment name from replica set.

Pull Request Details

Issue(s) fixed by this Pull Request

Notes to the Reviewer

PR Checklist

• Documentation added
• Tests updated
• Config converters updated

[github-actions]

🔍 Dependency Review

github.com/open-telemetry/opentelemetry-collector-contrib/processor/k8sattributesprocessor grafana/opentelemetry-collector-contrib@73458b01ab23 (replace) -> v0.139.0 (upstream)

Status: ⚠️ Needs Review

Summary:

• The explicit replace to Grafana’s fork is removed, switching back to upstream k8sattributesprocessor at v0.139.0.
• The fork was previously used for compatibility with k8s.io/client-go v0.34.1. Moving to upstream implies upstream now supports this; please verify in your CI/build environment.
• Upstream adds a new extraction option deployment_name_from_replicaset. To expose it in your config API and to pass it through to the processor, minor code changes are required (already included in this PR).

Required code updates:

• Expose the new boolean option in your component’s config schema and pass it through to the underlying processor config.

Suggested diffs (matching the changes already in this PR):

• Add the new field to your ExtractConfig and include it in the map:

--- a/internal/component/otelcol/processor/k8sattributes/types.go
+++ b/internal/component/otelcol/processor/k8sattributes/types.go
@@ -17,15 +17,17 @@ func (args FieldExtractConfig) convert() map[string]interface{} {
 }
 
 type ExtractConfig struct {
-	Metadata        []string             `alloy:"metadata,attr,optional"`
-	Annotations     []FieldExtractConfig `alloy:"annotation,block,optional"`
-	Labels          []FieldExtractConfig `alloy:"label,block,optional"`
-	OtelAnnotations bool                 `alloy:"otel_annotations,attr,optional"`
+	Metadata                     []string             `alloy:"metadata,attr,optional"`
+	Annotations                  []FieldExtractConfig `alloy:"annotation,block,optional"`
+	Labels                       []FieldExtractConfig `alloy:"label,block,optional"`
+	OtelAnnotations              bool                 `alloy:"otel_annotations,attr,optional"`
+	DeploymentNameFromReplicaSet bool                 `alloy:"deployment_name_from_replicaset,attr,optional"`
 }
 
 func (args ExtractConfig) convert() map[string]interface{} {
   ...
 	return map[string]interface{}{
-		"metadata":         args.Metadata,
-		"annotations":      annotations,
-		"labels":           labels,
-		"otel_annotations": args.OtelAnnotations,
+		"metadata":                        args.Metadata,
+		"annotations":                     annotations,
+		"labels":                          labels,
+		"otel_annotations":                args.OtelAnnotations,
+		"deployment_name_from_replicaset": args.DeploymentNameFromReplicaSet,
 	}
 }

• Thread the new field through your otelcol converter:

--- a/internal/converter/internal/otelcolconvert/converter_k8sattributesprocessor.go
+++ b/internal/converter/internal/otelcolconvert/converter_k8sattributesprocessor.go
@@ -55,10 +55,11 @@ func toK8SAttributesProcessor(state *State, id componentstatus.InstanceID, cfg *
 		AuthType:    string(cfg.AuthType),
 		Passthrough: cfg.Passthrough,
 		ExtractConfig: k8sattributes.ExtractConfig{
-			Metadata:        cfg.Extract.Metadata,
-			Annotations:     toFilterExtract(cfg.Extract.Annotations),
-			Labels:          toFilterExtract(cfg.Extract.Labels),
-			OtelAnnotations: cfg.Extract.OtelAnnotations,
+			Metadata:                     cfg.Extract.Metadata,
+			Annotations:                  toFilterExtract(cfg.Extract.Annotations),
+			Labels:                       toFilterExtract(cfg.Extract.Labels),
+			OtelAnnotations:              cfg.Extract.OtelAnnotations,
+			DeploymentNameFromReplicaSet: cfg.Extract.DeploymentNameFromReplicaSet,
 		},
 		Filter: k8sattributes.FilterConfig{
 			Node:      cfg.Filter.Node,

• Update tests to cover the new option (as shown in this PR):

--- a/internal/component/otelcol/processor/k8sattributes/k8sattributes_test.go
+++ b/internal/component/otelcol/processor/k8sattributes/k8sattributes_test.go
@@ -26,6 +26,8 @@ func Test_Extract(t *testing.T) {
 				"k8s.job.name",
 				"k8s.node.name",
 			]
+
+			deployment_name_from_replicaset = true
 		}
 
 		output {
@@ -44,6 +46,8 @@ func Test_Extract(t *testing.T) {
 
 	extract := &otelObj.Extract
 	require.Equal(t, []string{"k8s.namespace.name", "k8s.job.name", "k8s.node.name"}, extract.Metadata)
+
+	require.True(t, extract.DeploymentNameFromReplicaSet)
 }

Operational considerations:

• The new flag disables watching ReplicaSet resources and derives deployment name by trimming the hash suffix from the ReplicaSet name. If you depend on live ReplicaSet metadata, ensure this behavioral change is intentional where the flag is enabled.
• Verify that upstream v0.139.0 is compatible with your k8s.io/client-go version (previous fork addressed this specifically).

Evidence:

• Replacement removal in go.mod:

-// Use Grafana's patched k8sattributesprocessor with support for k8s.io/client-go v0.34.1
-replace github.com/open-telemetry/opentelemetry-collector-contrib/processor/k8sattributesprocessor => github.com/grafana/opentelemetry-collector-contrib/processor/k8sattributesprocessor v0.0.0-20251021125353-73458b01ab23

• Upstream module version now resolved in go.sum:

github.com/open-telemetry/opentelemetry-collector-contrib/processor/k8sattributesprocessor v0.139.0

• New config documented in your docs:
  • Added deployment_name_from_replicaset option and description.

Notes

• go.sum also reflects an update of github.com/open-telemetry/opentelemetry-collector-contrib/pkg/xk8stest to v0.139.0. This is a test helper and no go.mod require change is present; no code changes are expected unless you import it directly.

[github-actions]

💻 Deploy preview available (feat: add missing configuration parameter deployment_name_from_replicaset to k8sattributes processor):

• https://deploy-preview-alloy-5183-zb444pucvq-vp.a.run.app/docs/alloy/latest/

[kgeckhart]

Yay for one less replacement, did this happen because upstream was on a lower version that has since been upgraded?

[dehaansa]

Yup. Happened ~a couple months ago open-telemetry/opentelemetry-collector-contrib#43890

[github-actions]

💻 Deploy preview deleted (feat: Add missing configuration parameter deployment_name_from_replicaset to k8sattributes processor).