feat(logs): filterName property in MetricFilter (#25246)

vinayak-kukreja · web-flow · commit 4f8aae50884b · 2023-05-24T15:00:39.000Z
This PR is recreating and adding to https://github.com/robertd PR: #23053 Here, `filterName` property is being added for `MetricFilter` And, also adding an existing integ test: `integ.expose-metric.ts` with the `IntegTest` construct. Closes #17626 Co-authored-by: Robert Djurasaj(https://github.com/robertd) ---- *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-testing/framework-integ/.gitignore b/packages/@aws-cdk-testing/framework-integ/.gitignore
@@ -13,3 +13,5 @@ nyc.config.js
 !**/*.snapshot/**/asset.*/*.d.ts
 
 !**/*.snapshot/**/asset.*/**
+
+**/*.ts.snapshot
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-logs/test/integ.expose-metric.ts b/packages/@aws-cdk-testing/framework-integ/test/aws-logs/test/integ.expose-metric.ts
@@ -1,6 +1,7 @@
 import { Alarm } from 'aws-cdk-lib/aws-cloudwatch';
 import { App, RemovalPolicy, Stack, StackProps } from 'aws-cdk-lib';
 import { FilterPattern, LogGroup, MetricFilter } from 'aws-cdk-lib/aws-logs';
+import { IntegTest } from '@aws-cdk/integ-tests-alpha';
 
 /*
  * Stack verification steps:
@@ -37,5 +38,10 @@ class ExposeMetricIntegStack extends Stack {
 }
 
 const app = new App();
-new ExposeMetricIntegStack(app, 'aws-cdk-expose-metric-integ');
+const stack = new ExposeMetricIntegStack(app, 'aws-cdk-expose-metric-integ');
+
+new IntegTest(app, 'LambdaTest', {
+  testCases: [stack],
+});
+
 app.synth();
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-logs/test/integ.metricfilter.lit.js.snapshot/aws-cdk-metricfilter-integ.assets.json b/packages/@aws-cdk-testing/framework-integ/test/aws-logs/test/integ.metricfilter.lit.js.snapshot/aws-cdk-metricfilter-integ.assets.json
@@ -1,15 +1,15 @@
 {
-  "version": "22.0.0",
+  "version": "31.0.0",
   "files": {
-    "3447b1b7683bf722256f63f808f8ac3a927c270228f18c1ff0245b4d5fc3f919": {
+    "02ed2687a3e340ff22289dcacf3e4ed024865b2aae1c13bf6bf5c995590480ac": {
       "source": {
         "path": "aws-cdk-metricfilter-integ.template.json",
         "packaging": "file"
       },
       "destinations": {
         "current_account-current_region": {
           "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
-          "objectKey": "3447b1b7683bf722256f63f808f8ac3a927c270228f18c1ff0245b4d5fc3f919.json",
+          "objectKey": "02ed2687a3e340ff22289dcacf3e4ed024865b2aae1c13bf6bf5c995590480ac.json",
           "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
         }
       }
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-logs/test/integ.metricfilter.lit.js.snapshot/aws-cdk-metricfilter-integ.template.json b/packages/@aws-cdk-testing/framework-integ/test/aws-logs/test/integ.metricfilter.lit.js.snapshot/aws-cdk-metricfilter-integ.template.json
@@ -21,7 +21,8 @@
       "MetricNamespace": "MyApp",
       "MetricValue": "$.latency"
      }
-    ]
+    ],
+    "FilterName": "MyFilterName"
    }
   }
  },
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-logs/test/integ.metricfilter.lit.js.snapshot/cdk.out b/packages/@aws-cdk-testing/framework-integ/test/aws-logs/test/integ.metricfilter.lit.js.snapshot/cdk.out
@@ -1 +1 @@
-{"version":"22.0.0"}
+{"version":"31.0.0"}
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-logs/test/integ.metricfilter.lit.js.snapshot/integ.json b/packages/@aws-cdk-testing/framework-integ/test/aws-logs/test/integ.metricfilter.lit.js.snapshot/integ.json
@@ -1,5 +1,5 @@
 {
-  "version": "22.0.0",
+  "version": "31.0.0",
   "testCases": {
     "integ.metricfilter.lit": {
       "stacks": [
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-logs/test/integ.metricfilter.lit.js.snapshot/manifest.json b/packages/@aws-cdk-testing/framework-integ/test/aws-logs/test/integ.metricfilter.lit.js.snapshot/manifest.json
@@ -1,5 +1,5 @@
 {
-  "version": "22.0.0",
+  "version": "31.0.0",
   "artifacts": {
     "aws-cdk-metricfilter-integ.assets": {
       "type": "cdk:asset-manifest",
@@ -17,7 +17,7 @@
         "validateOnSynth": false,
         "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-deploy-role-${AWS::AccountId}-${AWS::Region}",
         "cloudFormationExecutionRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-cfn-exec-role-${AWS::AccountId}-${AWS::Region}",
-        "stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/3447b1b7683bf722256f63f808f8ac3a927c270228f18c1ff0245b4d5fc3f919.json",
+        "stackTemplateAssetObjectUrl": "s3://cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}/02ed2687a3e340ff22289dcacf3e4ed024865b2aae1c13bf6bf5c995590480ac.json",
         "requiresBootstrapStackVersion": 6,
         "bootstrapStackVersionSsmParameter": "/cdk-bootstrap/hnb659fds/version",
         "additionalDependencies": [
@@ -42,7 +42,10 @@
         "/aws-cdk-metricfilter-integ/MetricFilter/Resource": [
           {
             "type": "aws:cdk:logicalId",
-            "data": "MetricFilter1B93B6E5"
+            "data": "MetricFilter1B93B6E5",
+            "trace": [
+              "!!DESTRUCTIVE_CHANGES: WILL_REPLACE"
+            ]
           }
         ],
         "/aws-cdk-metricfilter-integ/BootstrapVersion": [
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-logs/test/integ.metricfilter.lit.js.snapshot/tree.json b/packages/@aws-cdk-testing/framework-integ/test/aws-logs/test/integ.metricfilter.lit.js.snapshot/tree.json
@@ -22,13 +22,13 @@
                   }
                 },
                 "constructInfo": {
-                  "fqn": "@aws-cdk/aws-logs.CfnLogGroup",
+                  "fqn": "aws-cdk-lib.aws_logs.CfnLogGroup",
                   "version": "0.0.0"
                 }
               }
             },
             "constructInfo": {
-              "fqn": "@aws-cdk/aws-logs.LogGroup",
+              "fqn": "aws-cdk-lib.aws_logs.LogGroup",
               "version": "0.0.0"
             }
           },
@@ -52,39 +52,40 @@
                         "metricName": "Latency",
                         "metricValue": "$.latency"
                       }
-                    ]
+                    ],
+                    "filterName": "MyFilterName"
                   }
                 },
                 "constructInfo": {
-                  "fqn": "@aws-cdk/aws-logs.CfnMetricFilter",
+                  "fqn": "aws-cdk-lib.aws_logs.CfnMetricFilter",
                   "version": "0.0.0"
                 }
               }
             },
             "constructInfo": {
-              "fqn": "@aws-cdk/aws-logs.MetricFilter",
+              "fqn": "aws-cdk-lib.aws_logs.MetricFilter",
               "version": "0.0.0"
             }
           },
           "BootstrapVersion": {
             "id": "BootstrapVersion",
             "path": "aws-cdk-metricfilter-integ/BootstrapVersion",
             "constructInfo": {
-              "fqn": "@aws-cdk/core.CfnParameter",
+              "fqn": "aws-cdk-lib.CfnParameter",
               "version": "0.0.0"
             }
           },
           "CheckBootstrapVersion": {
             "id": "CheckBootstrapVersion",
             "path": "aws-cdk-metricfilter-integ/CheckBootstrapVersion",
             "constructInfo": {
-              "fqn": "@aws-cdk/core.CfnRule",
+              "fqn": "aws-cdk-lib.CfnRule",
               "version": "0.0.0"
             }
           }
         },
         "constructInfo": {
-          "fqn": "@aws-cdk/core.Stack",
+          "fqn": "aws-cdk-lib.Stack",
           "version": "0.0.0"
         }
       },
@@ -93,12 +94,12 @@
         "path": "Tree",
         "constructInfo": {
           "fqn": "constructs.Construct",
-          "version": "10.1.189"
+          "version": "10.1.270"
         }
       }
     },
     "constructInfo": {
-      "fqn": "@aws-cdk/core.App",
+      "fqn": "aws-cdk-lib.App",
       "version": "0.0.0"
     }
   }
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-logs/test/integ.metricfilter.lit.ts b/packages/@aws-cdk-testing/framework-integ/test/aws-logs/test/integ.metricfilter.lit.ts
@@ -14,6 +14,7 @@ class MetricFilterIntegStack extends Stack {
       logGroup,
       metricNamespace: 'MyApp',
       metricName: 'Latency',
+      filterName: 'MyFilterName',
       filterPattern: FilterPattern.exists('$.latency'),
       metricValue: '$.latency',
     });
diff --git a/packages/aws-cdk-lib/aws-logs/lib/log-group.ts b/packages/aws-cdk-lib/aws-logs/lib/log-group.ts
@@ -584,4 +584,11 @@ export interface MetricFilterOptions {
    * @default - No unit attached to metrics.
    */
   readonly unit?: cloudwatch.Unit;
+
+  /**
+   * The name of the metric filter.
+   *
+   * @default - Cloudformation generated name.
+   */
+  readonly filterName?: string;
 }
