[receiver/udplog] rename to udp_log with deprecated alias udplog (#47370)

andrzej-stencel · web-flow · commit 814df624a171 · 2026-04-03T23:57:09.000+02:00
Part of: - #45339 Assisted-by: Cursor with Composer v2
diff --git a/.chloggen/config.yaml b/.chloggen/config.yaml
@@ -331,7 +331,7 @@ components:
     - receiver/tcpcheck
     - receiver/tcplog
     - receiver/tlscheck
-    - receiver/udplog
+    - receiver/udp_log
     - receiver/vcenter
     - receiver/vcr
     - receiver/wavefront
diff --git a/.chloggen/rename-udp-log-receiver.yaml b/.chloggen/rename-udp-log-receiver.yaml
@@ -0,0 +1,13 @@
+# Use this changelog template to create an entry for release notes.
+
+change_type: deprecation
+
+component: receiver/udp_log
+
+note: Rename `udplog` receiver to `udp_log` with deprecated alias `udplog`
+
+issues: [45339]
+
+subtext:
+
+change_logs: [user]
diff --git a/.schemagen.yaml b/.schemagen.yaml
@@ -35,7 +35,7 @@ componentOverrides:
     configName: 'SysLogConfig'
   receiver/tcplog:
     configName: 'TCPLogConfig'
-  receiver/udplog:
+  receiver/udp_log:
     configName: 'UDPLogConfig'
   receiver/windowseventlog:
     configName: 'WindowsLogConfig'
diff --git a/receiver/udplogreceiver/README.md b/receiver/udplogreceiver/README.md
@@ -1,7 +1,7 @@
 <!-- status autogenerated section -->
-# UDP Receiver
+# UDP Log Receiver
 
-The UDP Receiver receives logs over UDP.
+The UDP Log Receiver receives logs over UDP.
 
 | Status        |           |
 | ------------- |-----------|
@@ -45,7 +45,7 @@ Many parsers operators can be configured to embed certain followup operations su
 
 ### `multiline` configuration
 
-If set, the `multiline` configuration block instructs the `udplog` receiver to split log entries on a pattern other than newlines.
+If set, the `multiline` configuration block instructs the `udp_log` receiver to split log entries on a pattern other than newlines.
 
 **note** If `multiline` is not set at all, it won't split log entries at all. Every UDP packet is going to be treated as log.
 **note** `multiline` detection works per UDP packet due to protocol limitations.
@@ -90,7 +90,14 @@ Configuration:
 
 ```yaml
 receivers:
-  udplog:
+  udp_log:
     listen_address: "0.0.0.0:54525"
 ```
 
+The deprecated component type `udplog` is still accepted:
+
+```yaml
+receivers:
+  udplog:
+    listen_address: "0.0.0.0:54525"
+```
diff --git a/receiver/udplogreceiver/config.schema.yaml b/receiver/udplogreceiver/config.schema.yaml
@@ -1,4 +1,4 @@
-description: UDPLogConfig defines configuration for the udp receiver
+description: UDPLogConfig defines configuration for the udp_log receiver
 type: object
 allOf:
   - $ref: /pkg/stanza/operator/input/udp.config
diff --git a/receiver/udplogreceiver/generated_component_test.go b/receiver/udplogreceiver/generated_component_test.go
diff --git a/receiver/udplogreceiver/go.mod b/receiver/udplogreceiver/go.mod
@@ -20,6 +20,7 @@ require (
 	go.opentelemetry.io/collector/consumer/consumertest v0.149.1-0.20260402195938-76ede073ee8e
 	go.opentelemetry.io/collector/pdata v1.55.1-0.20260402195938-76ede073ee8e
 	go.opentelemetry.io/collector/receiver/receivertest v0.149.1-0.20260402195938-76ede073ee8e
+	go.opentelemetry.io/collector/receiver/xreceiver v0.149.1-0.20260402195938-76ede073ee8e
 	go.uber.org/zap v1.27.1
 )
 
@@ -61,7 +62,6 @@ require (
 	go.opentelemetry.io/collector/pipeline v1.55.1-0.20260402195938-76ede073ee8e // indirect
 	go.opentelemetry.io/collector/pipeline/xpipeline v0.149.1-0.20260402195938-76ede073ee8e // indirect
 	go.opentelemetry.io/collector/receiver/receiverhelper v0.149.1-0.20260402195938-76ede073ee8e // indirect
-	go.opentelemetry.io/collector/receiver/xreceiver v0.149.1-0.20260402195938-76ede073ee8e // indirect
 	go.opentelemetry.io/otel v1.42.0 // indirect
 	go.opentelemetry.io/otel/sdk v1.42.0 // indirect
 	go.opentelemetry.io/otel/sdk/metric v1.42.0 // indirect
diff --git a/receiver/udplogreceiver/internal/metadata/generated_status.go b/receiver/udplogreceiver/internal/metadata/generated_status.go
diff --git a/receiver/udplogreceiver/metadata.yaml b/receiver/udplogreceiver/metadata.yaml
@@ -1,7 +1,8 @@
-display_name: UDP Receiver
-type: udplog
+display_name: UDP Log Receiver
+type: udp_log
+deprecated_type: udplog
 
-description: The UDP Receiver receives logs over UDP.
+description: The UDP Log Receiver receives logs over UDP.
 
 status:
   class: receiver
diff --git a/receiver/udplogreceiver/testdata/config.yaml b/receiver/udplogreceiver/testdata/config.yaml
@@ -1,2 +1,2 @@
-udplog:
+udp_log:
   listen_address: "127.0.0.1:29018"
diff --git a/receiver/udplogreceiver/udp.go b/receiver/udplogreceiver/udp.go
@@ -6,16 +6,19 @@ package udplogreceiver // import "github.com/open-telemetry/opentelemetry-collec
 import (
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/receiver"
+	"go.opentelemetry.io/collector/receiver/xreceiver"
 
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/adapter"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/input/udp"
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/udplogreceiver/internal/metadata"
 )
 
-// NewFactory creates a factory for udp receiver
+// NewFactory creates a factory for udp_log receiver
 func NewFactory() receiver.Factory {
-	return adapter.NewFactory(ReceiverType{}, metadata.LogsStability)
+	return adapter.NewFactory(ReceiverType{}, metadata.LogsStability,
+		xreceiver.WithDeprecatedTypeAlias(metadata.DeprecatedType),
+	)
 }
 
 // ReceiverType implements adapter.LogReceiverType
@@ -42,7 +45,7 @@ func (ReceiverType) BaseConfig(cfg component.Config) adapter.BaseConfig {
 	return cfg.(*UDPLogConfig).BaseConfig
 }
 
-// UDPLogConfig defines configuration for the udp receiver
+// UDPLogConfig defines configuration for the udp_log receiver
 type UDPLogConfig struct {
 	InputConfig        udp.Config `mapstructure:",squash"`
 	adapter.BaseConfig `mapstructure:",squash"`
diff --git a/receiver/udplogreceiver/udp_test.go b/receiver/udplogreceiver/udp_test.go
@@ -87,7 +87,7 @@ func TestLoadConfig(t *testing.T) {
 	factory := NewFactory()
 	cfg := factory.CreateDefaultConfig()
 
-	sub, err := cm.Sub("udplog")
+	sub, err := cm.Sub("udp_log")
 	require.NoError(t, err)
 	require.NoError(t, sub.Unmarshal(cfg))
 
diff --git a/reports/distributions/contrib.yaml b/reports/distributions/contrib.yaml
@@ -227,7 +227,7 @@ components:
         - tcpcheck
         - tcplog
         - tlscheck
-        - udplog
+        - udp_log
         - vcenter
         - wavefront
         - webhookevent

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-description: UDPLogConfig defines configuration for the udp receiver`
	`1`	`+description: UDPLogConfig defines configuration for the udp_log receiver`
`2`	`2`	`type: object`
`3`	`3`	`allOf:`
`4`	`4`	`- $ref: /pkg/stanza/operator/input/udp.config`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-udplog:`
	`1`	`+udp_log:`
`2`	`2`	`listen_address: "127.0.0.1:29018"`