Fix for - syncTargetAllocator in prometheus metrics receiver doesnt detect regex changes in metrics relabel config #30258
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| change_type: 'bug_fix' | ||
| component: 'prometheusreceiver' | ||
| note: Fix hash computation to include non exported fields like regex in scrape configuration for TargetAllocator | ||
| issues: [29313] | ||
| subtext: | ||
| change_logs: [] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,6 +20,7 @@ import ( | |
| "github.com/prometheus/common/model" | ||
| promConfig "github.com/prometheus/prometheus/config" | ||
| promHTTP "github.com/prometheus/prometheus/discovery/http" | ||
| "github.com/prometheus/prometheus/model/relabel" | ||
| "github.com/stretchr/testify/require" | ||
| "go.opentelemetry.io/collector/component/componenttest" | ||
| "go.opentelemetry.io/collector/consumer/consumertest" | ||
|
|
@@ -50,9 +51,15 @@ type hTTPSDResponse struct { | |
| Labels map[model.LabelName]model.LabelValue `json:"labels"` | ||
| } | ||
|
|
||
| type expectedMetricRelabelConfigTestResult struct { | ||
| JobName string | ||
| MetricRelabelRegex relabel.Regexp | ||
| } | ||
|
|
||
| type expectedTestResultJobMap struct { | ||
| Targets []string | ||
| Labels model.LabelSet | ||
| MetricRelabelConfig *expectedMetricRelabelConfigTestResult | ||
| } | ||
|
|
||
| type expectedTestResult struct { | ||
|
|
@@ -111,7 +118,6 @@ func transformTAResponseMap(rawResponses map[string][]mockTargetAllocatorRespons | |
| }) | ||
| } | ||
| responsesMap[path] = responses | ||
| v := &atomic.Int32{} | ||
| responsesIndexMap[path] = v | ||
| } | ||
|
|
@@ -481,6 +487,111 @@ func TestTargetAllocatorJobRetrieval(t *testing.T) { | |
| jobMap: map[string]expectedTestResultJobMap{}, | ||
| }, | ||
| }, | ||
| { | ||
| desc: "update metric relabel config regex", | ||
| responses: Responses{ | ||
| releaserMap: map[string]int{ | ||
| "/scrape_configs": 1, | ||
| }, | ||
| responses: map[string][]mockTargetAllocatorResponseRaw{ | ||
| "/scrape_configs": { | ||
| mockTargetAllocatorResponseRaw{code: 200, data: map[string]map[string]any{ | ||
| "job1": { | ||
| "job_name": "job1", | ||
| "scrape_interval": "30s", | ||
| "scrape_timeout": "30s", | ||
| "metrics_path": "/metrics", | ||
| "scheme": "http", | ||
| "metric_relabel_configs": []map[string]string{ | ||
| { | ||
| "separator": ";", | ||
| "regex": "regex1", | ||
| "action": "keep", | ||
| }, | ||
| }, | ||
| }, | ||
| }}, | ||
| mockTargetAllocatorResponseRaw{code: 200, data: map[string]map[string]any{ | ||
| "job1": { | ||
| "job_name": "job1", | ||
| "scrape_interval": "30s", | ||
| "scrape_timeout": "30s", | ||
| "metrics_path": "/metrics", | ||
| "scheme": "http", | ||
| "metric_relabel_configs": []map[string]string{ | ||
| { | ||
| "separator": ";", | ||
| "regex": "regex2", | ||
| "action": "keep", | ||
| }, | ||
| }, | ||
| }, | ||
| }}, | ||
| }, | ||
| "/jobs/job1/targets": { | ||
| mockTargetAllocatorResponseRaw{code: 200, data: []hTTPSDResponse{ | ||
| {Targets: []string{"localhost:9090"}, | ||
| Labels: map[model.LabelName]model.LabelValue{ | ||
| "__meta_datacenter": "london", | ||
| "__meta_prometheus_job": "node", | ||
| }}, | ||
| }}, | ||
| mockTargetAllocatorResponseRaw{code: 200, data: []hTTPSDResponse{ | ||
| {Targets: []string{"localhost:9090"}, | ||
| Labels: map[model.LabelName]model.LabelValue{ | ||
| "__meta_datacenter": "london", | ||
| "__meta_prometheus_job": "node", | ||
| }}, | ||
| }}, | ||
| }, | ||
| }, | ||
| }, | ||
| cfg: &Config{ | ||
| PrometheusConfig: &promConfig.Config{ | ||
| ScrapeConfigs: []*promConfig.ScrapeConfig{ | ||
| { | ||
| JobName: "job1", | ||
| HonorTimestamps: true, | ||
| ScrapeInterval: model.Duration(30 * time.Second), | ||
| ScrapeTimeout: model.Duration(30 * time.Second), | ||
| MetricsPath: "/metrics", | ||
| Scheme: "http", | ||
| MetricRelabelConfigs: []*relabel.Config{ | ||
| { | ||
| Separator: ";", | ||
| Regex: relabel.MustNewRegexp("(.*)"), | ||
| Action: relabel.Keep, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| TargetAllocator: &targetAllocator{ | ||
| Interval: 10 * time.Second, | ||
| CollectorID: "collector-1", | ||
| HTTPSDConfig: &promHTTP.SDConfig{ | ||
| HTTPClientConfig: commonconfig.HTTPClientConfig{}, | ||
| RefreshInterval: model.Duration(60 * time.Second), | ||
| }, | ||
| }, | ||
| }, | ||
| want: expectedTestResult{ | ||
| empty: false, | ||
| jobMap: map[string]expectedTestResultJobMap{ | ||
| "job1": { | ||
| Targets: []string{"localhost:9090"}, | ||
| Labels: map[model.LabelName]model.LabelValue{ | ||
| "__meta_datacenter": "london", | ||
| "__meta_prometheus_job": "node", | ||
| }, | ||
| MetricRelabelConfig: &expectedMetricRelabelConfigTestResult{ | ||
| JobName: "job1", | ||
| MetricRelabelRegex: relabel.MustNewRegexp("regex2"), | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } { | ||
| t.Run(tc.desc, func(t *testing.T) { | ||
| ctx := context.Background() | ||
|
|
@@ -505,7 +616,6 @@ func TestTargetAllocatorJobRetrieval(t *testing.T) { | |
| require.Len(t, providers, 0) | ||
| return | ||
| } | ||
| require.NotNil(t, providers) | ||
|
|
||
| for _, provider := range providers { | ||
|
|
@@ -532,10 +642,23 @@ func TestTargetAllocatorJobRetrieval(t *testing.T) { | |
| // which is identical to the source url | ||
| s.Labels["__meta_url"] = model.LabelValue(sdConfig.URL) | ||
| require.Equal(t, s.Labels, group.Labels) | ||
|
|
||
| if s.MetricRelabelConfig != nil { | ||
| // Adding wait here so that the latest scrape config is applied with the updated regex | ||
| time.Sleep(5 * time.Second) | ||
|
There was a problem hiding this comment. Putting a 5s sleep inside a triply-nested loop can have a significant impact on test runtime. Can this be avoided? There was a problem hiding this comment. @Aneurysm9 - Unfortunately, looks like if the sleep is not present, the updated regex doesnt get picked up. This is the only test that uses the sleep and for all the other tests it wouldn't go in this loop. |
||
| for _, sc := range receiver.cfg.PrometheusConfig.ScrapeConfigs { | ||
| if sc.JobName == s.MetricRelabelConfig.JobName { | ||
| for _, mc := range sc.MetricRelabelConfigs { | ||
| require.Equal(t, s.MetricRelabelConfig.MetricRelabelRegex, mc.Regex) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| found = true | ||
| } | ||
| require.True(t, found, "Returned job is not defined in expected values", group) | ||
| } | ||
|
|
||
| } | ||
| }) | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -108,7 +108,6 @@ require ( | |
| github.com/miekg/dns v1.1.56 // indirect | ||
| github.com/mitchellh/copystructure v1.2.0 // indirect | ||
| github.com/mitchellh/go-homedir v1.1.0 // indirect | ||
| github.com/mitchellh/mapstructure v1.5.1-0.20220423185008-bf980b35cac4 // indirect | ||
| github.com/mitchellh/reflectwalk v1.0.2 // indirect | ||
| github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this is going to be a viable approach. To ensure consistency I believe it necessary to first extract the keys from the map into a slice and sort them, then iterate over the sorted slice.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Aneurysm9 - I did find another way to fix this issue using a different package. Please lmk if you see any concerns.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Aneurysm9 - here are the results for the benchmark ( see the test for the benchmark tests i used. This is just for reference and I can remove them after you review)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @Aneurysm9, Following up. Please lmk if you have any suggestions/feedback. Thanks for looking into this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Aneurysm9 - Following up. Please lmk if you have any concerns/feedback. Thanks!