telemetry: codewhisperer code scan metrics #654

aws · Dec 19, 2023 · a48c20c · a48c20c
1 parent bf131ec
commit a48c20c
Showing 1 changed file with 35 additions and 0 deletions.
diff --git a/telemetry/definitions/commonDefinitions.json b/telemetry/definitions/commonDefinitions.json
@@ -776,6 +776,21 @@
             "type": "string",
             "description": "The user group identifier we assign to the customer and it should be unique identifier across different IDE platforms, i.e. Classifier, CrossFile etc."
         },
+        {
+          "name": "findingId",
+          "type": "string",
+          "description": "The id of a security finding from a code scan"
+        },
+        {
+            "name": "detectorId",
+            "type": "string",
+            "description": "The id of the detector which produced the code scan issue"
+        },
+        {
+            "name": "ruleId",
+            "type": "string",
+            "description": "The id of the rule which produced the code scan issue"
+        },
         {
             "name": "syncedResources",
             "type": "string",
@@ -2942,6 +2957,26 @@
                 }
             ]
         },
+        {
+            "name": "codewhisperer_codeScanIssueHover",
+            "description": "Called when a code scan issue is hovered over",
+            "metadata": [{ "type": "findingId" }, { "type": "detectorId" }, { "type": "ruleId", "required": false }]
+        },
+        {
+            "name": "codewhisperer_codeScanIssueApplyFix",
+            "description": "Called when a code scan issue suggested fix is applied",
+            "metadata": [
+                { "type": "findingId" },
+                { "type": "detectorId" },
+                { "type": "component" },
+                { "type": "ruleId", "required": false }
+            ]
+        },
+        {
+            "name": "codewhisperer_codeScanIssueViewDetails",
+            "description": "Called when a code scan issue webview is opened",
+            "metadata": [{ "type": "findingId" }, { "type": "detectorId" }, { "type": "ruleId", "required": false }]
+        },
         {
             "name": "codewhisperer_serviceInvocation",
             "description": "Client side invocation of the CodeWhisperer service for suggestion",