Rename pushSingleMetric to flushSingleMetric.

phipag · phipag · commit b05634d94abb · 2025-06-05T12:34:37.000+02:00
diff --git a/docs/core/metrics.md b/docs/core/metrics.md
@@ -414,7 +414,7 @@ If you wish to set custom default dimensions, it can be done via `#!java metrics
 
 ### Creating a single metric with different configuration
 
-You can create a single metric with its own namespace and dimensions using `pushSingleMetric`:
+You can create a single metric with its own namespace and dimensions using `flushSingleMetric`:
 
 === "App.java"
 
@@ -430,7 +430,7 @@ You can create a single metric with its own namespace and dimensions using `push
         @Override
         @Metrics(namespace = "ServerlessAirline", service = "payment")
         public Object handleRequest(Object input, Context context) {
-            metricsLogger.pushSingleMetric(
+            metricsLogger.flushSingleMetric(
                 "CustomMetric",
                 1,
                 MetricUnit.COUNT,
diff --git a/examples/powertools-examples-core-utilities/cdk/app/src/main/java/helloworld/App.java b/examples/powertools-examples-core-utilities/cdk/app/src/main/java/helloworld/App.java
@@ -62,7 +62,7 @@ public APIGatewayProxyResponseEvent handleRequest(final APIGatewayProxyRequestEv
             "AnotherService", "CustomService",
             "AnotherService1", "CustomService1"
         );
-        metricsLogger.pushSingleMetric("CustomMetric2", 1, MetricUnit.COUNT, "Another", dimensionSet);
+        metricsLogger.flushSingleMetric("CustomMetric2", 1, MetricUnit.COUNT, "Another", dimensionSet);
 
         MDC.put("test", "willBeLogged");
 
@@ -105,4 +105,4 @@ private String getPageContents(String address) throws IOException {
             return br.lines().collect(Collectors.joining(System.lineSeparator()));
         }
     }
-}
+}
diff --git a/examples/powertools-examples-core-utilities/gradle/src/main/java/helloworld/App.java b/examples/powertools-examples-core-utilities/gradle/src/main/java/helloworld/App.java
@@ -63,7 +63,7 @@ public APIGatewayProxyResponseEvent handleRequest(final APIGatewayProxyRequestEv
             "AnotherService", "CustomService",
             "AnotherService1", "CustomService1"
         );
-        metricsLogger.pushSingleMetric("CustomMetric2", 1, MetricUnit.COUNT, "Another", dimensionSet);
+        metricsLogger.flushSingleMetric("CustomMetric2", 1, MetricUnit.COUNT, "Another", dimensionSet);
 
         MDC.put("test", "willBeLogged");
 
@@ -106,4 +106,4 @@ private String getPageContents(String address) throws IOException {
             return br.lines().collect(Collectors.joining(System.lineSeparator()));
         }
     }
-}
+}
diff --git a/examples/powertools-examples-core-utilities/kotlin/src/main/kotlin/helloworld/App.kt b/examples/powertools-examples-core-utilities/kotlin/src/main/kotlin/helloworld/App.kt
@@ -54,7 +54,7 @@ class App : RequestHandler<APIGatewayProxyRequestEvent?, APIGatewayProxyResponse
             "AnotherService", "CustomService",
             "AnotherService1", "CustomService1"
         )
-        metricsLogger.pushSingleMetric("CustomMetric2", 1.0, MetricUnit.COUNT, "Another", dimensionSet)
+        metricsLogger.flushSingleMetric("CustomMetric2", 1.0, MetricUnit.COUNT, "Another", dimensionSet)
         
         MDC.put("test", "willBeLogged")
         val response = APIGatewayProxyResponseEvent().withHeaders(headers)
@@ -96,4 +96,4 @@ class App : RequestHandler<APIGatewayProxyRequestEvent?, APIGatewayProxyResponse
             reader.readText().trim()
         }
     }
-}
+}
diff --git a/examples/powertools-examples-core-utilities/sam-graalvm/src/main/java/helloworld/App.java b/examples/powertools-examples-core-utilities/sam-graalvm/src/main/java/helloworld/App.java
@@ -64,7 +64,7 @@ public APIGatewayProxyResponseEvent handleRequest(final APIGatewayProxyRequestEv
             "AnotherService", "CustomService",
             "AnotherService1", "CustomService1"
         );
