Skip to content

fix: prevent putDimensions from storing duplicate dimensions #88

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

Merged
merged 5 commits into from
Aug 15, 2022
Merged

fix: prevent putDimensions from storing duplicate dimensions #88

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
49bc5c5
fix: prevent putDimensions from storing duplicate dimensions
Nov 22, 2021
d8c2d09
fix: change putDimensions to update/sort existing dimension sets when…
Nov 22, 2021
5fd52b1
Update src/test/java/software/amazon/cloudwatchlogs/emf/model/MetricD…
markkuhn Aug 15, 2022
a6ec45e
Update src/test/java/software/amazon/cloudwatchlogs/emf/model/MetricD…
markkuhn Aug 15, 2022
773eff2
Merge branch 'master' into fix/duplicate-dimensions
markkuhn Aug 15, 2022
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
9 changes: 9 additions & 0 deletions src/main/java/software/amazon/cloudwatchlogs/emf/model/MetricDirective.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,16 @@ class MetricDirective {
shouldUseDefaultDimension = true;
}

/**
* Adds a dimension set to the end of the collection.
*
* @param dimensionSet
*/
void putDimensionSet(DimensionSet dimensionSet) {
// Duplicate dimensions sets are removed before being added to the end of the collection.
// This ensures only latest dimension value is used as a target member on the root EMF node.
// This operation is O(n^2), but acceptable given sets are capped at 10 dimensions
dimensions.removeIf(dim -> dim.getDimensionKeys().equals(dimensionSet.getDimensionKeys()));
dimensions.add(dimensionSet);
}

Expand Down
53 changes: 52 additions & 1 deletion src/test/java/software/amazon/cloudwatchlogs/emf/model/MetricDirectiveTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ public void testPutDimensions() throws JsonProcessingException {
}

@Test
public void testPutMultipleDimensionSets() throws JsonProcessingException {
public void testPutDimensionSetWhenMultipleDimensionSets() throws JsonProcessingException {
MetricDirective metricDirective = new MetricDirective();
metricDirective.putDimensionSet(DimensionSet.of("Region", "us-east-1"));
metricDirective.putDimensionSet(DimensionSet.of("Instance", "inst-1"));
Expand All @@ -114,6 +114,57 @@ public void testPutMultipleDimensionSets() throws JsonProcessingException {
"{\"Dimensions\":[[\"Region\"],[\"Instance\"]],\"Metrics\":[],\"Namespace\":\"aws-embedded-metrics\"}");
}

@Test
public void testPutDimensionSetWhenDuplicateDimensionSets() throws JsonProcessingException {
MetricDirective metricDirective = new MetricDirective();
metricDirective.putDimensionSet(new DimensionSet());
metricDirective.putDimensionSet(DimensionSet.of("Region", "us-east-1"));
metricDirective.putDimensionSet(
DimensionSet.of("Region", "us-east-1", "Instance", "inst-1"));
metricDirective.putDimensionSet(
DimensionSet.of("Instance", "inst-1", "Region", "us-east-1"));
metricDirective.putDimensionSet(DimensionSet.of("Instance", "inst-1"));
metricDirective.putDimensionSet(new DimensionSet());
metricDirective.putDimensionSet(DimensionSet.of("Region", "us-east-1"));
metricDirective.putDimensionSet(
DimensionSet.of("Region", "us-east-1", "Instance", "inst-1"));
metricDirective.putDimensionSet(
DimensionSet.of("Instance", "inst-1", "Region", "us-east-1"));
metricDirective.putDimensionSet(DimensionSet.of("Instance", "inst-1"));

String serializedMetricDirective = objectMapper.writeValueAsString(metricDirective);

assertEquals(
serializedMetricDirective,
"{\"Dimensions\":[[],[\"Region\"],[\"Instance\",\"Region\"],[\"Instance\"]],\"Metrics\":[],\"Namespace\":\"aws-embedded-metrics\"}");
}

@Test
public void testPutDimensionSetWhenDuplicateDimensionSetsWillSortCorrectly()
throws JsonProcessingException {
MetricDirective metricDirective = new MetricDirective();
metricDirective.putDimensionSet(new DimensionSet());
metricDirective.putDimensionSet(DimensionSet.of("Region", "us-east-1"));
metricDirective.putDimensionSet(
DimensionSet.of("Region", "us-east-1", "Instance", "inst-1"));
metricDirective.putDimensionSet(
DimensionSet.of("Instance", "inst-1", "Region", "us-east-1"));
metricDirective.putDimensionSet(DimensionSet.of("Instance", "inst-1"));
metricDirective.putDimensionSet(
DimensionSet.of("Region", "us-east-1", "Instance", "inst-1"));
metricDirective.putDimensionSet(
DimensionSet.of("Instance", "inst-1", "Region", "us-east-1"));
metricDirective.putDimensionSet(DimensionSet.of("Instance", "inst-1"));
metricDirective.putDimensionSet(DimensionSet.of("Region", "us-east-1"));
metricDirective.putDimensionSet(new DimensionSet());

String serializedMetricDirective = objectMapper.writeValueAsString(metricDirective);

assertEquals(
serializedMetricDirective,
"{\"Dimensions\":[[\"Instance\",\"Region\"],[\"Instance\"],[\"Region\"],[]],\"Metrics\":[],\"Namespace\":\"aws-embedded-metrics\"}");
}

@Test
public void testGetDimensionAfterSetDimensions() {
MetricDirective metricDirective = new MetricDirective();
Expand Down