forked from open-telemetry/opentelemetry-collector-contrib
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[awsemfexporter] Implement metric filtering and dimension setting (op…
…en-telemetry#1503) * Create MetricDeclaration struct * Implement dimension dedup logic when adding rolledup dimensions (open-telemetry#6) * Implement dimension dedup logic when adding rolledup dimensions * Remove duplicated dimensions in metric declaration * Create benchmark for filtering with metric declarations and use assertCwMeasurementEqual for tests * Move helper test code to the top of file * Update dimRollup test * Aggregate dimensions and perform dedup * Minor code change * Fix test failure from merging new changes
- Loading branch information
1 parent
cb4270e
commit 0217d55
Showing
10 changed files
with
1,718 additions
and
465 deletions.
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
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 |
|---|---|---|
| @@ -0,0 +1,171 @@ | ||
| // Copyright 2020, OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package awsemfexporter | ||
|
|
||
| import ( | ||
| "errors" | ||
| "regexp" | ||
| "sort" | ||
| "strings" | ||
|
|
||
| "go.opentelemetry.io/collector/consumer/pdata" | ||
| "go.uber.org/zap" | ||
| ) | ||
|
|
||
| // MetricDeclaration characterizes a rule to be used to set dimensions for certain | ||
| // incoming metrics, filtered by their metric names. | ||
| type MetricDeclaration struct { | ||
| // Dimensions is a list of dimension sets (which are lists of dimension names) to be | ||
| // included in exported metrics. If the metric does not contain any of the specified | ||
| // dimensions, the metric would be dropped (will only show up in logs). | ||
| Dimensions [][]string `mapstructure:"dimensions"` | ||
| // MetricNameSelectors is a list of regex strings to be matched against metric names | ||
| // to determine which metrics should be included with this metric declaration rule. | ||
| MetricNameSelectors []string `mapstructure:"metric_name_selectors"` | ||
|
|
||
| // metricRegexList is a list of compiled regexes for metric name selectors. | ||
| metricRegexList []*regexp.Regexp | ||
| } | ||
|
|
||
| // Remove duplicated entries from dimension set. | ||
| func dedupDimensionSet(dimensions []string) (deduped []string, hasDuplicate bool) { | ||
| seen := make(map[string]bool, len(dimensions)) | ||
| for _, v := range dimensions { | ||
| seen[v] = true | ||
| } | ||
| hasDuplicate = (len(seen) < len(dimensions)) | ||
| if !hasDuplicate { | ||
| deduped = dimensions | ||
| return | ||
| } | ||
| deduped = make([]string, len(seen)) | ||
| idx := 0 | ||
| for dim := range seen { | ||
| deduped[idx] = dim | ||
| idx++ | ||
| } | ||
| return | ||
| } | ||
|
|
||
| // Init initializes the MetricDeclaration struct. Performs validation and compiles | ||
| // regex strings. Dimensions are deduped and sorted. | ||
| func (m *MetricDeclaration) Init(logger *zap.Logger) (err error) { | ||
| // Return error if no metric name selectors are defined | ||
| if len(m.MetricNameSelectors) == 0 { | ||
| return errors.New("invalid metric declaration: no metric name selectors defined") | ||
| } | ||
|
|
||
| // Filter out duplicate dimension sets and those with more than 10 elements | ||
| validDims := make([][]string, 0, len(m.Dimensions)) | ||
| seen := make(map[string]bool, len(m.Dimensions)) | ||
| for _, dimSet := range m.Dimensions { | ||
| concatenatedDims := strings.Join(dimSet, ",") | ||
| if len(dimSet) > 10 { | ||
| logger.Warn("Dropped dimension set: > 10 dimensions specified.", zap.String("dimensions", concatenatedDims)) | ||
| continue | ||
| } | ||
|
|
||
| // Dedup dimensions within dimension set | ||
| dedupedDims, hasDuplicate := dedupDimensionSet(dimSet) | ||
| if hasDuplicate { | ||
| logger.Warn("Removed duplicates from dimension set.", zap.String("dimensions", concatenatedDims)) | ||
| } | ||
|
|
||
| // Sort dimensions | ||
| sort.Strings(dedupedDims) | ||
|
|
||
| // Dedup dimension sets | ||
| key := strings.Join(dedupedDims, ",") | ||
| if _, ok := seen[key]; ok { | ||
| logger.Warn("Dropped dimension set: duplicated dimension set.", zap.String("dimensions", concatenatedDims)) | ||
| continue | ||
| } | ||
| seen[key] = true | ||
| validDims = append(validDims, dedupedDims) | ||
| } | ||
| m.Dimensions = validDims | ||
|
|
||
| m.metricRegexList = make([]*regexp.Regexp, len(m.MetricNameSelectors)) | ||
| for i, selector := range m.MetricNameSelectors { | ||
| m.metricRegexList[i] = regexp.MustCompile(selector) | ||
| } | ||
| return | ||
| } | ||
|
|
||
| // Matches returns true if the given OTLP Metric's name matches any of the Metric | ||
| // Declaration's metric name selectors. | ||
| func (m *MetricDeclaration) Matches(metric *pdata.Metric) bool { | ||
| for _, regex := range m.metricRegexList { | ||
| if regex.MatchString(metric.Name()) { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| // ExtractDimensions extracts dimensions within the MetricDeclaration that only | ||
| // contains labels found in `labels`. Returned order of dimensions are preserved. | ||
| func (m *MetricDeclaration) ExtractDimensions(labels map[string]string) (dimensions [][]string) { | ||
| for _, dimensionSet := range m.Dimensions { | ||
| if len(dimensionSet) == 0 { | ||
| continue | ||
| } | ||
| includeSet := true | ||
| for _, dim := range dimensionSet { | ||
| if _, ok := labels[dim]; !ok { | ||
| includeSet = false | ||
| break | ||
| } | ||
| } | ||
| if includeSet { | ||
| dimensions = append(dimensions, dimensionSet) | ||
| } | ||
| } | ||
| return | ||
| } | ||
|
|
||
| // processMetricDeclarations processes a list of MetricDeclarations and creates a | ||
| // list of dimension sets that matches the given `metric`. This list is then aggregated | ||
| // together with the rolled-up dimensions. Returned dimension sets | ||
| // are deduped and the dimensions in each dimension set are sorted. | ||
| // Prerequisite: | ||
| // 1. metricDeclarations' dimensions are sorted. | ||
| func processMetricDeclarations(metricDeclarations []*MetricDeclaration, metric *pdata.Metric, | ||
| labels map[string]string, rolledUpDimensions [][]string) (dimensions [][]string) { | ||
| seen := make(map[string]bool) | ||
| addDimSet := func(dimSet []string) { | ||
| key := strings.Join(dimSet, ",") | ||
| // Only add dimension set if not a duplicate | ||
| if _, ok := seen[key]; !ok { | ||
| dimensions = append(dimensions, dimSet) | ||
| seen[key] = true | ||
| } | ||
| } | ||
| // Extract and append dimensions from metric declarations | ||
| for _, m := range metricDeclarations { | ||
| if m.Matches(metric) { | ||
| extractedDims := m.ExtractDimensions(labels) | ||
| for _, dimSet := range extractedDims { | ||
| addDimSet(dimSet) | ||
| } | ||
| } | ||
| } | ||
| // Add on rolled-up dimensions | ||
| for _, dimSet := range rolledUpDimensions { | ||
| sort.Strings(dimSet) | ||
| addDimSet(dimSet) | ||
| } | ||
| return | ||
| } |
Oops, something went wrong.