generated from oracle/template-repo
-
Notifications
You must be signed in to change notification settings - Fork 56
Updating telemetry consent messages #409
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.
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
Merged
sid-srini
merged 1 commit into
oracle:telemetry
from
sid-srini:update-telemetry-consent-messages
Apr 29, 2025
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| # About Oracle Java Platform Extension for Visual Studio Code use of Telemetry | ||
| ## First Your Privacy and Anonymity | ||
|
|
||
| During startup, close or usage of the Oracle Java Platform extension for Visual Studio Code (hereafter referred to as "JVSCE"), Oracle does not collect or track any personally identifiable information (such as names or email addresses) about you or your source code, or associate your usage of JVSCE with personally identifiable data. | ||
|
|
||
| If you choose to enable telemetry collection in JVSCE, we will collect a limited set of information that is not personally identifiable. It is anonymous technical data commonly known as "telemetry". An element-by-element description of what is collected and how it helps us, [is listed below](#specifics-about-java-extension-usage-metrics). | ||
|
|
||
| We do not transmit your source code nor the contents of the files you edit with Visual Studio Code. | ||
|
|
||
| ## We Collect this Data to Measure Our Own Performance, Diagnose Problems, and Improve Your Experience | ||
| The purpose of the telemetry transmitted to Oracle during the JVSCE startup, close, or usage, is to find any technical problems or anomalies that occur, so we can understand and correct them; as well as, to understand the usage of Java versions and language features, so we can help improve the platform. It's similar to a car mechanic's practice of plugging into your engine's diagnostic port to identify performance issues (not to identify the car's owner!). The issues we identify could be anything from slow performance or missing platforms for JDK builds to adoption of popular Java language capabilities. Your source code, privacy and anonymity are not compromised by our collecting this telemetry. The information thus collected helps to improve the extension experience and the Java platform. | ||
|
|
||
| ## If You Would Like to Enable or Disable the Collection of this Data | ||
| If you have not already made a choice for this setting, the extension might request that you enable Telemetry via a notification pop-up at the time of activation of the extension. | ||
|
|
||
| If you wish to enable or disable the collection and transmission of the telemetry, you may do so from VS Code Settings → [jdk.telemetry.enabled](vscode://settings/jdk.telemetry.enabled). | ||
|
|
||
| No information is sent to Oracle prior to you enabling Telemetry. | ||
|
|
||
| # Specifics About Java Extension Usage Metrics | ||
| ## WHO Sends Information to Oracle? | ||
| We, the authors of the JVSCE, collect and send information from the Java extension, when it is running in VS Code, only for users who consent to its collection. | ||
|
|
||
| ## HOW Is Information Sent to Oracle? | ||
| Small JSON messages are transported via a secure HTTPS connection over the Internet. | ||
|
|
||
| ## WHEN Is Information Sent to Oracle? | ||
| Information may be sent in one or more separate messages, depending on the events reported by JVSCE. | ||
|
|
||
| The following types of messages may be sent if users have consented to telemetry from JVSCE: | ||
| 1. Start | ||
| - When a JVSCE instance is launched in a window, a "Start" event is sent. | ||
| - This contains information about the version, language, architecture etc. of JVSCE, VSCode and the OS. | ||
| 2. Close | ||
| - When a JVSCE instance is closed in a window, a "Close" event is sent. | ||
| - This contains timing information for the session. | ||
| 3. Workspace Change | ||
| - When a workspace is loaded for which JVSCE is active, a "Workspace Change" event is sent. | ||
| - This contains information about the Java version used, build tool used, and performance times. | ||
| 4. JDK Download | ||
| - When a JDK is downloaded and installed using JVSCE, a "JDK Download" event is sent. | ||
| - This contains information about the Java version downloaded. | ||
| 5. JDK Feature | ||
| - A "JDK Feature" event is sent when certain Java language features, such as `records`, `switch-expressions`, `pattern-matching` etc., or, functionality introduced in [JEPs](https://openjdk.org/jeps/0), is used while editing a Java file. | ||
| - This contains information about the Java version in use and the feature names or JEP numbers used. | ||
|
|
||
| ## WHAT Information is Sent to Oracle? | ||
| Some or all of the following information may be sent to Oracle depending on the type of event triggered: | ||
|
|
||
| | Event | Data Name | Value Description | | ||
| |-------|----------------|--------------------------------------------------------------| | ||
| | _ALL_ | VsCodeId | Anonymous machine identifier generated by VS Code. <br>It cannot be used to track the IP address or identity of the user. <br>Example: `9c5aa07a61ed54bbf61705d17bd214ef269bbed8d5a557ba9e50658b31ffae79` | | ||
| | _ALL_ | VscSessionId | Anonymous session identifier generated by VS Code. <br>It cannot be used to track the IP address or identity of the user. <br>Example: `15cf5498-7981-45af-aca3-34e0fa6e906c1716187959345` | | ||
| | Start | ExtensionInfo | JVSCE information like extension name, id and version. <br>Example: `Oracle.oracle-java`, `oracle-java`, `23.1.0` | | ||
| | Start | VsCodeInfo | VS Code related information like version, language and host-type. <br>Example: `1.97.2`, `en`, `desktop` | | ||
| | Start | PlatformInfo | Host platform/OS information like os name, architecture and version. <br>Example: `mac`, `arm64`, `14.6` | | ||
| | Start | LocationInfo | Platform location information like language-region and time-zone. <br>Example: `en-US`, `Asia/Jakarta` | | ||
| | Close | SessionTime | Indicates the time for which JVSCE was active in a session. | | ||
| | Workspace Change | Timing Info | Indicates performance information like the time taken to initialise the language server and the time taken to parse and load the project information | | ||
| | Workspace Change | ProjectInfo | Indicates project-related Java and JVSCE information like an anonymous project identifier, Java version, Java VM name, Java preview-feature enablement, build tool and whether project loading had problems. <br>The identifier cannot be used to track the IP address or identity of the user. <br>Example: `[{"id": "02a4eb67236abe93d137136be01f1372b8372e2230896932ef25267df32b4f52", "buildTool": "MavenProject", "isOpenedWithProblems": false, "javaVersion": "21.0.6+8-LTS-jvmci-23.1-b59;Oracle GraalVM 21.0.6+8.1;Java HotSpot(TM) 64-Bit Server VM", "isPreviewEnabled": false}]` | | ||
| | JDK Download | Vendor | Indicates the vendor of the JDK downloaded using JVSCE. <br>Example: `OracleJDK` | | ||
| | JDK Download | Version | Indicates the version of the JDK downloaded. <br>Example: `21` | | ||
| | JDK Download | Platform | Indicates the OS name and architecture of the downloaded JDK. <br>Example: `windows`, `x64` | | ||
| | JDK Download | Timing Info | Indicates the time taken to download the JDK. | | ||
| | JDK Feature | JEPs | Indicates the Java language features used as denoted by their [JEP numbers](https://openjdk.org/jeps/0). <br>Example: `[477, 395, 394]` | | ||
| | JDK Feature | Features | Indicates the Java language features used as denoted by their common names. <br>Example: `["RECORDS", "SWITCH_RULE", "PATTERN_MATCHING_IN_INSTANCEOF"]` | | ||
| | JDK Feature | Version | Indicates the Java version and enablement of Java preview-features. <br>Example: `23.0.2+7-58`, `"isPreviewEnabled": true` | | ||
|
|
||
| See information on [Oracle Privacy Policies](https://www.oracle.com/legal/privacy/). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.