Skip to content

fix(gcp_exporter): preserve colons in extra_filters filter expressions #5018

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

Open
Kim-Yukyung wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(gcp_exporter): preserve colons in extra_filters filter expressions #5018

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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ Main (unreleased)

- Fix the `prometheus.operator.*` components internal scrape manager now having a way to enable ingesting native histograms. (@dehaansa)

- Fix an issue in the `prometheus.exporter.gcp` component where colons inside `extra_filters` were incorrectly removed. Filter expressions such as `database_id="project_id:database_name"` are now preserved as expected (@Kim-Yukyung)

v1.12.0
-----------------

Expand Down
11 changes: 5 additions & 6 deletions internal/static/integrations/gcp_exporter/gcp_exporter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ import (
"github.com/grafana/dskit/multierror"
"github.com/prometheus-community/stackdriver_exporter/collectors"
"github.com/prometheus-community/stackdriver_exporter/delta"
"github.com/prometheus-community/stackdriver_exporter/utils"
"github.com/prometheus/client_golang/prometheus"
"golang.org/x/oauth2/google"
"google.golang.org/api/monitoring/v3"
Expand Down Expand Up @@ -165,7 +164,7 @@ func (c *Config) Validate() error {
if len(c.ExtraFilters) > 0 {
filterPrefixToFilter := map[string][]string{}
for _, filter := range c.ExtraFilters {
splitFilter := strings.Split(filter, ":")
splitFilter := strings.SplitN(filter, ":", 2)
if len(splitFilter) <= 1 {
configErrors.Add(fmt.Errorf("%s is an invalid filter a filter must be of the form <metric_type>:<filter_expression>", filter))
continue
Expand Down Expand Up @@ -222,11 +221,11 @@ func createMonitoringService(ctx context.Context, httpTimeout time.Duration) (*m
func parseMetricExtraFilters(filters []string) []collectors.MetricFilter {
var extraFilters []collectors.MetricFilter
for _, ef := range filters {
efPrefix, efModifier := utils.SplitExtraFilter(ef, ":")
if efPrefix != "" {
splitFilter := strings.SplitN(ef, ":", 2)
if len(splitFilter) == 2 && splitFilter[0] != "" {
extraFilter := collectors.MetricFilter{
TargetedMetricPrefix: efPrefix,
FilterQuery: efModifier,
TargetedMetricPrefix: splitFilter[0],
FilterQuery: splitFilter[1],
}
extraFilters = append(extraFilters, extraFilter)
}
Expand Down
13 changes: 13 additions & 0 deletions internal/static/integrations/gcp_exporter/gcp_exporter_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,19 @@ func TestConfig_Validate(t *testing.T) {
},
shouldError: false,
},
{
name: "extra filter with colon in filter expression",
configModifier: func(config gcp_exporter.Config) gcp_exporter.Config {
config.MetricPrefixes = []string{
"cloudsql.googleapis.com/database/cpu",
}
config.ExtraFilters = []string{
`cloudsql.googleapis.com/database/cpu:resource.labels.database_id="project_id:database_name"`,
}
return config
},
shouldError: false,
},
}
for _, tt := range tests {
testName := tt.name
Expand Down