Skip to content

Commit

Permalink
refactor(metrics): standardize parameter names for metric methods to …
Browse files Browse the repository at this point in the history 
…improve clarity
  • Loading branch information
@hjgraca
hjgraca committed Feb 22, 2025
1 parent 1690fef commit 1756ce1
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 24 deletions.
38 changes: 19 additions & 19 deletions libraries/src/AWS.Lambda.Powertools.Metrics/Metrics.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ internal Metrics(IPowertoolsConfigurations powertoolsConfigurations, string name
}

/// <inheritdoc />
void IMetrics.AddMetric(string key, double value, MetricUnit unit, MetricResolution metricResolution)
void IMetrics.AddMetric(string key, double value, MetricUnit unit, MetricResolution resolution)
{
if (Instance != null)
{
Expand All @@ -160,7 +160,7 @@ void IMetrics.AddMetric(string key, double value, MetricUnit unit, MetricResolut
Instance.Flush(true);
}

_context.AddMetric(key, value, unit, metricResolution);
_context.AddMetric(key, value, unit, resolution);
}
}
else
Expand Down Expand Up @@ -216,14 +216,14 @@ void IMetrics.AddMetadata(string key, object value)
}

/// <inheritdoc />
void IMetrics.SetDefaultDimensions(Dictionary<string, string> defaultDimension)
void IMetrics.SetDefaultDimensions(Dictionary<string, string> defaultDimensions)
{
foreach (var item in defaultDimension)
foreach (var item in defaultDimensions)
if (string.IsNullOrWhiteSpace(item.Key) || string.IsNullOrWhiteSpace(item.Value))
throw new ArgumentNullException(nameof(item.Key),
"'SetDefaultDimensions' method requires a valid key pair. 'Null' or empty values are not allowed.");

_context.SetDefaultDimensions(DictionaryToList(defaultDimension));
_context.SetDefaultDimensions(DictionaryToList(defaultDimensions));
}

/// <inheritdoc />
Expand Down Expand Up @@ -294,11 +294,11 @@ private Dictionary<string, string> GetDefaultDimensions()
}

/// <inheritdoc />
void IMetrics.PushSingleMetric(string metricName, double value, MetricUnit unit, string nameSpace,
string service, Dictionary<string, string> defaultDimensions, MetricResolution metricResolution)
void IMetrics.PushSingleMetric(string name, double value, MetricUnit unit, string nameSpace,
string service, Dictionary<string, string> defaultDimensions, MetricResolution resolution)
{
if (string.IsNullOrWhiteSpace(metricName))
throw new ArgumentNullException(nameof(metricName),
if (string.IsNullOrWhiteSpace(name))
throw new ArgumentNullException(nameof(name),
"'PushSingleMetric' method requires a valid metrics key. 'Null' or empty values are not allowed.");

var context = new MetricsContext();
Expand All @@ -311,7 +311,7 @@ void IMetrics.PushSingleMetric(string metricName, double value, MetricUnit unit,
context.SetDefaultDimensions(defaultDimensionsList);
}

context.AddMetric(metricName, value, unit, metricResolution);
context.AddMetric(name, value, unit, resolution);

Flush(context);
}
Expand Down Expand Up @@ -345,11 +345,11 @@ protected virtual void Dispose(bool disposing)
/// <param name="key">Metric Key. Must not be null, empty or whitespace</param>
/// <param name="value">Metric Value</param>
/// <param name="unit">Metric Unit</param>
/// <param name="metricResolution"></param>
/// <param name="resolution"></param>
public static void AddMetric(string key, double value, MetricUnit unit = MetricUnit.None,
MetricResolution metricResolution = MetricResolution.Default)
MetricResolution resolution = MetricResolution.Default)
{
Instance.AddMetric(key, value, unit, metricResolution);
Instance.AddMetric(key, value, unit, resolution);
}

