Skip to content

Fix prometheusreceiver TA/scrape_config validation logic #30135

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

Closed
wants to merge 3 commits into from
Closed

Fix prometheusreceiver TA/scrape_config validation logic #30135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e2c168e
Fix prometheusreceiver TA/scrape_config validation logic
Aneurysm9 Dec 19, 2023
90dede4
PR feedback
Aneurysm9 Dec 20, 2023
cdb70a4
Merge branch 'main' into fix/promTACfgValidation
Aneurysm9 Dec 21, 2023
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
6 changes: 6 additions & 0 deletions .chloggen/fix_promTACfgValidation.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
change_type: 'bug_fix'
component: 'prometheusreceiver'
note: Fix configuration validation to allow specification of Target Allocator configuration without providing scrape configurations
issues: [30135]
subtext:
change_logs: []
8 changes: 4 additions & 4 deletions receiver/prometheusreceiver/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,10 @@ func checkTLSConfig(tlsConfig commonconfig.TLSConfig) error {
// Validate checks the receiver configuration is valid.
func (cfg *Config) Validate() error {
promConfig := cfg.PrometheusConfig
if (promConfig == nil || len(promConfig.ScrapeConfigs) == 0) && cfg.TargetAllocator == nil {
return errors.New("no Prometheus scrape_configs or target_allocator set")
}

if promConfig != nil {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest moving this to the validatePromConfig simplifies indentation.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's where it was and you told me to move it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I told to move the following code in the config.Validate

	if (promConfig == nil || len(promConfig.ScrapeConfigs) == 0) && cfg.TargetAllocator == nil {
		return errors.New("no Prometheus scrape_configs or target_allocator set")
	}

And in this comment I asked to move in the validatePromConfig

	if promConfig == nil {
		return nil
	}

err := cfg.validatePromConfig(promConfig)
if err != nil {
Expand All @@ -112,10 +116,6 @@ func (cfg *Config) Validate() error {
}

func (cfg *Config) validatePromConfig(promConfig *promconfig.Config) error {
if len(promConfig.ScrapeConfigs) == 0 && cfg.TargetAllocator == nil {
return errors.New("no Prometheus scrape_configs or target_allocator set")
}

// Reject features that Prometheus supports but that the receiver doesn't support:
// See:
// * https://github.com/open-telemetry/opentelemetry-collector/issues/3863
Expand Down
33 changes: 33 additions & 0 deletions receiver/prometheusreceiver/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ func TestLoadTargetAllocatorConfig(t *testing.T) {
sub, err := cm.Sub(component.NewIDWithName(metadata.Type, "").String())
require.NoError(t, err)
require.NoError(t, component.UnmarshalConfig(sub, cfg))
require.NoError(t, component.ValidateConfig(cfg))

r0 := cfg.(*Config)
assert.NotNil(t, r0.PrometheusConfig)
Expand All @@ -77,6 +78,7 @@ func TestLoadTargetAllocatorConfig(t *testing.T) {
require.NoError(t, err)
cfg = factory.CreateDefaultConfig()
require.NoError(t, component.UnmarshalConfig(sub, cfg))
require.NoError(t, component.ValidateConfig(cfg))

r1 := cfg.(*Config)
assert.NotNil(t, r0.PrometheusConfig)
Expand All @@ -92,6 +94,7 @@ func TestLoadTargetAllocatorConfig(t *testing.T) {
require.NoError(t, err)
cfg = factory.CreateDefaultConfig()
require.NoError(t, component.UnmarshalConfig(sub, cfg))
require.NoError(t, component.ValidateConfig(cfg))

r2 := cfg.(*Config)
assert.Equal(t, 1, len(r2.PrometheusConfig.ScrapeConfigs))
Expand All @@ -110,6 +113,36 @@ func TestLoadConfigFailsOnUnknownSection(t *testing.T) {
require.Error(t, component.UnmarshalConfig(sub, cfg))
}

func TestLoadConfigFailsOnNoPrometheusOrTAConfig(t *testing.T) {
cm, err := confmaptest.LoadConf(filepath.Join("testdata", "invalid-config-prometheus-non-existent-scrape-config.yaml"))
require.NoError(t, err)
factory := NewFactory()

cfg := factory.CreateDefaultConfig()
sub, err := cm.Sub(component.NewIDWithName(metadata.Type, "").String())
require.NoError(t, err)
require.NoError(t, component.UnmarshalConfig(sub, cfg))
require.ErrorContains(t, component.ValidateConfig(cfg), "no Prometheus scrape_configs or target_allocator set")

cfg = factory.CreateDefaultConfig()
sub, err = cm.Sub(component.NewIDWithName(metadata.Type, "withConfigAndTA").String())
require.NoError(t, err)
require.NoError(t, component.UnmarshalConfig(sub, cfg))
require.NoError(t, component.ValidateConfig(cfg))

cfg = factory.CreateDefaultConfig()
sub, err = cm.Sub(component.NewIDWithName(metadata.Type, "withOnlyTA").String())
require.NoError(t, err)
require.NoError(t, component.UnmarshalConfig(sub, cfg))
require.NoError(t, component.ValidateConfig(cfg))

cfg = factory.CreateDefaultConfig()
sub, err = cm.Sub(component.NewIDWithName(metadata.Type, "withOnlyScrape").String())
require.NoError(t, err)
require.NoError(t, component.UnmarshalConfig(sub, cfg))
require.NoError(t, component.ValidateConfig(cfg))
}

// As one of the config parameters is consuming prometheus
// configuration as a subkey, ensure that invalid configuration
// within the subkey will also raise an error.
Expand Down
19 changes: 19 additions & 0 deletions ...ver/prometheusreceiver/testdata/invalid-config-prometheus-non-existent-scrape-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
prometheus:
prometheus/withConfigAndTA:
target_allocator:
endpoint: http://localhost:8080
interval: 30s
collector_id: collector-1
config:
global:
scrape_interval: 30s
prometheus/withOnlyTA:
target_allocator:
endpoint: http://localhost:8080
interval: 30s
collector_id: collector-1
prometheus/withOnlyScrape:
config:
scrape_configs:
- job_name: 'demo'
scrape_interval: 5s