-        metricsLogger.pushSingleMetric("CustomMetric2", 1, MetricUnit.COUNT, "Another", dimensionSet);
+        metricsLogger.flushSingleMetric("CustomMetric2", 1, MetricUnit.COUNT, "Another", dimensionSet);
 
         metricsLogger.addMetric("CustomMetric3", 1, MetricUnit.COUNT, MetricResolution.HIGH);
 
@@ -109,4 +109,4 @@ private String getPageContents(String address) throws IOException {
             return br.lines().collect(Collectors.joining(System.lineSeparator()));
         }
     }
-}
+}
diff --git a/examples/powertools-examples-core-utilities/sam/src/main/java/helloworld/App.java b/examples/powertools-examples-core-utilities/sam/src/main/java/helloworld/App.java
@@ -66,7 +66,7 @@ public APIGatewayProxyResponseEvent handleRequest(final APIGatewayProxyRequestEv
         DimensionSet dimensionSet = new DimensionSet();
         dimensionSet.addDimension("AnotherService", "CustomService");
         dimensionSet.addDimension("AnotherService1", "CustomService1");
-        metricsLogger.pushSingleMetric("CustomMetric2", 1, MetricUnit.COUNT, "Another", dimensionSet);
+        metricsLogger.flushSingleMetric("CustomMetric2", 1, MetricUnit.COUNT, "Another", dimensionSet);
 
         metricsLogger.addMetric("CustomMetric3", 1, MetricUnit.COUNT, MetricResolution.HIGH);
 
diff --git a/examples/powertools-examples-core-utilities/serverless/src/main/java/helloworld/App.java b/examples/powertools-examples-core-utilities/serverless/src/main/java/helloworld/App.java
@@ -63,7 +63,7 @@ public APIGatewayProxyResponseEvent handleRequest(final APIGatewayProxyRequestEv
             "AnotherService", "CustomService",
             "AnotherService1", "CustomService1"
         );
-        metricsLogger.pushSingleMetric("CustomMetric2", 1, MetricUnit.COUNT, "Another", dimensionSet);
+        metricsLogger.flushSingleMetric("CustomMetric2", 1, MetricUnit.COUNT, "Another", dimensionSet);
 
         MDC.put("test", "willBeLogged");
 
@@ -101,4 +101,4 @@ private String getPageContents(String address) throws IOException {
             return br.lines().collect(Collectors.joining(System.lineSeparator()));
         }
     }
-}
+}
diff --git a/examples/powertools-examples-core-utilities/terraform/src/main/java/helloworld/App.java b/examples/powertools-examples-core-utilities/terraform/src/main/java/helloworld/App.java
@@ -63,7 +63,7 @@ public APIGatewayProxyResponseEvent handleRequest(final APIGatewayProxyRequestEv
             "AnotherService", "CustomService",
             "AnotherService1", "CustomService1"
         );
-        metricsLogger.pushSingleMetric("CustomMetric2", 1, MetricUnit.COUNT, "Another", dimensionSet);
+        metricsLogger.flushSingleMetric("CustomMetric2", 1, MetricUnit.COUNT, "Another", dimensionSet);
 
         MDC.put("test", "willBeLogged");
 
@@ -101,4 +101,4 @@ private String getPageContents(String address) throws IOException {
             return br.lines().collect(Collectors.joining(System.lineSeparator()));
         }
     }
-}
+}
diff --git a/powertools-metrics/src/main/java/software/amazon/lambda/powertools/metrics/MetricsLogger.java b/powertools-metrics/src/main/java/software/amazon/lambda/powertools/metrics/MetricsLogger.java
@@ -152,7 +152,7 @@ default void captureColdStartMetric() {
     }
 
     /**
-     * Push a single metric with custom dimensions. This creates a separate metrics context
+     * Flush a single metric with custom dimensions. This creates a separate metrics context
      * that doesn't affect the default metrics context.
      *
      * @param name       the name of the metric
@@ -161,19 +161,18 @@ default void captureColdStartMetric() {
      * @param namespace  the namespace for the metric
      * @param dimensions custom dimensions for this metric (optional)
      */
