Skip to content

additional cw-metrics #298

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
ammokhov merged 3 commits into from
Aug 21, 2020
Merged

additional cw-metrics #298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1bd0222
additional cw-metrics
ammokhov Aug 18, 2020
62d3e8b
added 0-value for non-exception events by error code
ammokhov Aug 19, 2020
bac7194
refactored metrics
ammokhov Aug 21, 2020
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: 21 additions & 0 deletions src/main/java/software/amazon/cloudformation/LambdaWrapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import java.time.Instant;
import java.util.Arrays;
import java.util.Date;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
Expand Down Expand Up @@ -231,6 +232,11 @@ public void handleRequest(final InputStream inputStream, final OutputStream outp
} finally {
// A response will be output on all paths, though CloudFormation will
// not block on invoking the handlers, but rather listen for callbacks

if (handlerResponse != null) {
publishExceptionCodeAndCountMetric(request == null ? null : request.getAction(), handlerResponse.getErrorCode(),
handlerResponse.getStatus() == OperationStatus.FAILED);
}
writeResponse(outputStream, handlerResponse);
}
}
Expand Down Expand Up @@ -471,6 +477,21 @@ private void publishExceptionMetric(final Action action, final Throwable ex, fin
}
}

/*
* null-safe exception metrics delivery
*/
private void
publishExceptionCodeAndCountMetric(final Action action, final HandlerErrorCode handlerErrorCode, final boolean thrown) {
if (this.metricsPublisherProxy != null) {
EnumSet.allOf(HandlerErrorCode.class).stream()
// publishing 0 value for all (if not thrown) otherwise filtered
.filter(errorCode -> errorCode.equals(handlerErrorCode) || !thrown)
Copy link

@wbingli wbingli Aug 21, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line can be removed. We actually want to do forEach for all ErrorCode, not match in what cases.

In case of in a Failed cases, this will only emit metric 1 for the one equals to the ErrorCode, but won't emit 0 metric for other metrics.

.forEach(errorCode -> this.metricsPublisherProxy.publishExceptionByErrorCodeMetric(Instant.now(), action,
errorCode, thrown));
this.metricsPublisherProxy.publishExceptionCountMetric(Instant.now(), action, thrown);
}
}

