Skip to content

Commit f02d9cf

Browse files
[exporter/syslog][chore] use consts for network protocol names (#32379)
use consts for network protocol names, changes were suggested in #31202 (comment) **Testing:** unit tests, manual tests with syslog server --------- Co-authored-by: Alex Boten <[email protected]>
1 parent b3a906b commit f02d9cf

File tree

5 files changed

+13
-7
lines changed

5 files changed

+13
-7
lines changed

exporter/syslogexporter/config.go

+4-2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import (
77
"errors"
88
"strings"
99

10+
"go.opentelemetry.io/collector/config/confignet"
1011
"go.opentelemetry.io/collector/config/configretry"
1112
"go.opentelemetry.io/collector/config/configtls"
1213
"go.opentelemetry.io/collector/exporter/exporterhelper"
@@ -56,7 +57,8 @@ func (cfg *Config) Validate() error {
5657
invalidFields = append(invalidFields, errInvalidEndpoint)
5758
}
5859

59-
if strings.ToLower(cfg.Network) != "tcp" && strings.ToLower(cfg.Network) != "udp" {
60+
cfg.Network = strings.ToLower(cfg.Network)
61+
if cfg.Network != string(confignet.TransportTypeTCP) && cfg.Network != string(confignet.TransportTypeUDP) {
6062
invalidFields = append(invalidFields, errUnsupportedNetwork)
6163
}
6264

@@ -80,7 +82,7 @@ func (cfg *Config) Validate() error {
8082

8183
const (
8284
// Syslog Network
83-
DefaultNetwork = "tcp"
85+
DefaultNetwork = string(confignet.TransportTypeTCP)
8486
// Syslog Port
8587
DefaultPort = 514
8688
// Syslog Protocol

exporter/syslogexporter/exporter.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import (
99
"fmt"
1010
"strings"
1111

12+
"go.opentelemetry.io/collector/config/confignet"
1213
"go.opentelemetry.io/collector/consumer/consumererror"
1314
"go.opentelemetry.io/collector/exporter"
1415
"go.opentelemetry.io/collector/exporter/exporterhelper"
@@ -25,10 +26,8 @@ type syslogexporter struct {
2526
}
2627

2728
func initExporter(cfg *Config, createSettings exporter.CreateSettings) (*syslogexporter, error) {
28-
cfg.Network = strings.ToLower(cfg.Network)
29-
3029
var loadedTLSConfig *tls.Config
31-
if cfg.Network == "tcp" {
30+
if cfg.Network == string(confignet.TransportTypeTCP) {
3231
var err error
3332
loadedTLSConfig, err = cfg.TLSSetting.LoadTLSConfig(context.Background())
3433
if err != nil {
@@ -46,6 +45,7 @@ func initExporter(cfg *Config, createSettings exporter.CreateSettings) (*sysloge
4645
s.logger.Info("Syslog Exporter configured",
4746
zap.String("endpoint", cfg.Endpoint),
4847
zap.String("protocol", cfg.Protocol),
48+
zap.String("network", cfg.Network),
4949
zap.Int("port", cfg.Port),
5050
)
5151

@@ -74,7 +74,7 @@ func newLogsExporter(
7474
}
7575

7676
func (se *syslogexporter) pushLogsData(_ context.Context, logs plog.Logs) error {
77-
batchMessages := strings.ToLower(se.config.Network) == "tcp"
77+
batchMessages := se.config.Network == string(confignet.TransportTypeTCP)
7878
var err error
7979
if batchMessages {
8080
err = se.exportBatch(logs)

exporter/syslogexporter/go.mod

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ go 1.21.0
55
require (
66
github.com/stretchr/testify v1.9.0
77
go.opentelemetry.io/collector/component v0.99.0
8+
go.opentelemetry.io/collector/config/confignet v0.99.0
89
go.opentelemetry.io/collector/config/configretry v0.99.0
910
go.opentelemetry.io/collector/config/configtls v0.99.0
1011
go.opentelemetry.io/collector/exporter v0.99.0

exporter/syslogexporter/go.sum

+2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

exporter/syslogexporter/sender.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import (
1010
"strings"
1111
"sync"
1212

13+
"go.opentelemetry.io/collector/config/confignet"
1314
"go.uber.org/zap"
1415
)
1516

@@ -78,7 +79,7 @@ func (s *sender) dial() error {
7879
s.conn = nil
7980
}
8081
var err error
81-
if s.tlsConfig != nil && s.network == "tcp" {
82+
if s.tlsConfig != nil && s.network == string(confignet.TransportTypeTCP) {
8283
s.conn, err = tls.Dial(s.network, s.addr, s.tlsConfig)
8384
} else {
8485
s.conn, err = net.Dial(s.network, s.addr)

0 commit comments

Comments
 (0)