Skip to content

DimensionValueFilter, for filtering out metrics when discovery job used to mitigate costs #1203

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
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

DimensionValueFilter, for filtering out metrics when discovery job used to mitigate costs #1203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
46cc9ad
working version, need to test right regexs now
RetroJumper Oct 31, 2023
9c11027
more representative amq unit test, understand how max associator will…
RetroJumper Nov 1, 2023
8cc7be9
match main use case
RetroJumper Nov 1, 2023
7d8b09c
added all scenarios, and customNamespace support
RetroJumper Nov 1, 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
74 changes: 55 additions & 19 deletions pkg/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"os"

"github.com/aws/aws-sdk-go/aws"
"github.com/grafana/regexp"
"gopkg.in/yaml.v2"

"github.com/nerdswords/yet-another-cloudwatch-exporter/pkg/logging"
Expand Down Expand Up @@ -42,15 +43,16 @@ type JobLevelMetricFields struct {
}

type Job struct {
Regions []string `yaml:"regions"`
Type string `yaml:"type"`
Roles []Role `yaml:"roles"`
SearchTags []Tag `yaml:"searchTags"`
CustomTags []Tag `yaml:"customTags"`
DimensionNameRequirements []string `yaml:"dimensionNameRequirements"`
Metrics []*Metric `yaml:"metrics"`
RoundingPeriod *int64 `yaml:"roundingPeriod"`
RecentlyActiveOnly bool `yaml:"recentlyActiveOnly"`
Regions []string `yaml:"regions"`
Type string `yaml:"type"`
Roles []Role `yaml:"roles"`
SearchTags []Tag `yaml:"searchTags"`
CustomTags []Tag `yaml:"customTags"`
DimensionNameRequirements []string `yaml:"dimensionNameRequirements"`
DimensionValueFilter []*Dimension `yaml:"dimensionValueFilter"`
Metrics []*Metric `yaml:"metrics"`
RoundingPeriod *int64 `yaml:"roundingPeriod"`
RecentlyActiveOnly bool `yaml:"recentlyActiveOnly"`
JobLevelMetricFields `yaml:",inline"`
}

Expand All @@ -65,15 +67,16 @@ type Static struct {
}

type CustomNamespace struct {
Regions []string `yaml:"regions"`
Name string `yaml:"name"`
Namespace string `yaml:"namespace"`
RecentlyActiveOnly bool `yaml:"recentlyActiveOnly"`
Roles []Role `yaml:"roles"`
Metrics []*Metric `yaml:"metrics"`
CustomTags []Tag `yaml:"customTags"`
DimensionNameRequirements []string `yaml:"dimensionNameRequirements"`
RoundingPeriod *int64 `yaml:"roundingPeriod"`
Regions []string `yaml:"regions"`
Name string `yaml:"name"`
Namespace string `yaml:"namespace"`
RecentlyActiveOnly bool `yaml:"recentlyActiveOnly"`
Roles []Role `yaml:"roles"`
Metrics []*Metric `yaml:"metrics"`
CustomTags []Tag `yaml:"customTags"`
DimensionNameRequirements []string `yaml:"dimensionNameRequirements"`
DimensionValueFilter []*Dimension `yaml:"dimensionValueFilter"`
RoundingPeriod *int64 `yaml:"roundingPeriod"`
JobLevelMetricFields `yaml:",inline"`
}

Expand Down Expand Up @@ -206,6 +209,12 @@ func (j *Job) validateDiscoveryJob(jobIdx int) error {
return err
}
}
for dimensionIdx, dimension := range j.DimensionValueFilter {
err := dimension.validateDimensionValueRegexps(dimensionIdx, parent)
if err != nil {
return err
}
}

return nil
}
Expand Down Expand Up @@ -239,7 +248,12 @@ func (j *CustomNamespace) validateCustomNamespaceJob(jobIdx int) error {
return err
}
}

for dimensionIdx, dimension := range j.DimensionValueFilter {
err := dimension.validateDimensionValueRegexps(dimensionIdx, parent)
if err != nil {
return err
}
}
return nil
}

