Skip to content

Commit 407e59f

Browse files
[receiver/fluent_forward] rename to fluent_forward with deprecated alias fluentforward (#47930)
Part of #45339 Renames the `fluentforward` receiver type to `fluent_forward` to follow the snake_case naming convention from open-telemetry/opentelemetry-collector#14208. The previous type `fluentforward` is preserved as a deprecated alias via `xreceiver.WithDeprecatedTypeAlias`, so existing configs keep working with a deprecation warning at startup. Metric names and directory layout are unchanged. --------- Co-authored-by: Israel Blancas <iblancasa@gmail.com>
1 parent bfaa4cf commit 407e59f

14 files changed

Lines changed: 33 additions & 17 deletions

File tree

.chloggen/config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ components:
262262
- receiver/file_log
263263
- receiver/file_stats
264264
- receiver/flinkmetrics
265-
- receiver/fluentforward
265+
- receiver/fluent_forward
266266
- receiver/github
267267
- receiver/gitlab
268268
- receiver/googlecloudmonitoring
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
change_type: deprecation
2+
component: receiver/fluent_forward
3+
note: Rename receiver type from `fluentforward` to `fluent_forward`
4+
issues: [45339]
5+
subtext:
6+
change_logs: [user]

receiver/fluentforwardreceiver/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ This receiver runs a TCP server that accepts events via the
1818
[k8s]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-k8s
1919
<!-- end autogenerated section -->
2020

21+
> **Note:** The receiver type has been renamed from `fluentforward` to `fluent_forward` to follow the
22+
> snake_case naming convention. The old name `fluentforward` is preserved as a deprecated alias and
23+
> will continue to work, but a deprecation warning will be logged at startup. Please update your
24+
> configuration to use `fluent_forward:`.
25+
2126
This receiver:
2227

2328
- Does **not** support TLS or the handshake portion of the Forward protocol.
@@ -34,7 +39,7 @@ on port 8006:
3439

3540
```yaml
3641
receivers:
37-
fluentforward:
42+
fluent_forward:
3843
endpoint: 0.0.0.0:8006
3944
```
4045

receiver/fluentforwardreceiver/config_test.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@ import (
99

1010
"github.com/stretchr/testify/assert"
1111
"github.com/stretchr/testify/require"
12-
"go.opentelemetry.io/collector/component"
1312
"go.opentelemetry.io/collector/confmap/confmaptest"
1413
"go.opentelemetry.io/collector/confmap/xconfmap"
14+
15+
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/fluentforwardreceiver/internal/metadata"
1516
)
1617

1718
func TestLoadConfig(t *testing.T) {
@@ -21,7 +22,7 @@ func TestLoadConfig(t *testing.T) {
2122
factory := NewFactory()
2223
cfg := factory.CreateDefaultConfig()
2324

24-
sub, err := cm.Sub(component.MustNewID("fluentforward").String())
25+
sub, err := cm.Sub(metadata.Type.String())
2526
require.NoError(t, err)
2627
require.NoError(t, sub.Unmarshal(cfg))
2728

receiver/fluentforwardreceiver/documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[comment]: <> (Code generated by mdatagen. DO NOT EDIT.)
22

3-
# fluentforward
3+
# fluent_forward
44

55
## Internal Telemetry
66

receiver/fluentforwardreceiver/factory.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,18 @@ import (
99
"go.opentelemetry.io/collector/component"
1010
"go.opentelemetry.io/collector/consumer"
1111
"go.opentelemetry.io/collector/receiver"
12+
"go.opentelemetry.io/collector/receiver/xreceiver"
1213

1314
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/fluentforwardreceiver/internal/metadata"
1415
)
1516

1617
// NewFactory return a new receiver.Factory for fluentd forwarder.
1718
func NewFactory() receiver.Factory {
18-
return receiver.NewFactory(
19+
return xreceiver.NewFactory(
1920
metadata.Type,
2021
createDefaultConfig,
21-
receiver.WithLogs(createLogsReceiver, metadata.LogsStability))
22+
xreceiver.WithLogs(createLogsReceiver, metadata.LogsStability),
23+
xreceiver.WithDeprecatedTypeAlias(metadata.DeprecatedType))
2224
}
2325

2426
func createDefaultConfig() component.Config {

receiver/fluentforwardreceiver/generated_component_test.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

receiver/fluentforwardreceiver/go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ require (
1616
go.opentelemetry.io/collector/receiver v1.56.1-0.20260424074859-d91c0edd1da5
1717
go.opentelemetry.io/collector/receiver/receiverhelper v0.150.1-0.20260424074859-d91c0edd1da5
1818
go.opentelemetry.io/collector/receiver/receivertest v0.150.1-0.20260424074859-d91c0edd1da5
19+
go.opentelemetry.io/collector/receiver/xreceiver v0.150.1-0.20260424074859-d91c0edd1da5
1920
go.opentelemetry.io/otel/metric v1.43.0
2021
go.opentelemetry.io/otel/sdk/metric v1.43.0
2122
go.opentelemetry.io/otel/trace v1.43.0
@@ -52,7 +53,6 @@ require (
5253
go.opentelemetry.io/collector/pdata/xpdata v0.150.1-0.20260424074859-d91c0edd1da5 // indirect
5354
go.opentelemetry.io/collector/pipeline v1.56.1-0.20260424074859-d91c0edd1da5 // indirect
5455
go.opentelemetry.io/collector/pipeline/xpipeline v0.150.1-0.20260424074859-d91c0edd1da5 // indirect
55-
go.opentelemetry.io/collector/receiver/xreceiver v0.150.1-0.20260424074859-d91c0edd1da5 // indirect
5656
go.opentelemetry.io/otel v1.43.0 // indirect
5757
go.opentelemetry.io/otel/sdk v1.43.0 // indirect
5858
go.uber.org/multierr v1.11.0 // indirect

receiver/fluentforwardreceiver/internal/metadata/generated_status.go

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

receiver/fluentforwardreceiver/internal/metadatatest/generated_telemetrytest.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)