Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .chloggen/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
13 changes: 13 additions & 0 deletions .chloggen/rename-tcp-log-receiver.yaml
Original file line number Diff line number Diff line change
@@ -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]
2 changes: 1 addition & 1 deletion .schemagen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ componentOverrides:
configName: 'JournaldConfig'
receiver/syslog:
configName: 'SysLogConfig'
receiver/tcplog:
receiver/tcp_log:
configName: 'TCPLogConfig'
receiver/udp_log:
configName: 'UDPLogConfig'
Expand Down
18 changes: 13 additions & 5 deletions receiver/tcplogreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- status autogenerated section -->
# TCP Receiver
# TCP Log Receiver

The TCP Receiver receives logs over TCP.
The TCP Log Receiver receives logs over TCP.

| Status | |
| ------------- |-----------|
Expand Down Expand Up @@ -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 |
Expand All @@ -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.
Expand Down Expand Up @@ -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:
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion receiver/tcplogreceiver/config.schema.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion receiver/tcplogreceiver/generated_component_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion receiver/tcplogreceiver/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -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
)

Expand Down Expand Up @@ -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
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 4 additions & 3 deletions receiver/tcplogreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
9 changes: 6 additions & 3 deletions receiver/tcplogreceiver/tcp.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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
Expand Down Expand Up @@ -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"`
Expand Down
2 changes: 1 addition & 1 deletion receiver/tcplogreceiver/tcp_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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))

Expand Down
2 changes: 1 addition & 1 deletion receiver/tcplogreceiver/testdata/config.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
tcplog:
tcp_log:
listen_address: "127.0.0.1:29018"
retry_on_failure:
enabled: false
Expand Down
2 changes: 1 addition & 1 deletion reports/distributions/contrib.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -224,8 +224,8 @@ components:
- stef
- syslog
- systemd
- tcp_log
- tcpcheck
- tcplog
- tlscheck
- udp_log
- vcenter
Expand Down
Loading