diff --git a/packages/aws-cdk-lib/aws-logs/lib/metric-filter.ts b/packages/aws-cdk-lib/aws-logs/lib/metric-filter.ts
@@ -23,13 +23,16 @@ export class MetricFilter extends Resource {
   private readonly metricNamespace: string;
 
   constructor(scope: Construct, id: string, props: MetricFilterProps) {
-    super(scope, id);
+    super(scope, id, {
+      physicalName: props.filterName,
+    });
 
     this.metricName = props.metricName;
     this.metricNamespace = props.metricNamespace;
 
-    if (Object.keys(props.dimensions ?? {}).length > 3) {
-      throw new Error('MetricFilter only supports a maximum of 3 Dimensions');
+    const numberOfDimensions = Object.keys(props.dimensions ?? {}).length;
+    if (numberOfDimensions > 3) {
+      throw new Error(`MetricFilter only supports a maximum of 3 dimensions but received ${numberOfDimensions}.`);
     }
 
     // It looks odd to map this object to a singleton list, but that's how
@@ -42,6 +45,7 @@ export class MetricFilter extends Resource {
     // https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-metricfilter.html
     new CfnMetricFilter(this, 'Resource', {
       logGroupName: props.logGroup.logGroupName,
+      filterName: this.physicalName,
       filterPattern: props.filterPattern.logPatternString,
       metricTransformations: [{
         metricNamespace: props.metricNamespace,
diff --git a/packages/aws-cdk-lib/aws-logs/test/metricfilter.test.ts b/packages/aws-cdk-lib/aws-logs/test/metricfilter.test.ts
@@ -14,6 +14,7 @@ describe('metric filter', () => {
       logGroup,
       metricNamespace: 'AWS/Test',
       metricName: 'Latency',
+      filterName: 'FooBazBar',
       metricValue: '$.latency',
       filterPattern: FilterPattern.exists('$.latency'),
     });
@@ -27,6 +28,7 @@ describe('metric filter', () => {
       }],
       FilterPattern: '{ $.latency = "*" }',
       LogGroupName: { Ref: 'LogGroupF5B46931' },
+      FilterName: 'FooBazBar',
     });
   });
 
@@ -83,7 +85,7 @@ describe('metric filter', () => {
         Baz: 'Qux',
         Qux: 'Quux',
       },
-    })).toThrow(/MetricFilter only supports a maximum of 3 Dimensions/);
+    })).toThrow(/MetricFilter only supports a maximum of 3 dimensions but received/);
   });
 
   test('metric filter exposes metric', () => {

Original file line number	Diff line number	Diff line change
`@@ -1,15 +1,15 @@`
`1`	`1`	`{`
`2`		`- "version": "22.0.0",`
	`2`	`+ "version": "31.0.0",`
`3`	`3`	`"files": {`
`4`		`- "3447b1b7683bf722256f63f808f8ac3a927c270228f18c1ff0245b4d5fc3f919": {`
	`4`	`+ "02ed2687a3e340ff22289dcacf3e4ed024865b2aae1c13bf6bf5c995590480ac": {`
`5`	`5`	`"source": {`
`6`	`6`	`"path": "aws-cdk-metricfilter-integ.template.json",`
`7`	`7`	`"packaging": "file"`
`8`	`8`	`},`
`9`	`9`	`"destinations": {`
`10`	`10`	`"current_account-current_region": {`
`11`	`11`	`"bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",`
`12`		`- "objectKey": "3447b1b7683bf722256f63f808f8ac3a927c270228f18c1ff0245b4d5fc3f919.json",`
	`12`	`+ "objectKey": "02ed2687a3e340ff22289dcacf3e4ed024865b2aae1c13bf6bf5c995590480ac.json",`
`13`	`13`	`"assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"`
`14`	`14`	`}`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,8 @@`
`21`	`21`	`"MetricNamespace": "MyApp",`
`22`	`22`	`"MetricValue": "$.latency"`
`23`	`23`	`}`
`24`		`- ]`
	`24`	`+ ],`
	`25`	`+ "FilterName": "MyFilterName"`
`25`	`26`	`}`
`26`	`27`	`}`
`27`	`28`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{"version":"22.0.0"}`
	`1`	`+{"version":"31.0.0"}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "version": "22.0.0",`
	`2`	`+ "version": "31.0.0",`