/**
* null-safe logger redirect
*
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/software/amazon/cloudformation/metrics/Metric.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ public class Metric {

public static final String METRIC_NAMESPACE_ROOT = "AWS/CloudFormation";
public static final String METRIC_NAME_HANDLER_EXCEPTION = "HandlerException";
public static final String METRIC_NAME_HANDLER_EXCEPTION_BY_ERROR_CODE = "HandlerExceptionByErrorCode";
public static final String METRIC_NAME_HANDLER_EXCEPTION_BY_EXCEPTION_COUNT = "HandlerExceptionByExceptionCount";
public static final String METRIC_NAME_HANDLER_DURATION = "HandlerInvocationDuration";
public static final String METRIC_NAME_HANDLER_INVOCATION_COUNT = "HandlerInvocationCount";

Expand Down
9 changes: 9 additions & 0 deletions src/main/java/software/amazon/cloudformation/metrics/MetricsPublisher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,15 @@ public void publishExceptionMetric(final Instant timestamp,
final HandlerErrorCode handlerErrorCode) {
}

public void publishExceptionByErrorCodeMetric(final Instant timestamp,
final Action action,
final HandlerErrorCode handlerErrorCode,
final boolean thrown) {
}

public void publishExceptionCountMetric(final Instant timestamp, final Action action, final boolean thrown) {
}

public void publishInvocationMetric(final Instant timestamp, final Action action) {
}

Expand Down
21 changes: 21 additions & 0 deletions src/main/java/software/amazon/cloudformation/metrics/MetricsPublisherImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,27 @@ public void publishExceptionMetric(final Instant timestamp,
publishMetric(Metric.METRIC_NAME_HANDLER_EXCEPTION, dimensions, StandardUnit.COUNT, 1.0, timestamp);
}

@Override
public void publishExceptionByErrorCodeMetric(final Instant timestamp,
final Action action,
final HandlerErrorCode handlerErrorCode,
final boolean thrown) {
Map<String, String> dimensions = new HashMap<>();
dimensions.put(Metric.DIMENSION_KEY_ACTION_TYPE, action == null ? "NO_ACTION" : action.name());
dimensions.put(Metric.DIMENSION_KEY_HANDLER_ERROR_CODE, handlerErrorCode.name());

publishMetric(Metric.METRIC_NAME_HANDLER_EXCEPTION_BY_ERROR_CODE, dimensions, StandardUnit.COUNT, thrown ? 1.0 : 0.0,
timestamp);
}

public void publishExceptionCountMetric(final Instant timestamp, final Action action, final boolean thrown) {
Map<String, String> dimensions = new HashMap<>();
dimensions.put(Metric.DIMENSION_KEY_ACTION_TYPE, action == null ? "NO_ACTION" : action.name());

publishMetric(Metric.METRIC_NAME_HANDLER_EXCEPTION_BY_EXCEPTION_COUNT, dimensions, StandardUnit.COUNT, thrown ? 1.0 : 0.0,
timestamp);
}

@Override
public void publishProviderLogDeliveryExceptionMetric(final Instant timestamp, final Throwable e) {
Map<String, String> dimensions = new HashMap<>();
Expand Down
13 changes: 13 additions & 0 deletions src/main/java/software/amazon/cloudformation/proxy/MetricsPublisherProxy.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,19 @@ public void publishExceptionMetric(final Instant timestamp,
.forEach(metricsPublisher -> metricsPublisher.publishExceptionMetric(timestamp, action, e, handlerErrorCode));
}

public void publishExceptionByErrorCodeMetric(final Instant timestamp,
final Action action,
final HandlerErrorCode handlerErrorCode,
final boolean thrown) {
metricsPublishers.stream().forEach(
metricsPublisher -> metricsPublisher.publishExceptionByErrorCodeMetric(timestamp, action, handlerErrorCode, thrown));
}

public void publishExceptionCountMetric(final Instant timestamp, final Action action, final boolean thrown) {
metricsPublishers.stream()
.forEach(metricsPublisher -> metricsPublisher.publishExceptionCountMetric(timestamp, action, thrown));
}

public void publishInvocationMetric(final Instant timestamp, final Action action) {
metricsPublishers.stream().forEach(metricsPublisher -> metricsPublisher.publishInvocationMetric(timestamp, action));
}
Expand Down
33 changes: 26 additions & 7 deletions src/test/java/software/amazon/cloudformation/LambdaWrapperTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,12 +158,15 @@ public void invokeHandler_nullResponse_returnsFailure(final String requestDataPa
verifyInitialiseRuntime();

// validation failure metric should be published for final error handling
verify(providerMetricsPublisher, times(1)).publishExceptionMetric(any(Instant.class), any(),
any(TerminalException.class), any(HandlerErrorCode.class));
verify(providerMetricsPublisher).publishExceptionMetric(any(Instant.class), any(), any(TerminalException.class),
any(HandlerErrorCode.class));
verify(providerMetricsPublisher).publishExceptionByErrorCodeMetric(any(Instant.class), any(),
any(HandlerErrorCode.class), eq(Boolean.TRUE));
verify(providerMetricsPublisher).publishExceptionCountMetric(any(Instant.class), any(), any(Boolean.class));

// all metrics should be published even on terminal failure
verify(providerMetricsPublisher, times(1)).publishInvocationMetric(any(Instant.class), eq(action));
verify(providerMetricsPublisher, times(1)).publishDurationMetric(any(Instant.class), eq(action), anyLong());
verify(providerMetricsPublisher).publishInvocationMetric(any(Instant.class), eq(action));
verify(providerMetricsPublisher).publishDurationMetric(any(Instant.class), eq(action), anyLong());

// verify that model validation occurred for CREATE/UPDATE/DELETE
if (action == Action.CREATE || action == Action.UPDATE || action == Action.DELETE) {
Expand Down Expand Up @@ -399,14 +402,21 @@ public void invokeHandler_InProgress_returnsInProgress(final String requestDataP
// verify output response
verifyHandlerResponse(out, ProgressEvent.<TestModel, TestContext>builder().status(OperationStatus.IN_PROGRESS)
.resourceModel(TestModel.builder().property1("abc").property2(123).build()).build());
verify(providerMetricsPublisher, atLeastOnce()).publishExceptionByErrorCodeMetric(any(Instant.class), eq(action),
any(), eq(Boolean.FALSE));
verify(providerMetricsPublisher).publishExceptionCountMetric(any(Instant.class), eq(action), eq(Boolean.FALSE));
} else {
verifyHandlerResponse(out,
ProgressEvent.<TestModel, TestContext>builder().status(OperationStatus.FAILED)
.errorCode(HandlerErrorCode.InternalFailure).message("READ and LIST handlers must return synchronously.")
.build());
verify(providerMetricsPublisher, times(1)).publishExceptionMetric(any(Instant.class), eq(action),
verify(providerMetricsPublisher).publishExceptionMetric(any(Instant.class), eq(action),
any(TerminalException.class), eq(HandlerErrorCode.InternalFailure));
verify(providerMetricsPublisher).publishExceptionByErrorCodeMetric(any(Instant.class), eq(action),
eq(HandlerErrorCode.InternalFailure), eq(Boolean.TRUE));
verify(providerMetricsPublisher).publishExceptionCountMetric(any(Instant.class), eq(action), eq(Boolean.TRUE));
}

// validation failure metric should not be published
verifyNoMoreInteractions(providerMetricsPublisher);

Expand Down Expand Up @@ -446,8 +456,11 @@ public void reInvokeHandler_InProgress_returnsInProgress(final String requestDat
verifyInitialiseRuntime();

// all metrics should be published, once for a single invocation
verify(providerMetricsPublisher, times(1)).publishInvocationMetric(any(Instant.class), eq(action));
verify(providerMetricsPublisher, times(1)).publishDurationMetric(any(Instant.class), eq(action), anyLong());
verify(providerMetricsPublisher).publishInvocationMetric(any(Instant.class), eq(action));
verify(providerMetricsPublisher).publishDurationMetric(any(Instant.class), eq(action), anyLong());
verify(providerMetricsPublisher, atLeastOnce()).publishExceptionByErrorCodeMetric(any(Instant.class), eq(action),
any(), eq(Boolean.FALSE));
verify(providerMetricsPublisher).publishExceptionCountMetric(any(Instant.class), eq(action), eq(Boolean.FALSE));

// validation failure metric should not be published
verifyNoMoreInteractions(providerMetricsPublisher);
Expand Down Expand Up @@ -798,6 +811,12 @@ public void invokeHandler_metricPublisherThrowable_returnsFailureResponse() thro
// verify initialiseRuntime was called and initialised dependencies
verifyInitialiseRuntime();

verify(providerMetricsPublisher).publishExceptionByErrorCodeMetric(any(Instant.class), any(Action.class),
any(HandlerErrorCode.class), any(Boolean.class));

verify(providerMetricsPublisher).publishExceptionCountMetric(any(Instant.class), any(Action.class),
any(Boolean.class));

// no further calls to metrics publisher should occur
verifyNoMoreInteractions(providerMetricsPublisher);

Expand Down