Skip to content

Commit 003780f

Browse files
mackjmrmackjmr
authored
[chore] [exporter/logzio] Use NewDefaultClientConfig instead of manually creating struct (#35524)
**Description:** This PR makes usage of `NewDefaultClientConfig` instead of manually creating the confighttp.ClientConfig struct. **Link to tracking Issue:** #35457
1 parent 256e465 commit 003780f

File tree

5 files changed

+58
-75
lines changed

5 files changed

+58
-75
lines changed

‎exporter/logzioexporter/config_test.go

+22-37
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ import (
1313
"go.opentelemetry.io/collector/component"
1414
"go.opentelemetry.io/collector/config/configcompression"
1515
"go.opentelemetry.io/collector/config/confighttp"
16-
"go.opentelemetry.io/collector/config/configopaque"
1716
"go.opentelemetry.io/collector/config/configretry"
1817
"go.opentelemetry.io/collector/confmap/confmaptest"
1918
"go.opentelemetry.io/collector/exporter/exporterhelper"
@@ -40,15 +39,11 @@ func TestLoadConfig(t *testing.T) {
4039
expected.BackOffConfig.MaxInterval = 5 * time.Second
4140
expected.QueueSettings = exporterhelper.NewDefaultQueueConfig()
4241
expected.QueueSettings.Enabled = false
43-
expected.ClientConfig = confighttp.ClientConfig{
44-
Endpoint: "",
45-
Timeout: 30 * time.Second,
46-
Headers: map[string]configopaque.String{},
47-
// Default to gzip compression
48-
Compression: configcompression.TypeGzip,
49-
// We almost read 0 bytes, so no need to tune ReadBufferSize.
50-
WriteBufferSize: 512 * 1024,
51-
}
42+
clientConfig := confighttp.NewDefaultClientConfig()
43+
clientConfig.Timeout = 30 * time.Second
44+
clientConfig.Compression = configcompression.TypeGzip
45+
clientConfig.WriteBufferSize = 512 * 1024
46+
expected.ClientConfig = clientConfig
5247
assert.Equal(t, expected, cfg)
5348
}
5449

@@ -67,19 +62,19 @@ func TestDefaultLoadConfig(t *testing.T) {
6762
}
6863
expected.BackOffConfig = configretry.NewDefaultBackOffConfig()
6964
expected.QueueSettings = exporterhelper.NewDefaultQueueConfig()
70-
expected.ClientConfig = confighttp.ClientConfig{
71-
Endpoint: "",
72-
Timeout: 30 * time.Second,
73-
Headers: map[string]configopaque.String{},
74-
// Default to gzip compression
75-
Compression: configcompression.TypeGzip,
76-
// We almost read 0 bytes, so no need to tune ReadBufferSize.
77-
WriteBufferSize: 512 * 1024,
78-
}
65+
clientConfig := confighttp.NewDefaultClientConfig()
66+
clientConfig.Timeout = 30 * time.Second
67+
clientConfig.Compression = configcompression.TypeGzip
68+
clientConfig.WriteBufferSize = 512 * 1024
69+
expected.ClientConfig = clientConfig
7970
assert.Equal(t, expected, cfg)
8071
}
8172

8273
func TestCheckAndWarnDeprecatedOptions(t *testing.T) {
74+
clientConfig := confighttp.NewDefaultClientConfig()
75+
clientConfig.Timeout = 10 * time.Second
76+
clientConfig.Compression = configcompression.TypeGzip
77+
clientConfig.WriteBufferSize = 512 * 1024
8378
// Config with legacy options
8479
actualCfg := &Config{
8580
QueueSettings: exporterhelper.NewDefaultQueueConfig(),
@@ -88,15 +83,7 @@ func TestCheckAndWarnDeprecatedOptions(t *testing.T) {
8883
CustomEndpoint: "https://api.example.com",
8984
QueueMaxLength: 10,
9085
DrainInterval: 10,
91-
ClientConfig: confighttp.ClientConfig{
92-
Endpoint: "",
93-
Timeout: 10 * time.Second,
94-
Headers: map[string]configopaque.String{},
95-
// Default to gzip compression
96-
Compression: configcompression.TypeGzip,
97-
// We almost read 0 bytes, so no need to tune ReadBufferSize.
98-
WriteBufferSize: 512 * 1024,
99-
},
86+
ClientConfig: clientConfig,
10087
}
10188
params := exportertest.NewNopSettings()
10289
logger := hclog2ZapLogger{
@@ -105,22 +92,20 @@ func TestCheckAndWarnDeprecatedOptions(t *testing.T) {
10592
}
10693
actualCfg.checkAndWarnDeprecatedOptions(&logger)
10794

95+
clientConfigEndpoint := confighttp.NewDefaultClientConfig()
96+
clientConfigEndpoint.Timeout = 10 * time.Second
97+
clientConfigEndpoint.Compression = configcompression.TypeGzip
98+
clientConfigEndpoint.WriteBufferSize = 512 * 1024
99+
clientConfigEndpoint.Endpoint = "https://api.example.com"
100+
108101
expected := &Config{
109102
Token: "logzioTESTtoken",
110103
CustomEndpoint: "https://api.example.com",
111104
QueueMaxLength: 10,
112105
DrainInterval: 10,
113106
BackOffConfig: configretry.NewDefaultBackOffConfig(),
114107
QueueSettings: exporterhelper.NewDefaultQueueConfig(),
115-
ClientConfig: confighttp.ClientConfig{
116-
Endpoint: "https://api.example.com",
117-
Timeout: 10 * time.Second,
118-
Headers: map[string]configopaque.String{},
119-
// Default to gzip compression
120-
Compression: configcompression.TypeGzip,
121-
// We almost read 0 bytes, so no need to tune ReadBufferSize.
122-
WriteBufferSize: 512 * 1024,
123-
},
108+
ClientConfig: clientConfigEndpoint,
124109
}
125110
expected.QueueSettings.QueueSize = 10
126111
assert.Equal(t, expected, actualCfg)

‎exporter/logzioexporter/exporter_test.go

+18-17
Original file line numberDiff line numberDiff line change
@@ -186,12 +186,13 @@ func TestExportErrors(tester *testing.T) {
186186
server := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, _ *http.Request) {
187187
rw.WriteHeader(test.status)
188188
}))
189+
clientConfig := confighttp.NewDefaultClientConfig()
190+
clientConfig.Endpoint = server.URL
191+
189192
cfg := &Config{
190-
Region: "",
191-
Token: "token",
192-
ClientConfig: confighttp.ClientConfig{
193-
Endpoint: server.URL,
194-
},
193+
Region: "",
194+
Token: "token",
195+
ClientConfig: clientConfig,
195196
}
196197
td := newTestTracesWithAttributes()
197198
ld := testdata.GenerateLogs(10)
@@ -240,13 +241,13 @@ func TestPushTraceData(tester *testing.T) {
240241
recordedRequests, _ = io.ReadAll(req.Body)
241242
rw.WriteHeader(http.StatusOK)
242243
}))
244+
clientConfig := confighttp.NewDefaultClientConfig()
245+
clientConfig.Endpoint = server.URL
246+
clientConfig.Compression = configcompression.TypeGzip
243247
cfg := Config{
244-
Token: "token",
245-
Region: "",
246-
ClientConfig: confighttp.ClientConfig{
247-
Endpoint: server.URL,
248-
Compression: configcompression.TypeGzip,
249-
},
248+
Token: "token",
249+
Region: "",
250+
ClientConfig: clientConfig,
250251
}
251252
defer server.Close()
252253
td := newTestTraces()
@@ -273,13 +274,13 @@ func TestPushLogsData(tester *testing.T) {
273274
recordedRequests, _ = io.ReadAll(req.Body)
274275
rw.WriteHeader(http.StatusOK)
275276
}))
277+
clientConfig := confighttp.NewDefaultClientConfig()
278+
clientConfig.Endpoint = server.URL
279+
clientConfig.Compression = configcompression.TypeGzip
276280
cfg := Config{
277-
Token: "token",
278-
Region: "",
279-
ClientConfig: confighttp.ClientConfig{
280-
Endpoint: server.URL,
281-
Compression: configcompression.TypeGzip,
282-
},
281+
Token: "token",
282+
Region: "",
283+
ClientConfig: clientConfig,
283284
}
284285
defer server.Close()
285286
ld := generateLogsOneEmptyTimestamp()

