Skip to content

chore(metrics): deprecate withMetricLogger in favor of withMetricsLogger #1060

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 5 commits into from
Feb 23, 2023
Merged

chore(metrics): deprecate withMetricLogger in favor of withMetricsLogger #1060

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
89f379a
chore(metrics): deprecated MetricsUtils.withMetricLogger in favor of …
humanzz Feb 20, 2023
876d17f
Update powertools-metrics/src/main/java/software/amazon/lambda/powert…
humanzz Feb 21, 2023
8f0105b
Add @Deprecated and test deprecated method
humanzz Feb 21, 2023
508bb7d
Merge branch 'master' into typometrics
humanzz Feb 21, 2023
bc86d36
rename testWithNewLogger to testLogger
humanzz Feb 21, 2023
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
21 changes: 18 additions & 3 deletions powertools-metrics/src/main/java/software/amazon/lambda/powertools/metrics/MetricsUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
});
Expand All @@ -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);
Expand All @@ -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 {
Expand All @@ -130,6 +130,21 @@ 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
*/
@Deprecated
public static void withMetricLogger(final Consumer<MetricsLogger> logger) {
withMetricsLogger(logger);
}

public static DimensionSet[] getDefaultDimensions() {
return Arrays.copyOf(defaultDimensions, defaultDimensions.length);
}
Expand Down
27 changes: 19 additions & 8 deletions ...ls-metrics/src/test/java/software/amazon/lambda/powertools/metrics/MetricsLoggerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
import java.util.Map;
import java.util.function.Consumer;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
Expand All @@ -12,6 +13,7 @@
import org.junit.jupiter.api.Test;
import org.mockito.MockedStatic;
import software.amazon.cloudwatchlogs.emf.config.SystemWrapper;
import software.amazon.cloudwatchlogs.emf.logger.MetricsLogger;
import software.amazon.cloudwatchlogs.emf.model.DimensionSet;
import software.amazon.cloudwatchlogs.emf.model.Unit;

Expand Down Expand Up @@ -124,13 +126,29 @@ void singleMetricsCaptureUtilityWithDefaultNameSpace() {

@Test
void metricsLoggerCaptureUtilityWithDefaultNameSpace() {
testLogger(MetricsUtils::withMetricsLogger);
}

@Test
void deprecatedMetricLoggerCaptureUtilityWithDefaultNameSpace() {
testLogger(MetricsUtils::withMetricLogger);
}

@Test
void shouldThrowExceptionWhenDefaultDimensionIsNull() {
assertThatNullPointerException()
.isThrownBy(() -> MetricsUtils.defaultDimensionSet(null))
.withMessage("Null dimension set not allowed");
}

private void testLogger(Consumer<Consumer<MetricsLogger>> methodToTest) {
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.withMetricLogger(metricsLogger -> {
methodToTest.accept(metricsLogger -> {
metricsLogger.setDimensions(DimensionSet.of("Dimension1", "Value1"));
metricsLogger.putMetric("Metric1", 1, Unit.COUNT);
});
Expand All @@ -154,13 +172,6 @@ void metricsLoggerCaptureUtilityWithDefaultNameSpace() {
}
}

@Test
void shouldThrowExceptionWhenDefaultDimensionIsNull() {
assertThatNullPointerException()
.isThrownBy(() -> MetricsUtils.defaultDimensionSet(null))
.withMessage("Null dimension set not allowed");
}

private Map<String, Object> readAsJson(String s) {
try {
return mapper.readValue(s, Map.class);
Expand Down