Skip to content

telemetry: add definitions for code scan #890

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Closed

telemetry: add definitions for code scan #890

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
31321b5
telemetry: add definitions for reviewbird
ctlai95 Oct 22, 2024
272a6ab
add codeScanSessionId type
ctlai95 Oct 22, 2024
067d552
reorder
ctlai95 Oct 22, 2024
d0ea0ce
reorder
ctlai95 Oct 22, 2024
5b1dc80
remove reason and result
ctlai95 Oct 22, 2024
8e4fab5
address comments
ctlai95 Oct 22, 2024
4770dba
lint
ctlai95 Oct 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 139 additions & 4 deletions telemetry/definitions/commonDefinitions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,11 @@
"type": "int",
"description": "Time taken to invoke code scan service APIs in milliseconds"
},
{
"name": "codeScanSessionId",
"type": "string",
"description": "Represents the IDE session from which users start the scan process"
},
{
"name": "codeTransformArtifactType",
"type": "string",
Expand Down Expand Up @@ -554,6 +559,8 @@
"description": "The scope of the security scan being performed",
"allowedValues": [
"FILE",
"FILE_AUTO",
"FILE_ON_DEMAND",
"PROJECT"
]
},
Expand Down Expand Up @@ -885,7 +892,8 @@
"infobar",
"hover",
"webview",
"quickfix"
"quickfix",
"tree"
],
"description": "The IDE or OS component used for the action. (Examples: S3 download to filesystem, S3 upload from editor, ...). See also `featureId` for specific feature names, `module` for low-level modules, and `resourceType`."
},
Expand Down Expand Up @@ -1131,7 +1139,7 @@
"remoteDesktop",
"ssh",
"scp",
"ssm",
"ssm",
"remoteWorkspace"
],
"description": "Ways to connect to an EC2 Instance"
Expand Down Expand Up @@ -4322,6 +4330,48 @@
],
"passive": true
},
{
"name": "codewhisperer_codeScanChatFileScan",
"description": "Called when file scan is selected from chat",
"metadata": [
{
"type": "codeScanSessionId",
"required": false
},
{
"type": "credentialSourceId",
"required": false
}
]
},
{
"name": "codewhisperer_codeScanChatNewTab",
"description": "Called when a new chat tab is opened in the code scan view",
"metadata": [
{
"type": "codeScanSessionId",
"required": false
},
{
"type": "credentialSourceId",
"required": false
}
]
},
{
"name": "codewhisperer_codeScanChatProjectScan",
"description": "Called when project scan is selected from chat",
"metadata": [
{
"type": "codeScanSessionId",
"required": false
},
{
"type": "credentialSourceId",
"required": false
}
]
},
{
"name": "codewhisperer_codeScanIssueApplyFix",
"description": "Called when a code scan issue suggested fix is applied",
Expand All @@ -4340,11 +4390,27 @@
"type": "findingId"
},
{
"type": "reason",
"type": "ruleId",
"required": false
}
]
},
{
"name": "codewhisperer_codeScanIssueGenerateFix",
"description": "Called when a code scan issue fix is generated",
"metadata": [
{
"type": "component"
},
{
"type": "result"
"type": "credentialStartUrl",
"required": false
},
{
"type": "detectorId"
},
{
"type": "findingId"
},
{
"type": "ruleId",
Expand Down Expand Up @@ -4375,6 +4441,75 @@
}
]
},
{
"name": "codewhisperer_codeScanIssueIgnore",
"description": "Called when a code scan issue is ignored",
"metadata": [
{
"type": "component"
},
{
"type": "credentialStartUrl",
"required": false
},
{
"type": "detectorId"
},
{
"type": "findingId"
},
{
"type": "ruleId",
"required": false
}
]
},
{
"name": "codewhisperer_codeScanIssueIgnoreAll",
"description": "Called when all code scan issues of a specific type are ignored",
"metadata": [
{
"type": "component"
},
{
"type": "credentialStartUrl",
"required": false
},
{
"type": "detectorId"
},
{
"type": "findingId"
},
{
"type": "ruleId",
"required": false
}
]
},
{
"name": "codewhisperer_codeScanIssueRegenerateFix",
"description": "Called when a code scan issue fix is regenerated",
"metadata": [
{
"type": "component"
},
{
"type": "credentialStartUrl",
"required": false
},
{
"type": "detectorId"
},
{
"type": "findingId"
},
{
"type": "ruleId",
"required": false
}
]
},
{
"name": "codewhisperer_codeScanIssueViewDetails",
"description": "Called when a code scan issue webview is opened",
Expand Down