-    void pushSingleMetric(String name, double value, MetricUnit unit, String namespace,
-            DimensionSet dimensions);
+    void flushSingleMetric(String name, double value, MetricUnit unit, String namespace, DimensionSet dimensions);
 
     /**
-     * Push a single metric with custom dimensions. This creates a separate metrics context
+     * Flush a single metric with custom dimensions. This creates a separate metrics context
      * that doesn't affect the default metrics context.
      *
      * @param name       the name of the metric
      * @param value      the value of the metric
      * @param unit       the unit of the metric
      * @param namespace  the namespace for the metric
      */
-    default void pushSingleMetric(String name, double value, MetricUnit unit, String namespace) {
-        pushSingleMetric(name, value, unit, namespace, null);
+    default void flushSingleMetric(String name, double value, MetricUnit unit, String namespace) {
+        flushSingleMetric(name, value, unit, namespace, null);
     }
 }
diff --git a/powertools-metrics/src/main/java/software/amazon/lambda/powertools/metrics/internal/EmfMetricsLogger.java b/powertools-metrics/src/main/java/software/amazon/lambda/powertools/metrics/internal/EmfMetricsLogger.java
@@ -201,7 +201,7 @@ public void captureColdStartMetric(software.amazon.lambda.powertools.metrics.mod
     }
 
     @Override
