fix(cloudwatch): math expressions incorrectly warn about metricsinsights variable names (#23316)

caoxy98 · web-flow · commit 55108b969a94 · 2022-12-12T16:26:07.000Z
It is intended that all metric identifiers referenced in a MathExpression are included in the usingMetrics map and we will raise warnings if the customer does not follow this contract. 
However for Metricsinsights queries, we can refer directly to metrics attribute values inside the query. Therefore we do not raise warnings for Metricsinsights queries for not referencing metrics

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
diff --git a/packages/@aws-cdk/aws-cloudwatch/lib/metric.ts b/packages/@aws-cdk/aws-cloudwatch/lib/metric.ts
@@ -589,7 +589,7 @@ export class MathExpression implements IMetric {
 
     const warnings = [];
 
-    if (missingIdentifiers.length > 0) {
+    if (!this.expression.toUpperCase().match('\\s*SELECT\\s.*') && missingIdentifiers.length > 0) {
       warnings.push(`Math expression '${this.expression}' references unknown identifiers: ${missingIdentifiers.join(', ')}. Please add them to the 'usingMetrics' map.`);
     }
 
diff --git a/packages/@aws-cdk/aws-cloudwatch/test/metric-math.test.ts b/packages/@aws-cdk/aws-cloudwatch/test/metric-math.test.ts
@@ -75,6 +75,14 @@ describe('Metric Math', () => {
     expect(m.warnings).toContainEqual(expect.stringContaining("'m1 + m2' references unknown identifiers"));
   });
 
+  test('metrics insights expression does not produce warning for unknown identifier', () => {
+    const m = new MathExpression({
+      expression: "SELECT AVG(CpuUsage) FROM EC2 WHERE Instance = '123456'",
+    });
+
+    expect(m.warnings).toBeUndefined();
+  });
+
   test('math expression referring to unknown expressions produces a warning, even when nested', () => {
     const m = new MathExpression({
       expression: 'e1 + 5',

Original file line number	Diff line number	Diff line change
`@@ -589,7 +589,7 @@ export class MathExpression implements IMetric {`
`589`	`589`
`590`	`590`	`const warnings = [];`
`591`	`591`
`592`		`- if (missingIdentifiers.length > 0) {`
	`592`	`+ if (!this.expression.toUpperCase().match('\\sSELECT\\s.') && missingIdentifiers.length > 0) {`
`593`	`593`	warnings.push(`Math expression '${this.expression}' references unknown identifiers: ${missingIdentifiers.join(', ')}. Please add them to the 'usingMetrics' map.`);
`594`	`594`	`}`
`595`	`595`