Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore] Improve queue config validation messages #11995

Merged
merged 1 commit into from
Jan 14, 2025
+8 −8
Merged

[chore] Improve queue config validation messages #11995

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions exporter/exporterhelper/internal/queue_sender.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,11 @@ func (qCfg *QueueConfig) Validate() error {
}

if qCfg.QueueSize <= 0 {
return errors.New("queue size must be positive")
return errors.New("`queue_size` must be positive")
}

if qCfg.NumConsumers <= 0 {
return errors.New("number of queue consumers must be positive")
return errors.New("`num_consumers` must be positive")
}

return nil
Expand Down
4 changes: 2 additions & 2 deletions exporter/exporterhelper/internal/queue_sender_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,12 +313,12 @@ func TestQueueConfig_Validate(t *testing.T) {
require.NoError(t, qCfg.Validate())

qCfg.QueueSize = 0
require.EqualError(t, qCfg.Validate(), "queue size must be positive")
require.EqualError(t, qCfg.Validate(), "`queue_size` must be positive")

qCfg = NewDefaultQueueConfig()
qCfg.NumConsumers = 0

require.EqualError(t, qCfg.Validate(), "number of queue consumers must be positive")
require.EqualError(t, qCfg.Validate(), "`num_consumers` must be positive")

// Confirm Validate doesn't return error with invalid config when feature is disabled
qCfg.Enabled = false
Expand Down
4 changes: 2 additions & 2 deletions exporter/exporterqueue/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ func (qCfg *Config) Validate() error {
return nil
}
if qCfg.NumConsumers <= 0 {
return errors.New("number of consumers must be positive")
return errors.New("`num_consumers` must be positive")
}
if qCfg.QueueSize <= 0 {
return errors.New("queue size must be positive")
return errors.New("`queue_size` must be positive")
}
return nil
}
Expand Down
4 changes: 2 additions & 2 deletions exporter/exporterqueue/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ func TestQueueConfig_Validate(t *testing.T) {
require.NoError(t, qCfg.Validate())

qCfg.NumConsumers = 0
require.EqualError(t, qCfg.Validate(), "number of consumers must be positive")
require.EqualError(t, qCfg.Validate(), "`num_consumers` must be positive")

qCfg = NewDefaultConfig()
qCfg.QueueSize = 0
require.EqualError(t, qCfg.Validate(), "queue size must be positive")
require.EqualError(t, qCfg.Validate(), "`queue_size` must be positive")

// Confirm Validate doesn't return error with invalid config when feature is disabled
qCfg.Enabled = false
Expand Down
Loading