diff --git a/vscode/TELEMETRY.md b/vscode/TELEMETRY.md new file mode 100644 index 00000000..b3c4e0d8 --- /dev/null +++ b/vscode/TELEMETRY.md @@ -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.
It cannot be used to track the IP address or identity of the user.
Example: `9c5aa07a61ed54bbf61705d17bd214ef269bbed8d5a557ba9e50658b31ffae79` | +| _ALL_ | VscSessionId | Anonymous session identifier generated by VS Code.
It cannot be used to track the IP address or identity of the user.
Example: `15cf5498-7981-45af-aca3-34e0fa6e906c1716187959345` | +| Start | ExtensionInfo | JVSCE information like extension name, id and version.
Example: `Oracle.oracle-java`, `oracle-java`, `23.1.0` | +| Start | VsCodeInfo | VS Code related information like version, language and host-type.
Example: `1.97.2`, `en`, `desktop` | +| Start | PlatformInfo | Host platform/OS information like os name, architecture and version.
Example: `mac`, `arm64`, `14.6` | +| Start | LocationInfo | Platform location information like language-region and time-zone.
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.
The identifier cannot be used to track the IP address or identity of the user.
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.
Example: `OracleJDK` | +| JDK Download | Version | Indicates the version of the JDK downloaded.
Example: `21` | +| JDK Download | Platform | Indicates the OS name and architecture of the downloaded JDK.
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).
Example: `[477, 395, 394]` | +| JDK Feature | Features | Indicates the Java language features used as denoted by their common names.
Example: `["RECORDS", "SWITCH_RULE", "PATTERN_MATCHING_IN_INSTANCEOF"]` | +| JDK Feature | Version | Indicates the Java version and enablement of Java preview-features.
Example: `23.0.2+7-58`, `"isPreviewEnabled": true` | + +See information on [Oracle Privacy Policies](https://www.oracle.com/legal/privacy/). diff --git a/vscode/l10n/bundle.l10n.en.json b/vscode/l10n/bundle.l10n.en.json index 2f913dca..d58a1782 100644 --- a/vscode/l10n/bundle.l10n.en.json +++ b/vscode/l10n/bundle.l10n.en.json @@ -96,5 +96,5 @@ "jdk.workspace.new.prompt": "Input the directory path where the new file will be generated", "jdk.extension.utils.error_message.failedHttpsRequest": "Failed to get {url} ({statusCode})", "jdk.extension.error_msg.notEnabled": "{SERVER_NAME} not enabled", - "jdk.telemetry.consent": "Do you want to enable telemetry for {extensionName} extension? You may opt-out or in at any time from the Settings for jdk.telemetry.enabled." + "jdk.telemetry.consent": "Allow anonymous telemetry data to be reported to Oracle? You may opt-out or in at any time from the Settings for jdk.telemetry.enabled." } diff --git a/vscode/l10n/bundle.l10n.ja.json b/vscode/l10n/bundle.l10n.ja.json index a966b882..3f610e93 100755 --- a/vscode/l10n/bundle.l10n.ja.json +++ b/vscode/l10n/bundle.l10n.ja.json @@ -96,5 +96,5 @@ "jdk.workspace.new.prompt": "新しいファイルを生成するディレクトリのパスを入力してください", "jdk.extension.utils.error_message.failedHttpsRequest": "{url}の取得に失敗しました({statusCode})", "jdk.extension.error_msg.notEnabled": "{SERVER_NAME}が有効化されていません", - "jdk.telemetry.consent": "Do you want to enable telemetry for {extensionName} extension? You may opt-out or in at any time from the Settings for jdk.telemetry.enabled." + "jdk.telemetry.consent": "Allow anonymous telemetry data to be reported to Oracle? You may opt-out or in at any time from the Settings for jdk.telemetry.enabled." } diff --git a/vscode/l10n/bundle.l10n.zh-cn.json b/vscode/l10n/bundle.l10n.zh-cn.json index 9551f2ac..1b0217b6 100755 --- a/vscode/l10n/bundle.l10n.zh-cn.json +++ b/vscode/l10n/bundle.l10n.zh-cn.json @@ -96,5 +96,5 @@ "jdk.workspace.new.prompt": "输入生成新文件的目录路径", "jdk.extension.utils.error_message.failedHttpsRequest": "无法获取 {url} ({statusCode})", "jdk.extension.error_msg.notEnabled": "{SERVER_NAME} 未启用", - "jdk.telemetry.consent": "Do you want to enable telemetry for {extensionName} extension? You may opt-out or in at any time from the Settings for jdk.telemetry.enabled." + "jdk.telemetry.consent": "Allow anonymous telemetry data to be reported to Oracle? You may opt-out or in at any time from the Settings for jdk.telemetry.enabled." } diff --git a/vscode/package.json b/vscode/package.json index 0a9a7e7e..d8328bf6 100644 --- a/vscode/package.json +++ b/vscode/package.json @@ -245,9 +245,10 @@ "jdk.telemetry.enabled": { "type": "boolean", "description": "%jdk.configuration.telemetry.enabled.description%", + "markdownDescription": "%jdk.configuration.telemetry.enabled.markdownDescription%", "default": false, "tags": [ - "telemetry" + "telemetry" ] } } diff --git a/vscode/package.nls.ja.json b/vscode/package.nls.ja.json index 99586750..1531b5fc 100755 --- a/vscode/package.nls.ja.json +++ b/vscode/package.nls.ja.json @@ -46,7 +46,8 @@ "jdk.configuration.runConfig.cwd.description": "作業ディレクトリ", "jdk.configuration.disableNbJavac.description": "拡張オプション: nb-javacライブラリを無効化すると、選択したJDKからのjavacが使用されます。選択したJDKは少なくともJDK 23である必要があります。", "jdk.configuration.disableProjectSearchLimit.description": "拡張オプション: プロジェクト情報が含まれているフォルダの検索に対する制限を無効化します。", - "jdk.configuration.telemetry.enabled.description": "Allow the Oracle Java Visual Studio Code extension to collect and send usage data to Oracle servers to help improve the Java platform support. No personal information nor source code is collected. You may refer to our general privacy policy at https://www.oracle.com/legal/privacy/services-privacy-policy/", + "jdk.configuration.telemetry.enabled.description": "Allow the Oracle Java extension for Visual Studio Code (\"JVSCE\") to collect and send anonymous technical data commonly known as \"telemetry data\" to Oracle to help improve the Java platform. No personal information nor source code is collected. You may refer to the data collection and privacy policy for JVSCE at https://github.com/oracle/javavscode/blob/main/vscode/TELEMETRY.md", + "jdk.configuration.telemetry.enabled.markdownDescription": "Allow the Oracle Java extension for Visual Studio Code (\"*JVSCE*\") to collect and send anonymous technical data commonly known as \"*telemetry data*\" to Oracle to help improve the Java platform. No personal information nor source code is collected. You may refer to the data collection and privacy policy for JVSCE at [TELEMETRY.md](https://github.com/oracle/javavscode/blob/main/vscode/TELEMETRY.md).", "jdk.debugger.configuration.mainClass.markdownDescription": "Main class specification. Supported formats:\n - an absolute path\n - a path relative to any of the workspace folders\n - a fully qualified name of a class.", "jdk.debugger.configuration.classPaths.description": "JVMの起動のためのクラスパス。", "jdk.debugger.configuration.console.description": "プログラムを起動する指定されたコンソール。", diff --git a/vscode/package.nls.json b/vscode/package.nls.json index 074203da..9ac96178 100644 --- a/vscode/package.nls.json +++ b/vscode/package.nls.json @@ -46,7 +46,8 @@ "jdk.configuration.runConfig.cwd.description": "Working directory", "jdk.configuration.disableNbJavac.description": "Advanced option: disable nb-javac library, javac from the selected JDK will be used. The selected JDK must be at least JDK 23.", "jdk.configuration.disableProjectSearchLimit.description": "Advanced option: disable limits on searching in containing folders for project information.", - "jdk.configuration.telemetry.enabled.description": "Allow the Oracle Java Visual Studio Code extension to collect and send usage data to Oracle servers to help improve the Java platform support. No personal information nor source code is collected. You may refer to our general privacy policy at https://www.oracle.com/legal/privacy/services-privacy-policy/", + "jdk.configuration.telemetry.enabled.description": "Allow the Oracle Java extension for Visual Studio Code (\"JVSCE\") to collect and send anonymous technical data commonly known as \"telemetry data\" to Oracle to help improve the Java platform. No personal information nor source code is collected. You may refer to the data collection and privacy policy for JVSCE at https://github.com/oracle/javavscode/blob/main/vscode/TELEMETRY.md", + "jdk.configuration.telemetry.enabled.markdownDescription": "Allow the Oracle Java extension for Visual Studio Code (\"*JVSCE*\") to collect and send anonymous technical data commonly known as \"*telemetry data*\" to Oracle to help improve the Java platform. No personal information nor source code is collected. You may refer to the data collection and privacy policy for JVSCE at [TELEMETRY.md](https://github.com/oracle/javavscode/blob/main/vscode/TELEMETRY.md).", "jdk.debugger.configuration.mainClass.markdownDescription": "Main class specification. Supported formats:\n - an absolute path\n - a path relative to any of the workspace folders\n - a fully qualified name of a class.", "jdk.debugger.configuration.classPaths.description": "The classpaths for launching the JVM.", "jdk.debugger.configuration.console.description": "The specified console to launch the program.", diff --git a/vscode/package.nls.zh-cn.json b/vscode/package.nls.zh-cn.json index b7278500..6cc9f88f 100755 --- a/vscode/package.nls.zh-cn.json +++ b/vscode/package.nls.zh-cn.json @@ -46,7 +46,8 @@ "jdk.configuration.runConfig.cwd.description": "工作目录", "jdk.configuration.disableNbJavac.description": "高级选项：禁用 nb-javac 库，将使用来自所选 JDK 的 javac。所选 JDK 必须至少为 JDK 23。", "jdk.configuration.disableProjectSearchLimit.description": "高级选项：禁用在包含项目信息的文件夹中搜索的限制。", - "jdk.configuration.telemetry.enabled.description": "Allow the Oracle Java Visual Studio Code extension to collect and send usage data to Oracle servers to help improve the Java platform support. No personal information nor source code is collected. You may refer to our general privacy policy at https://www.oracle.com/legal/privacy/services-privacy-policy/", + "jdk.configuration.telemetry.enabled.description": "Allow the Oracle Java extension for Visual Studio Code (\"JVSCE\") to collect and send anonymous technical data commonly known as \"telemetry data\" to Oracle to help improve the Java platform. No personal information nor source code is collected. You may refer to the data collection and privacy policy for JVSCE at https://github.com/oracle/javavscode/blob/main/vscode/TELEMETRY.md", + "jdk.configuration.telemetry.enabled.markdownDescription": "Allow the Oracle Java extension for Visual Studio Code (\"*JVSCE*\") to collect and send anonymous technical data commonly known as \"*telemetry data*\" to Oracle to help improve the Java platform. No personal information nor source code is collected. You may refer to the data collection and privacy policy for JVSCE at [TELEMETRY.md](https://github.com/oracle/javavscode/blob/main/vscode/TELEMETRY.md)", "jdk.debugger.configuration.mainClass.markdownDescription": "Main class specification. Supported formats:\n - an absolute path\n - a path relative to any of the workspace folders\n - a fully qualified name of a class.", "jdk.debugger.configuration.classPaths.description": "用于启动 JVM 的类路径。", "jdk.debugger.configuration.console.description": "用于启动程序的指定控制台。", diff --git a/vscode/src/telemetry/telemetryManager.ts b/vscode/src/telemetry/telemetryManager.ts index 076801cb..28b12422 100644 --- a/vscode/src/telemetry/telemetryManager.ts +++ b/vscode/src/telemetry/telemetryManager.ts @@ -58,7 +58,7 @@ export class TelemetryManager { const yesLabel = l10n.value("jdk.downloader.message.confirmation.yes"); const noLabel = l10n.value("jdk.downloader.message.confirmation.no"); - const telemetryLabel = l10n.value("jdk.telemetry.consent", { extensionName: this.extensionContextInfo.getPackageJson().name }); + const telemetryLabel = l10n.value("jdk.telemetry.consent"); const enable = await window.showInformationMessage(telemetryLabel, yesLabel, noLabel); if (enable == undefined) {