-    public void pushSingleMetric(String name, double value, MetricUnit unit, String namespace,
+    public void flushSingleMetric(String name, double value, MetricUnit unit, String namespace,
             software.amazon.lambda.powertools.metrics.model.DimensionSet dimensions) {
         Validator.validateNamespace(namespace);
 
diff --git a/powertools-metrics/src/test/java/software/amazon/lambda/powertools/metrics/internal/EmfMetricsLoggerTest.java b/powertools-metrics/src/test/java/software/amazon/lambda/powertools/metrics/internal/EmfMetricsLoggerTest.java
@@ -424,12 +424,12 @@ void shouldReuseNamespaceForColdStartMetric() throws Exception {
     }
 
     @Test
-    void shouldPushSingleMetric() throws Exception {
+    void shouldFlushSingleMetric() throws Exception {
         // Given
         DimensionSet dimensions = DimensionSet.of("CustomDim", "CustomValue");
 
         // When
-        metricsLogger.pushSingleMetric("single-metric", 200, MetricUnit.COUNT, "SingleNamespace", dimensions);
+        metricsLogger.flushSingleMetric("single-metric", 200, MetricUnit.COUNT, "SingleNamespace", dimensions);
 
         // Then
         String emfOutput = outputStreamCaptor.toString().trim();
@@ -444,9 +444,9 @@ void shouldPushSingleMetric() throws Exception {
     }
 
     @Test
-    void shouldPushSingleMetricWithoutDimensions() throws Exception {
+    void shouldFlushSingleMetricWithoutDimensions() throws Exception {
         // When
-        metricsLogger.pushSingleMetric("single-metric", 200, MetricUnit.COUNT, "SingleNamespace");
+        metricsLogger.flushSingleMetric("single-metric", 200, MetricUnit.COUNT, "SingleNamespace");
 
         // Then
         String emfOutput = outputStreamCaptor.toString().trim();
diff --git a/powertools-metrics/src/test/java/software/amazon/lambda/powertools/metrics/testutils/TestMetricsLogger.java b/powertools-metrics/src/test/java/software/amazon/lambda/powertools/metrics/testutils/TestMetricsLogger.java
@@ -72,7 +72,7 @@ public void captureColdStartMetric(DimensionSet dimensions) {
     }
 
     @Override
-    public void pushSingleMetric(String name, double value, MetricUnit unit, String namespace,
+    public void flushSingleMetric(String name, double value, MetricUnit unit, String namespace,
             DimensionSet dimensions) {
         // Test placeholder
     }

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ public APIGatewayProxyResponseEvent handleRequest(final APIGatewayProxyRequestEv`
`62`	`62`	`"AnotherService", "CustomService",`
`63`	`63`	`"AnotherService1", "CustomService1"`
`64`	`64`	`);`
`65`		`- metricsLogger.pushSingleMetric("CustomMetric2", 1, MetricUnit.COUNT, "Another", dimensionSet);`
	`65`	`+ metricsLogger.flushSingleMetric("CustomMetric2", 1, MetricUnit.COUNT, "Another", dimensionSet);`
`66`	`66`
`67`	`67`	`MDC.put("test", "willBeLogged");`
`68`	`68`
`@@ -105,4 +105,4 @@ private String getPageContents(String address) throws IOException {`
`105`	`105`	`return br.lines().collect(Collectors.joining(System.lineSeparator()));`
`106`	`106`	`}`
`107`	`107`	`}`
`108`		`-}`
	`108`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ public APIGatewayProxyResponseEvent handleRequest(final APIGatewayProxyRequestEv`
`63`	`63`	`"AnotherService", "CustomService",`
`64`	`64`	`"AnotherService1", "CustomService1"`
`65`	`65`	`);`
`66`		`- metricsLogger.pushSingleMetric("CustomMetric2", 1, MetricUnit.COUNT, "Another", dimensionSet);`
	`66`	`+ metricsLogger.flushSingleMetric("CustomMetric2", 1, MetricUnit.COUNT, "Another", dimensionSet);`
`67`	`67`
`68`	`68`	`MDC.put("test", "willBeLogged");`
`69`	`69`
`@@ -106,4 +106,4 @@ private String getPageContents(String address) throws IOException {`
`106`	`106`	`return br.lines().collect(Collectors.joining(System.lineSeparator()));`
`107`	`107`	`}`
`108`	`108`	`}`
`109`		`-}`
	`109`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ class App : RequestHandler<APIGatewayProxyRequestEvent?, APIGatewayProxyResponse`
`54`	`54`	`"AnotherService", "CustomService",`
`55`	`55`	`"AnotherService1", "CustomService1"`
`56`	`56`	`)`
`57`		`- metricsLogger.pushSingleMetric("CustomMetric2", 1.0, MetricUnit.COUNT, "Another", dimensionSet)`
	`57`	`+ metricsLogger.flushSingleMetric("CustomMetric2", 1.0, MetricUnit.COUNT, "Another", dimensionSet)`
`58`	`58`
`59`	`59`	`MDC.put("test", "willBeLogged")`
`60`	`60`	`val response = APIGatewayProxyResponseEvent().withHeaders(headers)`
`@@ -96,4 +96,4 @@ class App : RequestHandler<APIGatewayProxyRequestEvent?, APIGatewayProxyResponse`
`96`	`96`	`reader.readText().trim()`
`97`	`97`	`}`
`98`	`98`	`}`
`99`		`-}`
	`99`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ public APIGatewayProxyResponseEvent handleRequest(final APIGatewayProxyRequestEv`
`64`	`64`	`"AnotherService", "CustomService",`
`65`	`65`	`"AnotherService1", "CustomService1"`
`66`	`66`	`);`
`67`		`- metricsLogger.pushSingleMetric("CustomMetric2", 1, MetricUnit.COUNT, "Another", dimensionSet);`
	`67`	`+ metricsLogger.flushSingleMetric("CustomMetric2", 1, MetricUnit.COUNT, "Another", dimensionSet);`
`68`	`68`
`69`	`69`	`metricsLogger.addMetric("CustomMetric3", 1, MetricUnit.COUNT, MetricResolution.HIGH);`
`70`	`70`
`@@ -109,4 +109,4 @@ private String getPageContents(String address) throws IOException {`
`109`	`109`	`return br.lines().collect(Collectors.joining(System.lineSeparator()));`
`110`	`110`	`}`
`111`	`111`	`}`
`112`		`-}`
	`112`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -201,7 +201,7 @@ public void captureColdStartMetric(software.amazon.lambda.powertools.metrics.mod`
`201`	`201`	`}`
`202`	`202`
`203`	`203`	`@Override`
`204`		`- public void pushSingleMetric(String name, double value, MetricUnit unit, String namespace,`
	`204`	`+ public void flushSingleMetric(String name, double value, MetricUnit unit, String namespace,`
`205`	`205`	`software.amazon.lambda.powertools.metrics.model.DimensionSet dimensions) {`
`206`	`206`	`Validator.validateNamespace(namespace);`
`207`	`207`