[receiver/prometheus] syncTargetAllocator now detects regex changes in relabel config #32127
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
| 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 { | ||
|
|
@@ -481,6 +488,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{ | ||
| 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: &PromHTTPSDConfig{ | ||
| 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() | ||
|
|
@@ -532,6 +644,17 @@ 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. If we do need to wait here, could we use There was a problem hiding this comment. @swiatekm - This is not needed. Removed it. |
||
| 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
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
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.
Could we add some simple unit tests for this function? There was concern about map iteration order inconsistency, so we should at least check if this function ran on two copies of the same config gives the same result.
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.
Thanks @swiatekm. Added one. Please take a look.