Skip to content

feat(metrics): Added runtime validation for the metric name #943

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 1 commit into from
Jul 28, 2025
Merged

feat(metrics): Added runtime validation for the metric name #943

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
4 changes: 4 additions & 0 deletions libraries/src/AWS.Lambda.Powertools.Metrics/Metrics.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,10 @@ void IMetrics.AddMetric(string key, double value, MetricUnit unit, MetricResolut
throw new ArgumentNullException(
nameof(key),
"'AddMetric' method requires a valid metrics key. 'Null' or empty values are not allowed.");
if (key.Length > 255)
throw new ArgumentOutOfRangeException(
nameof(key),
"'AddMetric' method requires a valid metrics key. Key exceeds the allowed length constraint.");

if (value < 0)
{
Expand Down
15 changes: 15 additions & 0 deletions libraries/tests/AWS.Lambda.Powertools.Metrics.Tests/MetricsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,21 @@ public void When_AddMetric_With_InvalidKey_Should_ThrowArgumentNullException(str
exception.Message);
}

[Fact]
public void When_AddMetric_With_TooLongKey_Should_ThrowArgumentOutOfRangeException()
{
// Arrange
Substitute.For<IMetrics>();
var powertoolsConfigMock = Substitute.For<IPowertoolsConfigurations>();
IMetrics metrics = new Metrics(powertoolsConfigMock);

// Act & Assert
var exception = Assert.Throws<ArgumentOutOfRangeException>(() => metrics.AddMetric("Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem.", 1.0));
Assert.Equal("key", exception.ParamName);
Assert.Contains("'AddMetric' method requires a valid metrics key. Key exceeds the allowed length constraint.",
exception.Message);
}

[Fact]
public void When_SetDefaultDimensions_With_InvalidKeyOrValue_Should_ThrowArgumentNullException()
{
Expand Down
Loading