chore(metrics): deprecated MetricsUtils.withMetricLogger in favor of MetricsUtils.withMetricsLogger

closes aws-powertools#1059

Author: humanzz

powertools-metrics/src/main/java/software/amazon/lambda/powertools/metrics/MetricsUtils.java

@@ -81,7 +81,7 @@ public static void withSingleMetric(final String name,
                                         final double value,
                                         final Unit unit,
                                         final Consumer<MetricsLogger> logger) {
-        withMetricLogger(metricsLogger -> {
+        withMetricsLogger(metricsLogger -> {
             metricsLogger.putMetric(name, value, unit);
             logger.accept(metricsLogger);
         });
@@ -103,7 +103,7 @@ public static void withSingleMetric(final String name,
                                         final Unit unit,
                                         final String namespace,
                                         final Consumer<MetricsLogger> logger) {
-        withMetricLogger(metricsLogger -> {
+        withMetricsLogger(metricsLogger -> {
             metricsLogger.setNamespace(namespace);
             metricsLogger.putMetric(name, value, unit);
             logger.accept(metricsLogger);
@@ -118,7 +118,7 @@ public static void withSingleMetric(final String name,
      *
      * @param logger the MetricsLogger
      */
-    public static void withMetricLogger(final Consumer<MetricsLogger> logger) {
+    public static void withMetricsLogger(final Consumer<MetricsLogger> logger) {
         MetricsLogger metricsLogger = logger();
 
         try {
@@ -130,6 +130,20 @@ public static void withMetricLogger(final Consumer<MetricsLogger> logger) {
         }
     }
 
+    /**
+     * Provide and immediately flush a {@link MetricsLogger}. It uses the default namespace
+     * specified either on {@link Metrics} annotation or via POWERTOOLS_METRICS_NAMESPACE env var.
+     * It by default captures function_request_id as property if used together with {@link Metrics} annotation. It will also
+     * capture xray_trace_id as property if tracing is enabled.
+     *
+     * @param logger the MetricsLogger
+     *
+     * @deprecated use {@link MetricsUtils#withMetricsLogger} instead
+     */
+    public static void withMetricLogger(final Consumer<MetricsLogger> logger) {
+        withMetricLogger(logger);
+    }
+
     public static DimensionSet[] getDefaultDimensions() {
         return Arrays.copyOf(defaultDimensions, defaultDimensions.length);
     }

powertools-metrics/src/test/java/software/amazon/lambda/powertools/metrics/MetricsLoggerTest.java

@@ -130,7 +130,7 @@ void metricsLoggerCaptureUtilityWithDefaultNameSpace() {
             mocked.when(() -> SystemWrapper.getenv("POWERTOOLS_METRICS_NAMESPACE")).thenReturn("GlobalName");
             internalWrapper.when(() -> getenv("_X_AMZN_TRACE_ID")).thenReturn("Root=1-5759e988-bd862e3fe1be46a994272793;Parent=53995c3f42cd8ad8;Sampled=1\"");
 
-            MetricsUtils.withMetricLogger(metricsLogger -> {
+            MetricsUtils.withMetricsLogger(metricsLogger -> {
                 metricsLogger.setDimensions(DimensionSet.of("Dimension1", "Value1"));
                 metricsLogger.putMetric("Metric1", 1, Unit.COUNT);
             });