`3`	`3`	`"testCases": {`
`4`	`4`	`"integ.metricfilter.lit": {`
`5`	`5`	`"stacks": [`
Original file line number	Diff line number	Diff line change
`@@ -22,13 +22,13 @@`
`22`	`22`	`}`
`23`	`23`	`},`
`24`	`24`	`"constructInfo": {`
`25`		`- "fqn": "@aws-cdk/aws-logs.CfnLogGroup",`
	`25`	`+ "fqn": "aws-cdk-lib.aws_logs.CfnLogGroup",`
`26`	`26`	`"version": "0.0.0"`
`27`	`27`	`}`
`28`	`28`	`}`
`29`	`29`	`},`
`30`	`30`	`"constructInfo": {`
`31`		`- "fqn": "@aws-cdk/aws-logs.LogGroup",`
	`31`	`+ "fqn": "aws-cdk-lib.aws_logs.LogGroup",`
`32`	`32`	`"version": "0.0.0"`
`33`	`33`	`}`
`34`	`34`	`},`
`@@ -52,39 +52,40 @@`
`52`	`52`	`"metricName": "Latency",`
`53`	`53`	`"metricValue": "$.latency"`
`54`	`54`	`}`
`55`		`- ]`
	`55`	`+ ],`
	`56`	`+ "filterName": "MyFilterName"`
