diff --git a/.chloggen/config.yaml b/.chloggen/config.yaml index 9a89c62f97ccb..c51a423fc6afa 100644 --- a/.chloggen/config.yaml +++ b/.chloggen/config.yaml @@ -328,8 +328,8 @@ components: - receiver/stef - receiver/syslog - receiver/systemd + - receiver/tcp_log - receiver/tcpcheck - - receiver/tcplog - receiver/tlscheck - receiver/udp_log - receiver/vcenter diff --git a/.chloggen/rename-tcp-log-receiver.yaml b/.chloggen/rename-tcp-log-receiver.yaml new file mode 100644 index 0000000000000..7acb3525a1e6d --- /dev/null +++ b/.chloggen/rename-tcp-log-receiver.yaml @@ -0,0 +1,13 @@ +# Use this changelog template to create an entry for release notes. + +change_type: deprecation + +component: receiver/tcp_log + +note: Rename `tcplog` receiver to `tcp_log` with deprecated alias `tcplog` + +issues: [45339] + +subtext: + +change_logs: [user] diff --git a/.schemagen.yaml b/.schemagen.yaml index f14d289c8bf18..8f89197354ee1 100644 --- a/.schemagen.yaml +++ b/.schemagen.yaml @@ -33,7 +33,7 @@ componentOverrides: configName: 'JournaldConfig' receiver/syslog: configName: 'SysLogConfig' - receiver/tcplog: + receiver/tcp_log: configName: 'TCPLogConfig' receiver/udp_log: configName: 'UDPLogConfig' diff --git a/receiver/tcplogreceiver/README.md b/receiver/tcplogreceiver/README.md index 3f98dc5634a8f..7fa6a428c6f1e 100644 --- a/receiver/tcplogreceiver/README.md +++ b/receiver/tcplogreceiver/README.md @@ -1,7 +1,7 @@ -# TCP Receiver +# TCP Log Receiver -The TCP Receiver receives logs over TCP. +The TCP Log Receiver receives logs over TCP. | Status | | | ------------- |-----------| @@ -37,7 +37,7 @@ The TCP Receiver receives logs over TCP. ### TLS Configuration -The `tcplog` receiver supports TLS, disabled by default. +The `tcp_log` receiver supports TLS, disabled by default. config more detail [opentelemetry-collector#configtls](https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/configtls#tls-configuration-settings). | Field | Default | Description | @@ -62,7 +62,7 @@ Many parsers operators can be configured to embed certain followup operations su #### `multiline` configuration -If set, the `multiline` configuration block instructs the `tcplog` receiver to split log entries on a pattern other than newlines. +If set, the `multiline` configuration block instructs the `tcp_log` receiver to split log entries on a pattern other than newlines. The `multiline` configuration block must contain exactly one of `line_start_pattern` or `line_end_pattern`. These are regex patterns that match either the beginning of a new log entry, or the end of a log entry. @@ -90,6 +90,14 @@ for other encodings available. Configuration: +```yaml +receivers: + tcp_log: + listen_address: "0.0.0.0:54525" +``` + +The deprecated component type `tcplog` is still accepted: + ```yaml receivers: tcplog: @@ -102,7 +110,7 @@ Following configuration incorporates TLS, multiline config, operators and retry ```yaml receivers: - tcplog: + tcp_log: listen_address: "0.0.0.0:54525" max_log_size: 2MiB one_log_per_packet: false diff --git a/receiver/tcplogreceiver/config.schema.yaml b/receiver/tcplogreceiver/config.schema.yaml index 6defcbdb6c83a..f0cafa2fa8dc1 100644 --- a/receiver/tcplogreceiver/config.schema.yaml +++ b/receiver/tcplogreceiver/config.schema.yaml @@ -1,4 +1,4 @@ -description: TCPLogConfig defines configuration for the tcp receiver +description: TCPLogConfig defines configuration for the tcp_log receiver type: object allOf: - $ref: /pkg/stanza/operator/input/tcp.config diff --git a/receiver/tcplogreceiver/generated_component_test.go b/receiver/tcplogreceiver/generated_component_test.go index 26a6ea2650401..39d9f0cafc370 100644 --- a/receiver/tcplogreceiver/generated_component_test.go +++ b/receiver/tcplogreceiver/generated_component_test.go @@ -15,7 +15,7 @@ import ( "go.opentelemetry.io/collector/receiver/receivertest" ) -var typ = component.MustNewType("tcplog") +var typ = component.MustNewType("tcp_log") func TestComponentFactoryType(t *testing.T) { require.Equal(t, typ, NewFactory().Type()) diff --git a/receiver/tcplogreceiver/go.mod b/receiver/tcplogreceiver/go.mod index 9c86bfe09b91f..f0567a4c6b118 100644 --- a/receiver/tcplogreceiver/go.mod +++ b/receiver/tcplogreceiver/go.mod @@ -21,6 +21,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 ) @@ -67,7 +68,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/tcplogreceiver/internal/metadata/generated_status.go b/receiver/tcplogreceiver/internal/metadata/generated_status.go index 6dd43436c97f7..2866d830f42f9 100644 --- a/receiver/tcplogreceiver/internal/metadata/generated_status.go +++ b/receiver/tcplogreceiver/internal/metadata/generated_status.go @@ -7,8 +7,9 @@ import ( ) var ( - Type = component.MustNewType("tcplog") - ScopeName = "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/tcplogreceiver" + Type = component.MustNewType("tcp_log") + DeprecatedType = component.MustNewType("tcplog") + ScopeName = "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/tcplogreceiver" ) const ( diff --git a/receiver/tcplogreceiver/metadata.yaml b/receiver/tcplogreceiver/metadata.yaml index a9449ae875be9..670c19f86e394 100644 --- a/receiver/tcplogreceiver/metadata.yaml +++ b/receiver/tcplogreceiver/metadata.yaml @@ -1,7 +1,8 @@ -display_name: TCP Receiver -type: tcplog +display_name: TCP Log Receiver +type: tcp_log +deprecated_type: tcplog -description: The TCP Receiver receives logs over TCP. +description: The TCP Log Receiver receives logs over TCP. status: class: receiver diff --git a/receiver/tcplogreceiver/tcp.go b/receiver/tcplogreceiver/tcp.go index 069592ae5e14c..f0834450ce3e5 100644 --- a/receiver/tcplogreceiver/tcp.go +++ b/receiver/tcplogreceiver/tcp.go @@ -6,6 +6,7 @@ package tcplogreceiver // 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/internal/coreinternal/consumerretry" "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/adapter" @@ -14,9 +15,11 @@ import ( "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/tcplogreceiver/internal/metadata" ) -// NewFactory creates a factory for tcp receiver +// NewFactory creates a factory for tcp_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 @@ -44,7 +47,7 @@ func (ReceiverType) BaseConfig(cfg component.Config) adapter.BaseConfig { return cfg.(*TCPLogConfig).BaseConfig } -// TCPLogConfig defines configuration for the tcp receiver +// TCPLogConfig defines configuration for the tcp_log receiver type TCPLogConfig struct { InputConfig tcp.Config `mapstructure:",squash"` adapter.BaseConfig `mapstructure:",squash"` diff --git a/receiver/tcplogreceiver/tcp_test.go b/receiver/tcplogreceiver/tcp_test.go index 75845f4b591c2..83c7124b15c17 100644 --- a/receiver/tcplogreceiver/tcp_test.go +++ b/receiver/tcplogreceiver/tcp_test.go @@ -70,7 +70,7 @@ func TestLoadConfig(t *testing.T) { factory := NewFactory() cfg := factory.CreateDefaultConfig() - sub, err := cm.Sub("tcplog") + sub, err := cm.Sub("tcp_log") require.NoError(t, err) require.NoError(t, sub.Unmarshal(cfg)) diff --git a/receiver/tcplogreceiver/testdata/config.yaml b/receiver/tcplogreceiver/testdata/config.yaml index deda710c13c05..0aa5cc9598205 100644 --- a/receiver/tcplogreceiver/testdata/config.yaml +++ b/receiver/tcplogreceiver/testdata/config.yaml @@ -1,4 +1,4 @@ -tcplog: +tcp_log: listen_address: "127.0.0.1:29018" retry_on_failure: enabled: false diff --git a/reports/distributions/contrib.yaml b/reports/distributions/contrib.yaml index b9307e55ab7c4..e37461ab64463 100644 --- a/reports/distributions/contrib.yaml +++ b/reports/distributions/contrib.yaml @@ -224,8 +224,8 @@ components: - stef - syslog - systemd + - tcp_log - tcpcheck - - tcplog - tlscheck - udp_log - vcenter