Rename withMetric to withMetricsLogger

Author: humanzz

docs/core/metrics.md

@@ -242,18 +242,18 @@ Use `withMetric` if you have one or more metrics that should have different conf
 === "App.java"
 
     ```java hl_lines="7 8 9 10 11 12 13" 
-    import static software.amazon.lambda.powertools.metrics.MetricsUtils.withMetric;
+    import static software.amazon.lambda.powertools.metrics.MetricsUtils.withMetricsLogger;
 
     public class App implements RequestHandler<Object, Object> {
 
         @Override
         public Object handleRequest(Object input, Context context) {
-             withMetric(metric -> {
+             withMetricsLogger(logger -> {
                 // override default dimensions
-                metric.setDimensions(DimensionSet.of("AnotherService", "CustomService"));
+                logger.setDimensions(DimensionSet.of("AnotherService", "CustomService"));
                 // add metrics
-                metric.putMetric("CustomMetrics1", 1, Unit.COUNT);
-                metric.putMetric("CustomMetrics2", 5, Unit.COUNT);
+                logger.putMetric("CustomMetrics1", 1, Unit.COUNT);
+                logger.putMetric("CustomMetrics2", 5, Unit.COUNT);
             });
         }
     }

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) {
-        withMetric(metricsLogger -> {
+        withMetricLogger(metricsLogger -> {
             metricsLogger.putMetric(name, value, unit);
             logger.accept(metricsLogger);
         });
@@ -103,22 +103,22 @@ public static void withSingleMetric(final String name,
                                         final Unit unit,
                                         final String namespace,
                                         final Consumer<MetricsLogger> logger) {
-        withMetric(metricsLogger -> {
+        withMetricLogger(metricsLogger -> {
             metricsLogger.setNamespace(namespace);
             metricsLogger.putMetric(name, value, unit);
             logger.accept(metricsLogger);
         });
     }
 
     /**
-     * Provide and immediately flush a {@link MetricsLogger}. It will use the default namespace
+     * 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
      */
-    public static void withMetric(final Consumer<MetricsLogger> logger) {
+    public static void withMetricLogger(final Consumer<MetricsLogger> logger) {
         MetricsLogger metricsLogger = logger();
 
         try {

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

@@ -6,7 +6,6 @@
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.BeforeEach;
@@ -16,9 +15,9 @@
 import software.amazon.cloudwatchlogs.emf.model.DimensionSet;
 import software.amazon.cloudwatchlogs.emf.model.Unit;
 
-import static java.util.Collections.*;
-import static org.assertj.core.api.Assertions.*;
+import static java.util.Collections.emptyMap;
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatNullPointerException;
 import static org.mockito.Mockito.mockStatic;
 import static software.amazon.lambda.powertools.core.internal.SystemWrapper.getenv;
 
@@ -124,14 +123,14 @@ void singleMetricsCaptureUtilityWithDefaultNameSpace() {
     }
 
     @Test
-    void metricsCaptureUtilityWithDefaultNameSpace() {
+    void metricsLoggerCaptureUtilityWithDefaultNameSpace() {
         try (MockedStatic<SystemWrapper> mocked = mockStatic(SystemWrapper.class);
              MockedStatic<software.amazon.lambda.powertools.core.internal.SystemWrapper> internalWrapper = mockStatic(software.amazon.lambda.powertools.core.internal.SystemWrapper.class)) {
             mocked.when(() -> SystemWrapper.getenv("AWS_EMF_ENVIRONMENT")).thenReturn("Lambda");
             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.withMetric(metricsLogger -> {
+            MetricsUtils.withMetricLogger(metricsLogger -> {
                 metricsLogger.setDimensions(DimensionSet.of("Dimension1", "Value1"));
                 metricsLogger.putMetric("Metric1", 1, Unit.COUNT);
             });