Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master' into benisrae/refactor/a…
Browse files Browse the repository at this point in the history
…ssets
  • Loading branch information
Elad Ben-Israel committed Apr 30, 2020
2 parents f8eafa1 + b59aed0 commit e6dec09
Show file tree
Hide file tree
Showing 6 changed files with 55 additions and 2 deletions.
7 changes: 6 additions & 1 deletion packages/@aws-cdk/aws-cloudwatch/lib/alarm.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { IAlarmAction } from './alarm-action';
import { CfnAlarm, CfnAlarmProps } from './cloudwatch.generated';
import { HorizontalAnnotation } from './graph';
import { CreateAlarmOptions } from './metric';
import { IMetric, MetricStatConfig } from './metric-types';
import { IMetric, MetricExpressionConfig, MetricStatConfig } from './metric-types';
import { dispatchMetric, metricPeriod } from './private/metric-util';
import { dropUndefined } from './private/object';
import { MetricSet } from './private/rendering';
Expand Down Expand Up @@ -326,6 +326,7 @@ export class Alarm extends Resource implements IAlarm {
expression: expr.expression,
id: entry.id || uniqueMetricId(),
label: conf.renderingProperties?.label,
period: mathExprHasSubmetrics(expr) ? undefined : expr.period,
returnData: entry.tag ? undefined : false, // Tag stores "primary" attribute, default is "true"
};
},
Expand Down Expand Up @@ -388,4 +389,8 @@ function renderIfExtendedStatistic(statistic?: string): string | undefined {
return undefined;
}

function mathExprHasSubmetrics(expr: MetricExpressionConfig) {
return Object.keys(expr.usingMetrics).length > 0;
}

type Writeable<T> = { -readonly [P in keyof T]: T[P] };
5 changes: 5 additions & 0 deletions packages/@aws-cdk/aws-cloudwatch/lib/metric-types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,11 @@ export interface MetricExpressionConfig {
* Metrics used in the math expression
*/
readonly usingMetrics: Record<string, IMetric>;

/**
* How many seconds to aggregate over
*/
readonly period: number;
}

/**
Expand Down
1 change: 1 addition & 0 deletions packages/@aws-cdk/aws-cloudwatch/lib/metric.ts
Original file line number Diff line number Diff line change
Expand Up @@ -485,6 +485,7 @@ export class MathExpression implements IMetric {
public toMetricConfig(): MetricConfig {
return {
mathExpression: {
period: this.period.toSeconds(),
expression: this.expression,
usingMetrics: this.usingMetrics,
},
Expand Down
3 changes: 2 additions & 1 deletion packages/@aws-cdk/aws-cloudwatch/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,8 @@
"props-default-doc:@aws-cdk/aws-cloudwatch.MetricGraphConfig.unit",
"props-default-doc:@aws-cdk/aws-cloudwatch.MetricRenderingProperties.color",
"props-default-doc:@aws-cdk/aws-cloudwatch.MetricRenderingProperties.label",
"props-default-doc:@aws-cdk/aws-cloudwatch.MetricRenderingProperties.stat"
"props-default-doc:@aws-cdk/aws-cloudwatch.MetricRenderingProperties.stat",
"duration-prop-type:@aws-cdk/aws-cloudwatch.MetricExpressionConfig.period"
]
},
"engines": {
Expand Down
22 changes: 22 additions & 0 deletions packages/@aws-cdk/aws-cloudwatch/test/test.metric-math.ts
Original file line number Diff line number Diff line change
Expand Up @@ -507,6 +507,28 @@ export = {
test.done();
},

'MathExpression without inner metrics emits its own period'(test: Test) {
// WHEN
new Alarm(stack, 'Alarm', {
threshold: 1, evaluationPeriods: 1,
metric: new MathExpression({
expression: 'INSIGHT_RULE_METRIC("SomeId", UniqueContributors)',
usingMetrics: {},
}),
});

// THEN
alarmMetricsAre([
{
Expression: 'INSIGHT_RULE_METRIC("SomeId", UniqueContributors)',
Id: 'expr_1',
Period: 300,
},
]);

test.done();
},

'annotation for a mathexpression alarm is calculated based upon constituent metrics'(test: Test) {
// GIVEN
const alarm = new Alarm(stack, 'Alarm', {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"PropertyTypes": {
"AWS::CloudWatch::Alarm.MetricDataQuery": {
"patch": {
"description": "Add Period to AWS::CloudWatch::Alarm.MetricDataQuery (#7155)",
"operations": [
{
"op": "add",
"path": "/Properties/Period",
"value": {
"PrimitiveType": "Integer",
"UpdateType": "Mutable"
}
}
]
}
}
}
}

0 comments on commit e6dec09

Please sign in to comment.