Skip to content

Commit

Permalink
Introduce telemetry reporting.
Browse files Browse the repository at this point in the history
- Introduce wrappers for vscode-redhat-telemetry on client side
- Delegate telemetry reported on server side to the wrapper
- Add ability to report telemetry on configuration settings
- Fixes redhat-developer#2289

Signed-off-by: Roland Grunberg <rgrunber@redhat.com>
  • Loading branch information
rgrunber committed Jan 28, 2022
1 parent 316a662 commit 69e63a7
Show file tree
Hide file tree
Showing 8 changed files with 411 additions and 74 deletions.
15 changes: 10 additions & 5 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
"runtimeExecutable": "${execPath}",
"args": ["--extensionDevelopmentPath=${workspaceRoot}" ],
"env": {
"DEBUG_VSCODE_JAVA":"true"
"DEBUG_VSCODE_JAVA":"true",
"VSCODE_REDHAT_TELEMETRY_DEBUG":"true"
},
"stopOnEntry": false,
"sourceMaps": true,
Expand All @@ -27,7 +28,8 @@
"outFiles": [ "${workspaceRoot}/dist/**/*.js" ],
"env": {
"SERVER_PORT": "3333",
"DEBUG_VSCODE_JAVA":"true"
"DEBUG_VSCODE_JAVA":"true",
"VSCODE_REDHAT_TELEMETRY_DEBUG":"true"
},
"preLaunchTask": "npm: watch"
},
Expand All @@ -42,7 +44,8 @@
"outFiles": [ "${workspaceRoot}/dist/**/*.js" ],
"env": {
"JDTLS_CLIENT_PORT": "5036",
"DEBUG_VSCODE_JAVA":"true"
"DEBUG_VSCODE_JAVA":"true",
"VSCODE_REDHAT_TELEMETRY_DEBUG":"true"
},
"preLaunchTask": "npm: watch"
},
Expand All @@ -57,7 +60,8 @@
"outFiles": [ "${workspaceRoot}/dist/**/*.js" ],
"env": {
"SYNTAXLS_CLIENT_PORT": "5037",
"DEBUG_VSCODE_JAVA":"true"
"DEBUG_VSCODE_JAVA":"true",
"VSCODE_REDHAT_TELEMETRY_DEBUG":"true"
},
"preLaunchTask": "npm: watch"
},
Expand All @@ -73,7 +77,8 @@
"env": {
"JDTLS_CLIENT_PORT": "5036",
"SYNTAXLS_CLIENT_PORT": "5037",
"DEBUG_VSCODE_JAVA":"true"
"DEBUG_VSCODE_JAVA":"true",
"VSCODE_REDHAT_TELEMETRY_DEBUG":"true"
},
"preLaunchTask": "npm: watch"
},
Expand Down
23 changes: 23 additions & 0 deletions USAGE_DATA.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Data collection

vscode-java has opt-in telemetry collection, provided by [vscode-redhat-telemetry](https://github.com/redhat-developer/vscode-redhat-telemetry).

## What's included in the vscode-java telemetry data

* vscode-java emits telemetry events when the extension starts and stops,
which contain the common data mentioned on the
[vscode-redhat-telemetry page](https://github.com/redhat-developer/vscode-redhat-telemetry/blob/main/USAGE_DATA.md#common-data).
* The name of the build tool used to import a project (eg. Maven, Gradle, etc.)
* The Java compiler source level used by a given project (eg. 11)
* Whether the following settings are not empty
* `java.settings.url`, `java.format.settings.url`

## What's included in the general telemetry data

Please see the
[vscode-redhat-telemetry data collection information](https://github.com/redhat-developer/vscode-redhat-telemetry/blob/HEAD/USAGE_DATA.md#usage-data-being-collected-by-red-hat-extensions)
for information on what data it collects.

## How to opt in or out

Use the `redhat.telemetry.enabled` setting in order to enable or disable telemetry collection.
Loading

0 comments on commit 69e63a7

Please sign in to comment.