Skip to content

Fix: prevent duplicate dimensions #32

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 3 commits into from
Aug 17, 2022
Merged

Fix: prevent duplicate dimensions #32

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
056abbb
fix: prevent duplicate dimensions
Aug 15, 2022
7bf10f9
Merge branch 'awslabs:main' into fix-#31
markkuhn Aug 15, 2022
8b2a9e4
fix comment
Aug 17, 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
19 changes: 19 additions & 0 deletions src/Amazon.CloudWatch.EMF/Model/MetricDirective.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,25 @@ internal List<List<string>> AllDimensionKeys
}
}

internal void PutDimension(DimensionSet dimensionSet)
{
// Duplicate dimensions sets are removed before being added to the end of the collection.
// This ensures the latest dimension key-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
List<string> incomingDimensionSetKeys = dimensionSet.DimensionKeys;
CustomDimensionSets = CustomDimensionSets.Where(existingDimensionSet =>
{
if (existingDimensionSet.DimensionKeys.Count != incomingDimensionSetKeys.Count)
{
return true;
}

return !existingDimensionSet.DimensionKeys.All(existingDimensionSetKey => incomingDimensionSetKeys.Contains(existingDimensionSetKey));
}).ToList();

CustomDimensionSets.Add(dimensionSet);
}

/// <summary>
/// Overrides all existing dimensions, including suppressing any default dimensions.
/// </summary>
Expand Down
4 changes: 2 additions & 2 deletions src/Amazon.CloudWatch.EMF/Model/MetricsContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ public object GetProperty(string name)
/// <param name="dimensionSet">the dimensions set to add.</param>
public void PutDimension(DimensionSet dimensionSet)
{
_metricDirective.CustomDimensionSets.Add(dimensionSet);
_metricDirective.PutDimension(dimensionSet);
}

/// <summary>
Expand All @@ -166,7 +166,7 @@ public void PutDimension(string dimension, string value)
{
var dimensionSet = new DimensionSet();
dimensionSet.AddDimension(dimension, value);
_metricDirective.CustomDimensionSets.Add(dimensionSet);
_metricDirective.PutDimension(dimensionSet);
}

/// <summary>
Expand Down
44 changes: 44 additions & 0 deletions tests/Amazon.CloudWatch.EMF.Tests/Logger/MetricsLoggerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,50 @@ public void TestOverridePreviousDimensions()
Assert.Equal(dimensionValue, _sink.MetricsContext.GetAllDimensionSets()[0].GetDimensionValue(dimensionName));
}

[Fact]
public void TestPutDuplicateDimensions()
{
string dimensionName1 = "dim1";
string dimensionName2 = "dim2";
string dimensionValue1 = "dimValue1";
string dimensionValue2 = "dimValue2";
string dimensionValue3 = "dimValue3";
string dimensionValue4 = "dimValue4";

_metricsLogger.PutDimensions(new DimensionSet(dimensionName1, dimensionValue1));
_metricsLogger.PutDimensions(new DimensionSet(dimensionName2, dimensionValue2));
_metricsLogger.PutDimensions(new DimensionSet(dimensionName1, dimensionValue3));
_metricsLogger.PutDimensions(new DimensionSet(dimensionName2, dimensionValue4));
_metricsLogger.Flush();

Assert.Equal(4, _sink.MetricsContext.GetAllDimensionSets()[0].DimensionKeys.Count);
Assert.Equal(dimensionValue3, _sink.MetricsContext.GetAllDimensionSets()[0].GetDimensionValue(dimensionName1));
Assert.Equal(dimensionValue4, _sink.MetricsContext.GetAllDimensionSets()[0].GetDimensionValue(dimensionName2));
}

[Fact]
public void TestSetPutDuplicateDimensions()
{
string dimensionName1 = "dim1";
string dimensionName2 = "dim2";
string dimensionName3 = "dim3";
string dimensionValue1 = "dimValue1";
string dimensionValue2 = "dimValue2";
string dimensionValue3 = "dimValue3";
string dimensionValue4 = "dimValue4";

_metricsLogger.PutDimensions(new DimensionSet(dimensionName1, dimensionValue1));
_metricsLogger.SetDimensions(new DimensionSet(dimensionName2, dimensionValue1));
_metricsLogger.PutDimensions(new DimensionSet(dimensionName3, dimensionValue2));
_metricsLogger.PutDimensions(new DimensionSet(dimensionName2, dimensionValue3));
_metricsLogger.PutDimensions(new DimensionSet(dimensionName3, dimensionValue4));
_metricsLogger.Flush();

Assert.Equal(2, _sink.MetricsContext.GetAllDimensionSets().Count);
Assert.Equal(dimensionValue3, _sink.MetricsContext.GetAllDimensionSets()[0].GetDimensionValue(dimensionName2));
Assert.Equal(dimensionValue4, _sink.MetricsContext.GetAllDimensionSets()[1].GetDimensionValue(dimensionName3));
}

[Fact]
public void TestSetNameSpace()
{
Expand Down