‎exporter/logzioexporter/factory.go

+7-10
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ import (
1515
"go.opentelemetry.io/collector/component"
1616
"go.opentelemetry.io/collector/config/configcompression"
1717
"go.opentelemetry.io/collector/config/confighttp"
18-
"go.opentelemetry.io/collector/config/configopaque"
1918
"go.opentelemetry.io/collector/config/configretry"
2019
"go.opentelemetry.io/collector/exporter"
2120
"go.opentelemetry.io/collector/exporter/exporterhelper"
@@ -34,20 +33,18 @@ func NewFactory() exporter.Factory {
3433
}
3534

3635
func createDefaultConfig() component.Config {
36+
clientConfig := confighttp.NewDefaultClientConfig()
37+
clientConfig.Timeout = 30 * time.Second
38+
// Default to gzip compression
39+
clientConfig.Compression = configcompression.TypeGzip
40+
// We almost read 0 bytes, so no need to tune ReadBufferSize.
41+
clientConfig.WriteBufferSize = 512 * 1024
3742
return &Config{
3843
Region: "",
3944
Token: "",
4045
BackOffConfig: configretry.NewDefaultBackOffConfig(),
4146
QueueSettings: exporterhelper.NewDefaultQueueConfig(),
42-
ClientConfig: confighttp.ClientConfig{
43-
Endpoint: "",
44-
Timeout: 30 * time.Second,
45-
Headers: map[string]configopaque.String{},
46-
// Default to gzip compression
47-
Compression: configcompression.TypeGzip,
48-
// We almost read 0 bytes, so no need to tune ReadBufferSize.
49-
WriteBufferSize: 512 * 1024,
50-
},
47+
ClientConfig: clientConfig,
5148
}
5249
}
5350

‎exporter/logzioexporter/factory_test.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,12 @@ func TestGenerateUrl(t *testing.T) {
6060
{"", "EU", "https://listener-eu.logz.io:8071/?token=token"},
6161
}
6262
for _, test := range generateURLTests {
63+
clientConfig := confighttp.NewDefaultClientConfig()
64+
clientConfig.Endpoint = test.endpoint
6365
cfg := &Config{
64-
Region: test.region,
65-
Token: "token",
66-
ClientConfig: confighttp.ClientConfig{
67-
Endpoint: test.endpoint,
68-
},
66+
Region: test.region,
67+
Token: "token",
68+
ClientConfig: clientConfig,
6969
}
7070
output, _ := generateEndpoint(cfg)
7171
require.Equal(t, test.expected, output)

‎exporter/logzioexporter/jsonlog_test.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,13 @@ func TestSetTimeStamp(t *testing.T) {
8383
}))
8484
defer func() { server.Close() }()
8585
ld := generateLogsOneEmptyTimestamp()
86+
clientConfig := confighttp.NewDefaultClientConfig()
87+
clientConfig.Endpoint = server.URL
88+
clientConfig.Compression = configcompression.TypeGzip
8689
cfg := &Config{
87-
Region: "us",
88-
Token: "token",
89-
ClientConfig: confighttp.ClientConfig{
90-
Endpoint: server.URL,
91-
Compression: configcompression.TypeGzip,
92-
},
90+
Region: "us",
91+
Token: "token",
92+
ClientConfig: clientConfig,
9393
}
9494
var err error
9595
params := exportertest.NewNopSettings()

0 commit comments

Comments
 (0)