Skip to content

Commit 3873c96

Browse files
[receiver/tcplog] rename to tcp_log with deprecated alias tcplog (#47369)
Part of: - #45339 Assisted-by: Cursor with Composer v2
1 parent 814df62 commit 3873c96

File tree

13 files changed

+47
-21
lines changed

13 files changed

+47
-21
lines changed

.chloggen/config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -328,8 +328,8 @@ components:
328328
- receiver/stef
329329
- receiver/syslog
330330
- receiver/systemd
331+
- receiver/tcp_log
331332
- receiver/tcpcheck
332-
- receiver/tcplog
333333
- receiver/tlscheck
334334
- receiver/udp_log
335335
- receiver/vcenter
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
change_type: deprecation
4+
5+
component: receiver/tcp_log
6+
7+
note: Rename `tcplog` receiver to `tcp_log` with deprecated alias `tcplog`
8+
9+
issues: [45339]
10+
11+
subtext:
12+
13+
change_logs: [user]

.schemagen.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ componentOverrides:
3333
configName: 'JournaldConfig'
3434
receiver/syslog:
3535
configName: 'SysLogConfig'
36-
receiver/tcplog:
36+
receiver/tcp_log:
3737
configName: 'TCPLogConfig'
3838
receiver/udp_log:
3939
configName: 'UDPLogConfig'

receiver/tcplogreceiver/README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- status autogenerated section -->
2-
# TCP Receiver
2+
# TCP Log Receiver
33

4-
The TCP Receiver receives logs over TCP.
4+
The TCP Log Receiver receives logs over TCP.
55

66
| Status | |
77
| ------------- |-----------|
@@ -37,7 +37,7 @@ The TCP Receiver receives logs over TCP.
3737

3838
### TLS Configuration
3939

40-
The `tcplog` receiver supports TLS, disabled by default.
40+
The `tcp_log` receiver supports TLS, disabled by default.
4141
config more detail [opentelemetry-collector#configtls](https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/configtls#tls-configuration-settings).
4242

4343
| Field | Default | Description |
@@ -62,7 +62,7 @@ Many parsers operators can be configured to embed certain followup operations su
6262

6363
#### `multiline` configuration
6464

65-
If set, the `multiline` configuration block instructs the `tcplog` receiver to split log entries on a pattern other than newlines.
65+
If set, the `multiline` configuration block instructs the `tcp_log` receiver to split log entries on a pattern other than newlines.
6666

6767
The `multiline` configuration block must contain exactly one of `line_start_pattern` or `line_end_pattern`. These are regex patterns that
6868
match either the beginning of a new log entry, or the end of a log entry.
@@ -90,6 +90,14 @@ for other encodings available.
9090

9191
Configuration:
9292

93+
```yaml
94+
receivers:
95+
tcp_log:
96+
listen_address: "0.0.0.0:54525"
97+
```
98+
99+
The deprecated component type `tcplog` is still accepted:
100+
93101
```yaml
94102
receivers:
95103
tcplog:
@@ -102,7 +110,7 @@ Following configuration incorporates TLS, multiline config, operators and retry
102110

103111
```yaml
104112
receivers:
105-
tcplog:
113+
tcp_log:
106114
listen_address: "0.0.0.0:54525"
107115
max_log_size: 2MiB
108116
one_log_per_packet: false

receiver/tcplogreceiver/config.schema.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
description: TCPLogConfig defines configuration for the tcp receiver
1+
description: TCPLogConfig defines configuration for the tcp_log receiver
22
type: object
33
allOf:
44
- $ref: /pkg/stanza/operator/input/tcp.config

receiver/tcplogreceiver/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/tcplogreceiver/go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ require (
2121
go.opentelemetry.io/collector/consumer/consumertest v0.149.1-0.20260402195938-76ede073ee8e
2222
go.opentelemetry.io/collector/pdata v1.55.1-0.20260402195938-76ede073ee8e
2323
go.opentelemetry.io/collector/receiver/receivertest v0.149.1-0.20260402195938-76ede073ee8e
24+
go.opentelemetry.io/collector/receiver/xreceiver v0.149.1-0.20260402195938-76ede073ee8e
2425
go.uber.org/zap v1.27.1
2526
)
2627

@@ -67,7 +68,6 @@ require (
6768
go.opentelemetry.io/collector/pipeline v1.55.1-0.20260402195938-76ede073ee8e // indirect
6869
go.opentelemetry.io/collector/pipeline/xpipeline v0.149.1-0.20260402195938-76ede073ee8e // indirect
6970
go.opentelemetry.io/collector/receiver/receiverhelper v0.149.1-0.20260402195938-76ede073ee8e // indirect
70-
go.opentelemetry.io/collector/receiver/xreceiver v0.149.1-0.20260402195938-76ede073ee8e // indirect
7171
go.opentelemetry.io/otel v1.42.0 // indirect
7272
go.opentelemetry.io/otel/sdk v1.42.0 // indirect
7373
go.opentelemetry.io/otel/sdk/metric v1.42.0 // indirect

receiver/tcplogreceiver/internal/metadata/generated_status.go

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

receiver/tcplogreceiver/metadata.yaml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
display_name: TCP Receiver
2-
type: tcplog
1+
display_name: TCP Log Receiver
2+
type: tcp_log
3+
deprecated_type: tcplog
34

4-
description: The TCP Receiver receives logs over TCP.
5+
description: The TCP Log Receiver receives logs over TCP.
56

67
status:
78
class: receiver

receiver/tcplogreceiver/tcp.go

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ package tcplogreceiver // import "github.com/open-telemetry/opentelemetry-collec
66
import (
77
"go.opentelemetry.io/collector/component"
88
"go.opentelemetry.io/collector/receiver"
9+
"go.opentelemetry.io/collector/receiver/xreceiver"
910

1011
"github.com/open-telemetry/opentelemetry-collector-contrib/internal/coreinternal/consumerretry"
1112
"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/adapter"
@@ -14,9 +15,11 @@ import (
1415
"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/tcplogreceiver/internal/metadata"
1516
)
1617

17-
// NewFactory creates a factory for tcp receiver
18+
// NewFactory creates a factory for tcp_log receiver
1819
func NewFactory() receiver.Factory {
19-
return adapter.NewFactory(ReceiverType{}, metadata.LogsStability)
20+
return adapter.NewFactory(ReceiverType{}, metadata.LogsStability,
21+
xreceiver.WithDeprecatedTypeAlias(metadata.DeprecatedType),
22+
)
2023
}
2124

2225
// ReceiverType implements adapter.LogReceiverType
@@ -44,7 +47,7 @@ func (ReceiverType) BaseConfig(cfg component.Config) adapter.BaseConfig {
4447
return cfg.(*TCPLogConfig).BaseConfig
4548
}
4649

47-
// TCPLogConfig defines configuration for the tcp receiver
50+
// TCPLogConfig defines configuration for the tcp_log receiver
4851
type TCPLogConfig struct {
4952
InputConfig tcp.Config `mapstructure:",squash"`
5053
adapter.BaseConfig `mapstructure:",squash"`

0 commit comments

Comments
 (0)