/// <summary>
Expand Down Expand Up @@ -438,21 +438,21 @@ private void Flush(MetricsContext context)
/// Pushes single metric to CloudWatch using Embedded Metric Format. This can be used to push metrics with a different
/// context.
/// </summary>
/// <param name="metricName">Metric Name. Metric key cannot be null, empty or whitespace</param>
/// <param name="name">Metric Name. Metric key cannot be null, empty or whitespace</param>
/// <param name="value">Metric Value</param>
/// <param name="unit">Metric Unit</param>
/// <param name="nameSpace">Metric Namespace</param>
/// <param name="service">Service Name</param>
/// <param name="defaultDimensions">Default dimensions list</param>
/// <param name="metricResolution">Metrics resolution</param>
public static void PushSingleMetric(string metricName, double value, MetricUnit unit, string nameSpace = null,
/// <param name="resolution">Metrics resolution</param>
public static void PushSingleMetric(string name, double value, MetricUnit unit, string nameSpace = null,
string service = null, Dictionary<string, string> defaultDimensions = null,
MetricResolution metricResolution = MetricResolution.Default)
MetricResolution resolution = MetricResolution.Default)
{
if (Instance != null)
{
Instance.PushSingleMetric(metricName, value, unit, nameSpace, service, defaultDimensions,
metricResolution);
Instance.PushSingleMetric(name, value, unit, nameSpace, service, defaultDimensions,
resolution);
}
else
{
Expand Down
8 changes: 4 additions & 4 deletions libraries/tests/AWS.Lambda.Powertools.Metrics.Tests/Handlers/FunctionHandler.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@ public void AddDimensions()
[Metrics(Namespace = "dotnet-powertools-test", Service = "ServiceName", CaptureColdStart = true)]
public void AddMultipleDimensions()
{
Metrics.PushSingleMetric("SingleMetric1", 1, MetricUnit.Count, metricResolution: MetricResolution.High,
Metrics.PushSingleMetric("SingleMetric1", 1, MetricUnit.Count, resolution: MetricResolution.High,
defaultDimensions: new Dictionary<string, string> {
{ "Default1", "SingleMetric1" }
});

Metrics.PushSingleMetric("SingleMetric2", 1, MetricUnit.Count, metricResolution: MetricResolution.High, nameSpace: "ns2",
Metrics.PushSingleMetric("SingleMetric2", 1, MetricUnit.Count, resolution: MetricResolution.High, nameSpace: "ns2",
defaultDimensions: new Dictionary<string, string> {
{ "Default1", "SingleMetric2" },
{ "Default2", "SingleMetric2" }
Expand All @@ -59,7 +59,7 @@ public void AddMultipleDimensions()
[Metrics(Namespace = "ExampleApplication")]
public void PushSingleMetricWithNamespace()
{
Metrics.PushSingleMetric("SingleMetric", 1, MetricUnit.Count, metricResolution: MetricResolution.High,
Metrics.PushSingleMetric("SingleMetric", 1, MetricUnit.Count, resolution: MetricResolution.High,
defaultDimensions: new Dictionary<string, string> {
{ "Default", "SingleMetric" }
});
Expand All @@ -68,7 +68,7 @@ public void PushSingleMetricWithNamespace()
[Metrics]
public void PushSingleMetricWithEnvNamespace()
{
Metrics.PushSingleMetric("SingleMetric", 1, MetricUnit.Count, metricResolution: MetricResolution.High,
Metrics.PushSingleMetric("SingleMetric", 1, MetricUnit.Count, resolution: MetricResolution.High,
defaultDimensions: new Dictionary<string, string> {
{ "Default", "SingleMetric" }
});
Expand Down
2 changes: 1 addition & 1 deletion libraries/tests/e2e/functions/core/metrics/Function/src/Function/TestHelper.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public static void TestMethod(APIGatewayProxyRequest apigwProxyEvent, ILambdaCon
Metrics.AddMetadata("RequestId", apigwProxyEvent.RequestContext.RequestId);

Metrics.PushSingleMetric(
metricName: "SingleMetric",
name: "SingleMetric",
value: 1,
unit: MetricUnit.Count,
nameSpace: "Test",
Expand Down

0 comments on commit 1756ce1

Please sign in to comment.