Skip to content

feat: capture metrics even when handler results in exception #286

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.

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 2 commits into from
Feb 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 5 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ on:
- 'powertools-tracing/**'
- 'powertools-validation/**'
- 'powertools-parameters/**'
- 'powertools-metrics/**'
- 'pom.xml'
- '.github/workflows/**'
push:
Expand All @@ -21,8 +22,11 @@ on:
- 'powertools-logging/**'
- 'powertools-sqs/**'
- 'powertools-tracing/**'
- 'powertools-validation/**'
- 'powertools-parameters/**'
- 'powertools-metrics/**'
- 'pom.xml'

- '.github/workflows/**'
jobs:
build:
runs-on: ubuntu-latest
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,12 @@ public Object around(ProceedingJoinPoint pjp,
coldStartSingleMetricIfApplicable(pjp, metrics);

try {
Object proceed = pjp.proceed(proceedArgs);
return pjp.proceed(proceedArgs);

} finally {
coldStartDone();

validateBeforeFlushingMetrics(metrics);

validateMetricsAndRefreshOnFailure(metrics);
logger.flush();
return proceed;

} finally {
refreshMetricsContext();
}
}
Expand Down Expand Up @@ -105,6 +101,16 @@ private String service(Metrics metrics) {
return !"".equals(metrics.service()) ? metrics.service() : serviceName();
}

private void validateMetricsAndRefreshOnFailure(Metrics metrics) {
try {

validateBeforeFlushingMetrics(metrics);
} catch (ValidationException e){
refreshMetricsContext();
throw e;
}
}

// This can be simplified after this issues https://github.com/awslabs/aws-embedded-metrics-java/issues/35 is fixed
private static void refreshMetricsContext() {
try {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
package software.amazon.lambda.powertools.metrics.handlers;

import com.amazonaws.services.lambda.runtime.Context;
import com.amazonaws.services.lambda.runtime.RequestHandler;
import software.amazon.cloudwatchlogs.emf.logger.MetricsLogger;
import software.amazon.lambda.powertools.metrics.Metrics;

import static software.amazon.lambda.powertools.metrics.MetricsUtils.metricsLogger;

public class PowertoolsMetricsWithExceptionInHandler implements RequestHandler<Object, Object> {

@Override
@Metrics(namespace = "ExampleApplication", service = "booking")
public Object handleRequest(Object input, Context context) {
MetricsLogger metricsLogger = metricsLogger();
metricsLogger.putMetric("CoolMetric", 1);
throw new IllegalStateException("Whoops, unexpected exception");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import software.amazon.lambda.powertools.metrics.handlers.PowertoolsMetricsNoDimensionsHandler;
import software.amazon.lambda.powertools.metrics.handlers.PowertoolsMetricsNoExceptionWhenNoMetricsHandler;
import software.amazon.lambda.powertools.metrics.handlers.PowertoolsMetricsTooManyDimensionsHandler;
import software.amazon.lambda.powertools.metrics.handlers.PowertoolsMetricsWithExceptionInHandler;

import static java.util.Collections.emptyMap;
import static org.apache.commons.lang3.reflect.FieldUtils.writeStaticField;
Expand Down Expand Up @@ -233,6 +234,26 @@ public void exceptionWhenTooManyDimensionsSet() {
}
}

@Test
public void metricsPublishedEvenHandlerThrowsException() {
requestHandler = new PowertoolsMetricsWithExceptionInHandler();
try (MockedStatic<SystemWrapper> mocked = mockStatic(SystemWrapper.class)) {
mocked.when(() -> SystemWrapper.getenv("AWS_EMF_ENVIRONMENT")).thenReturn("Lambda");
assertThatExceptionOfType(IllegalStateException.class)
.isThrownBy(() -> requestHandler.handleRequest("input", context))
.withMessage("Whoops, unexpected exception");

assertThat(out.toString())
.satisfies(s -> {
Map<String, Object> logAsJson = readAsJson(s);
assertThat(logAsJson)
.containsEntry("CoolMetric", 1.0)
.containsEntry("Service", "booking")
.containsKey("_aws");
});
}
}

private void setupContext() {
when(context.getFunctionName()).thenReturn("testFunction");
when(context.getInvokedFunctionArn()).thenReturn("testArn");
Expand Down