`56`	`57`	`}`
`57`	`58`	`},`
`58`	`59`	`"constructInfo": {`
`59`		`- "fqn": "@aws-cdk/aws-logs.CfnMetricFilter",`
	`60`	`+ "fqn": "aws-cdk-lib.aws_logs.CfnMetricFilter",`
`60`	`61`	`"version": "0.0.0"`
`61`	`62`	`}`
`62`	`63`	`}`
`63`	`64`	`},`
`64`	`65`	`"constructInfo": {`
`65`		`- "fqn": "@aws-cdk/aws-logs.MetricFilter",`
	`66`	`+ "fqn": "aws-cdk-lib.aws_logs.MetricFilter",`
`66`	`67`	`"version": "0.0.0"`
`67`	`68`	`}`
`68`	`69`	`},`
`69`	`70`	`"BootstrapVersion": {`
`70`	`71`	`"id": "BootstrapVersion",`
`71`	`72`	`"path": "aws-cdk-metricfilter-integ/BootstrapVersion",`
`72`	`73`	`"constructInfo": {`
`73`		`- "fqn": "@aws-cdk/core.CfnParameter",`
	`74`	`+ "fqn": "aws-cdk-lib.CfnParameter",`
`74`	`75`	`"version": "0.0.0"`
`75`	`76`	`}`
`76`	`77`	`},`
`77`	`78`	`"CheckBootstrapVersion": {`
`78`	`79`	`"id": "CheckBootstrapVersion",`
`79`	`80`	`"path": "aws-cdk-metricfilter-integ/CheckBootstrapVersion",`
`80`	`81`	`"constructInfo": {`
`81`		`- "fqn": "@aws-cdk/core.CfnRule",`
	`82`	`+ "fqn": "aws-cdk-lib.CfnRule",`
`82`	`83`	`"version": "0.0.0"`
`83`	`84`	`}`
`84`	`85`	`}`
`85`	`86`	`},`
`86`	`87`	`"constructInfo": {`
`87`		`- "fqn": "@aws-cdk/core.Stack",`
	`88`	`+ "fqn": "aws-cdk-lib.Stack",`
`88`	`89`	`"version": "0.0.0"`
`89`	`90`	`}`
`90`	`91`	`},`
`@@ -93,12 +94,12 @@`
`93`	`94`	`"path": "Tree",`
`94`	`95`	`"constructInfo": {`
`95`	`96`	`"fqn": "constructs.Construct",`
`96`		`- "version": "10.1.189"`
	`97`	`+ "version": "10.1.270"`
`97`	`98`	`}`
`98`	`99`	`}`
`99`	`100`	`},`
`100`	`101`	`"constructInfo": {`
`101`		`- "fqn": "@aws-cdk/core.App",`
	`102`	`+ "fqn": "aws-cdk-lib.App",`
`102`	`103`	`"version": "0.0.0"`
`103`	`104`	`}`
`104`	`105`	`}`