Skip to content

Commit f6cdf98

Browse files
authored
telemetry: add rule id to security scan metrics (#4069)
1 parent 7ace3c3 commit f6cdf98

File tree

4 files changed

+6
-30
lines changed

4 files changed

+6
-30
lines changed

jetbrains-core/resources/telemetryOverride.json

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,6 @@
3434
"type": "string",
3535
"description": "Workflow step name"
3636
},
37-
{
38-
"name": "findingId",
39-
"type": "string",
40-
"description": "The id of a security finding from a code scan"
41-
},
42-
{
43-
"name": "detectorId",
44-
"type": "string",
45-
"description": "The id of the detector which produced the code scan issue"
46-
},
4737
{
4838
"name": "cwsprChatTriggerInteraction",
4939
"type": "string",
@@ -287,25 +277,6 @@
287277
{ "type": "codecatalyst_devEnvironmentWorkflowError", "required": false }
288278
]
289279
},
290-
{
291-
"name": "codewhisperer_codeScanIssueHover",
292-
"description": "Called when a code scan issue is hovered over",
293-
"metadata": [
294-
{ "type": "findingId" },
295-
{ "type": "detectorId" }
296-
]
297-
},
298-
{
299-
"name": "codewhisperer_codeScanIssueApplyFix",
300-
"description": "Called when a code scan issue suggested fix is applied",
301-
"metadata": [
302-
{ "type": "findingId" },
303-
{ "type": "detectorId" },
304-
{ "type": "component" },
305-
{ "type": "result" },
306-
{ "type": "reason", "required": false }
307-
]
308-
},
309280
{
310281
"name": "amazonq_openChat",
311282
"description": "When user opens CWSPR chat panel"

jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeScanManager.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -494,6 +494,7 @@ data class CodeWhispererCodeScanIssue(
494494
val detectorId: String,
495495
val detectorName: String,
496496
val findingId: String,
497+
val ruleId: String?,
497498
val relatedVulnerabilities: List<String>,
498499
val severity: String,
499500
val recommendation: Recommendation,

jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/codescan/CodeWhispererCodeScanSession.kt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,7 @@ class CodeWhispererCodeScanSession(val sessionContext: CodeScanSessionContext) {
321321
detectorId = it.detectorId,
322322
detectorName = it.detectorName,
323323
findingId = it.findingId,
324+
ruleId = it.ruleId,
324325
relatedVulnerabilities = it.relatedVulnerabilities,
325326
severity = it.severity,
326327
recommendation = it.remediation.recommendation,
@@ -381,6 +382,7 @@ internal data class CodeScanRecommendation(
381382
val detectorId: String,
382383
val detectorName: String,
383384
val findingId: String,
385+
val ruleId: String?,
384386
val relatedVulnerabilities: List<String>,
385387
val severity: String,
386388
val remediation: Remediation

jetbrains-core/src/software/aws/toolkits/jetbrains/services/codewhisperer/telemetry/CodeWhispererTelemetryService.kt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -328,14 +328,16 @@ class CodeWhispererTelemetryService {
328328
fun sendCodeScanIssueHoverEvent(issue: CodeWhispererCodeScanIssue) {
329329
CodewhispererTelemetry.codeScanIssueHover(
330330
findingId = issue.findingId,
331-
detectorId = issue.detectorId
331+
detectorId = issue.detectorId,
332+
ruleId = issue.ruleId
332333
)
333334
}
334335

335336
fun sendCodeScanIssueApplyFixEvent(issue: CodeWhispererCodeScanIssue, result: Result, reason: String? = null) {
336337
CodewhispererTelemetry.codeScanIssueApplyFix(
337338
findingId = issue.findingId,
338339
detectorId = issue.detectorId,
340+
ruleId = issue.ruleId,
339341
component = Component.Hover,
340342
result = result,
341343
reason = reason

0 commit comments

Comments
 (0)