telemetry(IamPolicyChecks): create policy checks metrics

aws · May 10, 2024 · df07d9e · df07d9e
1 parent 4a027e9
commit df07d9e
Showing 1 changed file with 104 additions and 0 deletions.
diff --git a/telemetry/definitions/commonDefinitions.json b/telemetry/definitions/commonDefinitions.json
@@ -1,5 +1,52 @@
 {
     "types": [
+        {
+            "name": "accessanalyzerCfnParameterFileUsed",
+            "type": "boolean",
+            "description": "Boolean value of whether or not a Cfn parameter file is provided."
+        },
+        {
+            "name": "accessanalyzerCheckType",
+            "type": "string",
+            "allowedValues": [
+                "CheckNoNewAccess",
+                "CheckAccessNotGranted"
+            ],
+            "description": "User inputted check type to denote which custom check to run."
+        },
+        {
+            "name": "accessanalyzerDocumentType",
+            "type": "string",
+            "allowedValues": [
+                "CloudFormation",
+                "Terraform Plan",
+                "JSON Policy Language"
+            ],
+            "description": "Document type of the edited file in IAM Policy Checks"
+        },
+        {
+            "name": "accessanalyzerFindingsCount",
+            "type": "int",
+            "description": "Number of findings discovered after execution"
+        },
+        {
+            "name": "accessanalyzerInputPolicyType",
+            "type": "string",
+            "allowedValues": [
+                "Identity",
+                "Resource"
+            ],
+            "description": "User inputted policy type of the edited file. Applicable to only JSON Policy Language."
+        },
+        {
+            "name": "accessanalyzerReferencePolicyType",
+            "type": "string",
+            "allowedValues": [
+                "Identity",
+                "Resource"
+            ],
+            "description": "User inputted policy type of the reference file. Applicable to only CheckNoNewAccess check type."
+        },
         {
             "name": "amazonqCodeGenerationResult",
             "type": "string",
@@ -1324,6 +1371,63 @@
         }
     ],
     "metrics": [
+        {
+            "name": "accessanalyzer_iamPolicyChecksCustomChecks",
+            "description": "Execution of Custom Policy Checks in IAM Policy Checks",
+            "metadata": [
+                {
+                    "type": "accessanalyzerCfnParameterFileUsed"
+                },
+                {
+                    "type": "accessanalyzerCheckType"
+                },
+                {
+                    "type": "accessanalyzerDocumentType"
+                },
+                {
+                    "type": "accessanalyzerFindingsCount"
+                },
+                {
+                    "type": "accessanalyzerInputPolicyType"
+                },
+                {
+                    "type": "accessanalyzerReferencePolicyType"
+                },
+                {
+                    "type": "result"
+                }
+            ]
+        },
+        {
+            "name": "accessanalyzer_iamPolicyChecksError",
+            "description": "Errors related to IamPolicyChecks",
+            "metadata": [
+                {
+                    "type": "reason"
+                }
+            ]
+        },
+        {
+            "name": "accessanalyzer_iamPolicyChecksValidatePolicy",
+            "description": "Execution of Validate Policy in IAM Policy Checks",
+            "metadata": [
+                {
+                    "type": "accessanalyzerCfnParameterFileUsed"
+                },
+                {
+                    "type": "accessanalyzerDocumentType"
+                },
+                {
+                    "type": "accessanalyzerFindingsCount"
+                },
+                {
+                    "type": "accessanalyzerInputPolicyType"
+                },
+                {
+                    "type": "result"
+                }
+            ]
+        },
         {
             "name": "amazonq_approachInvoke",
             "description": "Captures Approach generation process",