Expand Down Expand Up @@ -371,6 +385,7 @@ func (c *ScrapeConf) toModelConfig() model.JobsConfig {
job.SearchTags = toModelTags(discoveryJob.SearchTags)
job.CustomTags = toModelTags(discoveryJob.CustomTags)
job.Metrics = toModelMetricConfig(discoveryJob.Metrics)
job.DimensionValueFilter = toModelDimensionValueFilterConfig(discoveryJob.DimensionValueFilter)

job.ExportedTagsOnMetrics = []string{}
if len(c.Discovery.ExportedTagsOnMetrics) > 0 {
Expand Down Expand Up @@ -414,6 +429,7 @@ func (c *ScrapeConf) toModelConfig() model.JobsConfig {
job.Roles = toModelRoles(customNamespaceJob.Roles)
job.CustomTags = toModelTags(customNamespaceJob.CustomTags)
job.Metrics = toModelMetricConfig(customNamespaceJob.Metrics)
job.DimensionValueFilter = toModelDimensionValueFilterConfig(customNamespaceJob.DimensionValueFilter)
jobsCfg.CustomNamespaceJobs = append(jobsCfg.CustomNamespaceJobs, job)
}

Expand Down Expand Up @@ -493,3 +509,23 @@ func logConfigErrors(cfg []byte, logger logging.Logger) {
logger.Warn(`Config file error(s) detected: Yace might not work as expected. Future versions of Yace might fail to run with an invalid config file.`)
}
}

// converts string to regexp for model
func toModelDimensionValueFilterConfig(dimensionValueFilter []*Dimension) []*model.DimensionFilter {
ret := make([]*model.DimensionFilter, 0, len(dimensionValueFilter))
for _, d := range dimensionValueFilter {
ret = append(ret, &model.DimensionFilter{
Name: d.Name,
Value: regexp.MustCompile(d.Value),
})
}
return ret
}

func (d *Dimension) validateDimensionValueRegexps(dimensionIdx int, parent string) error {
_, err := regexp.Compile(d.Value)
if err != nil {
return fmt.Errorf("Dimension Value filter regexp %d, %q in %v: Name should not be empty", dimensionIdx, d.Value, parent)
}
return nil
}
3 changes: 3 additions & 0 deletions pkg/job/custom.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,9 @@ func getMetricDataForQueriesForCustomNamespace(
if len(customNamespaceJob.DimensionNameRequirements) > 0 && !metricDimensionsMatchNames(cwMetric, customNamespaceJob.DimensionNameRequirements) {
continue
}
if len(customNamespaceJob.DimensionValueFilter) > 0 && metricDimensionsFilterValue(cwMetric, customNamespaceJob.DimensionValueFilter) {
continue
}

for _, stats := range metric.Statistics {
id := fmt.Sprintf("id_%d", rand.Int())
Expand Down
30 changes: 29 additions & 1 deletion pkg/job/discovery.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import (
"strings"
"sync"

"github.com/grafana/regexp"

"golang.org/x/sync/errgroup"

"github.com/nerdswords/yet-another-cloudwatch-exporter/pkg/clients/cloudwatch"
Expand Down Expand Up @@ -192,7 +194,7 @@ func getMetricDataForQueries(
assoc := maxdimassociator.NewAssociator(logger, svc.DimensionRegexps, resources)

err := clientCloudwatch.ListMetrics(ctx, svc.Namespace, metric, discoveryJob.RecentlyActiveOnly, func(page []*model.Metric) {
data := getFilteredMetricDatas(logger, discoveryJob.Type, discoveryJob.ExportedTagsOnMetrics, page, discoveryJob.DimensionNameRequirements, metric, assoc)
data := getFilteredMetricDatas(logger, discoveryJob.Type, discoveryJob.ExportedTagsOnMetrics, page, discoveryJob.DimensionNameRequirements, discoveryJob.DimensionValueFilter, metric, assoc)

mux.Lock()
getMetricDatas = append(getMetricDatas, data...)
Expand All @@ -215,6 +217,7 @@ func getFilteredMetricDatas(
tagsOnMetrics []string,
metricsList []*model.Metric,
dimensionNameList []string,
dimensionValueFilterList []*model.DimensionFilter,
m *model.MetricConfig,
assoc resourceAssociator,
) []*model.CloudwatchData {
Expand All @@ -223,6 +226,9 @@ func getFilteredMetricDatas(
if len(dimensionNameList) > 0 && !metricDimensionsMatchNames(cwMetric, dimensionNameList) {
continue
}
if len(dimensionValueFilterList) > 0 && metricDimensionsFilterValue(cwMetric, dimensionValueFilterList) {
continue
}

matchedResource, skip := assoc.AssociateMetricToResource(cwMetric)
if skip {
Expand Down Expand Up @@ -283,3 +289,25 @@ func metricDimensionsMatchNames(metric *model.Metric, dimensionNameRequirements
}
return true
}

// Modify this to look at values
func metricDimensionsFilterValue(metric *model.Metric, dimensionValueFilter []*model.DimensionFilter) bool {
for _, dimension := range metric.Dimensions {
for _, dimensionValueRegexp := range dimensionValueFilter {
if dimension.Name == dimensionValueRegexp.Name && regexpValue(dimension.Value, dimensionValueRegexp.Value) {
return true
}
}
}
return false
}

// regex checker
func regexpValue(metricValue string, valueRegexp *regexp.Regexp) bool {
match := valueRegexp.FindStringSubmatch(metricValue)
if match == nil {
return false
} else {
return true
}
}
164 changes: 163 additions & 1 deletion pkg/job/discovery_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ func Test_getFilteredMetricDatas(t *testing.T) {
tagsOnMetrics []string
dimensionRegexps []*regexp.Regexp
dimensionNameRequirements []string
dimensionValueFilter []*model.DimensionFilter
resources []*model.TaggedResource
metricsList []*model.Metric
m *model.MetricConfig
Expand Down Expand Up @@ -397,11 +398,172 @@ func Test_getFilteredMetricDatas(t *testing.T) {
},
},
},
{
"filter query dimension values for amq",
args{
region: "us-east-1",
accountID: "123123123123",
namespace: "mq",
customTags: nil,
tagsOnMetrics: []string{
"Value1",
"Value2",
},
dimensionRegexps: config.SupportedServices.GetService("mq").DimensionRegexps,
dimensionValueFilter: []*model.DimensionFilter{
{
Name: "Queue",
Value: regexp.MustCompile("^ActiveMQ\\.Statistics\\.Destination\\..+"),
},
{
Name: "Queue",
Value: regexp.MustCompile("^.+\\.stats"),
},
{
Name: "Queue",
Value: regexp.MustCompile("^Loadtesting.+"),
},
{
Name: "Queue",
Value: regexp.MustCompile("^TEST.+"),
},
},
resources: []*model.TaggedResource{
{
ARN: "arn:aws:mq:us-east-2:123456789012:broker:activemq-broker:b-000-111-222-333",
Tags: []model.Tag{
{
Key: "Tag",
Value: "some-Tag",
},
},
Namespace: "mq",
Region: "us-east-1",
},
},
metricsList: []*model.Metric{
{
MetricName: "QueueSize",
Dimensions: []*model.Dimension{
{
Name: "Queue",
Value: "Fufillment",
},
{
Name: "Broker",
Value: "activemq-broker-1",
},
},
Namespace: "AWS/AmazonMQ",
},
{
MetricName: "QueueSize",
Dimensions: []*model.Dimension{
{
Name: "Queue",
Value: "ActiveMQ.Statistics.Destination.test",
},
{
Name: "Broker",
Value: "activemq-broker-1",
},
},
Namespace: "AWS/AmazonMQ",
},
{
MetricName: "QueueSize",
Dimensions: []*model.Dimension{
{
Name: "Queue",
Value: "test.stats",
},
{
Name: "Broker",
Value: "activemq-broker-1",
},
},
Namespace: "AWS/AmazonMQ",
},
{
MetricName: "QueueSize",
Dimensions: []*model.Dimension{
{
Name: "Queue",
Value: "Loadtesting.wow",
},
{
Name: "Broker",
Value: "activemq-broker-1",
},
},
Namespace: "AWS/AmazonMQ",
},
{
MetricName: "QueueSize",
Dimensions: []*model.Dimension{
{
Name: "Queue",
Value: "TEST.hmmm123",
},
{
Name: "Broker",
Value: "activemq-broker-1",
},
},
Namespace: "AWS/AmazonMQ",
},
},
m: &model.MetricConfig{
Name: "QueueSize",
Statistics: []string{
"Average",
},
Period: 60,
Length: 600,
Delay: 120,
NilToZero: aws.Bool(false),
AddCloudwatchTimestamp: aws.Bool(false),
},
},
[]model.CloudwatchData{
{
AddCloudwatchTimestamp: aws.Bool(false),
Dimensions: []*model.Dimension{
{
Name: "Queue",
Value: "Fufillment",
},
{
Name: "Broker",
Value: "activemq-broker-1",
},
},
ID: aws.String("arn:aws:mq:us-east-2:123456789012:broker:activemq-broker:b-000-111-222-333"),
Metric: aws.String("QueueSize"),
Namespace: aws.String("mq"),
NilToZero: aws.Bool(false),
Period: 60,
Statistics: []string{
"Average",
},
Tags: []model.Tag{
{
Key: "Value1",
Value: "",
},
{
Key: "Value2",
Value: "",
},
},
},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
assoc := maxdimassociator.NewAssociator(logging.NewNopLogger(), tt.args.dimensionRegexps, tt.args.resources)
metricDatas := getFilteredMetricDatas(logging.NewNopLogger(), tt.args.namespace, tt.args.tagsOnMetrics, tt.args.metricsList, tt.args.dimensionNameRequirements, tt.args.m, assoc)
metricDatas := getFilteredMetricDatas(logging.NewNopLogger(), tt.args.namespace, tt.args.tagsOnMetrics, tt.args.metricsList, tt.args.dimensionNameRequirements, tt.args.dimensionValueFilter, tt.args.m, assoc)
if len(metricDatas) != len(tt.wantGetMetricsData) {
t.Errorf("len(getFilteredMetricDatas()) = %v, want %v", len(metricDatas), len(tt.wantGetMetricsData))
}
Expand Down
Loading