From 04cc45c9a1c1cbe37097efb11fec607b7920ad28 Mon Sep 17 00:00:00 2001 From: AgFlore Date: Thu, 28 Mar 2024 12:40:42 +0800 Subject: [PATCH 1/2] fix: Crashpad disabled regardless of `enable-crash-reporter` argv #1832 crash-reporter.patch no longer needed since https://github.com/microsoft/vscode/commit/65475dc56e04da109cf3744987f2e00fafca914f --- docs/index.md | 13 ++++++++++++- patches/crash-reporter.patch | 13 ------------- 2 files changed, 12 insertions(+), 14 deletions(-) delete mode 100644 patches/crash-reporter.patch diff --git a/docs/index.md b/docs/index.md index 7c29907b8b8..ec91f7fe693 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,6 +3,7 @@ ## Table of Contents - [Getting all the Telemetry Out](#disable-telemetry) + - [Enabling and Customizing the built-in Crashpad](#customize-crashpad) - [Replacements to Microsoft Online Services](#replacement-online-services) - [Extensions + Marketplace](#extensions-marketplace) - [How to use the OpenVSX Marketplace](#howto-openvsx-marketplace) @@ -29,7 +30,11 @@ Even though we do not pass the telemetry build flags (and go out of our way to c We do however set the default `telemetry.enableCrashReporter` and `telemetry.enableTelemetry` values to false. You can see those by viewing your VSCodium settings.json and searching for `telemetry`. -The instructions [here](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting) and [here](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-crash-reporting) help with explaining and toggling telemetry. ++ Note: since [VS Code v1.49](https://code.visualstudio.com/updates/v1_49#_disabling-crash-reporter), the actual switch that enables/disables Electron's crash reporter has been migrated (from `telemetry.enableCrashReporter` in `settings.json`) to `enable-crash-reporter` in `argv.json`. + ++ The instructions [here](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting) and [here](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-crash-reporting) help with explaining and toggling telemetry. + ++ For details about Electron's built-in crash reporter (based on Crashpad), check their [docs](https://www.electronjs.org/docs/latest/api/crash-reporter). It is also highly recommended that you review all the settings that "use online services" by following [these instructions](https://code.visualstudio.com/docs/getstarted/telemetry#_managing-online-services). The `@tag:usesOnlineServices` filter on the settings page will show that by default: @@ -41,6 +46,12 @@ These can all be disabled. __Please note that some extensions send telemetry data to Microsoft as well. We have no control over this and can only recommend removing the extension.__ _(For example, the C# extension `ms-vscode.csharp` sends tracking data to Microsoft.)_ +### Enabling and Customizing the built-in Crashpad + +As [implemented by VS Code](https://github.com/microsoft/vscode/wiki/Native-Crash-Issues), the directory where Electron places its crash minidumps can be customized, if one launches VSCodium with the `--crash-reporter-directory ` cli option. + +Note that when launched with this cli option, Crashpad will always be enabled, but never telemetered, regardless of the enable-crash-reporter configurations in `settings.json` and `argv.json`. The minidumps will be stored in your specified `` and never uploaded. + ### Replacements to Microsoft Online Services When searching the `@tag:usesOnlineServices` filter, note that while the "Update: Mode" setting description still says "The updates are fetched from a Microsoft online service", VSCodium's build script [sets the `updateUrl` field](https://github.com/VSCodium/vscodium/blob/master/prepare_vscode.sh#L36) in `product.json` to that of VSCodium's own small [update server](https://github.com/VSCodium/update-api), so enabling that setting won't actually result in any calls to Microsoft servers. diff --git a/patches/crash-reporter.patch b/patches/crash-reporter.patch deleted file mode 100644 index d86a90b3835..00000000000 --- a/patches/crash-reporter.patch +++ /dev/null @@ -1,13 +0,0 @@ -diff --git a/src/main.js b/src/main.js -index 19dde20..d9611f2 100644 ---- a/src/main.js -+++ b/src/main.js -@@ -409,6 +409,8 @@ function configureCrashReporter() { - argv.splice(endOfArgsMarkerIndex, 0, '--crash-reporter-id', crashReporterId); - } - } -+ } else { -+ return; - } - } - From 6002bf614ddfb5ce5d78a910c21d83ce4c8b8854 Mon Sep 17 00:00:00 2001 From: Baptiste Augrain Date: Mon, 4 Nov 2024 20:01:04 +0100 Subject: [PATCH 2/2] docs: remove crashpad sections --- docs/index.md | 15 ++------------- 1 file changed, 2 insertions(+), 13 deletions(-) diff --git a/docs/index.md b/docs/index.md index ec91f7fe693..4ac646e5270 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,7 +3,6 @@ ## Table of Contents - [Getting all the Telemetry Out](#disable-telemetry) - - [Enabling and Customizing the built-in Crashpad](#customize-crashpad) - [Replacements to Microsoft Online Services](#replacement-online-services) - [Extensions + Marketplace](#extensions-marketplace) - [How to use the OpenVSX Marketplace](#howto-openvsx-marketplace) @@ -28,13 +27,9 @@ Even though we do not pass the telemetry build flags (and go out of our way to cripple the baked-in telemetry), Microsoft will still track usage by default. -We do however set the default `telemetry.enableCrashReporter` and `telemetry.enableTelemetry` values to false. You can see those by viewing your VSCodium settings.json and searching for `telemetry`. +We do however set the `telemetry.enableTelemetry` setting's default value to `false`. You can see those by viewing your VSCodium `settings.json` and searching for `telemetry`. -+ Note: since [VS Code v1.49](https://code.visualstudio.com/updates/v1_49#_disabling-crash-reporter), the actual switch that enables/disables Electron's crash reporter has been migrated (from `telemetry.enableCrashReporter` in `settings.json`) to `enable-crash-reporter` in `argv.json`. - -+ The instructions [here](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting) and [here](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-crash-reporting) help with explaining and toggling telemetry. - -+ For details about Electron's built-in crash reporter (based on Crashpad), check their [docs](https://www.electronjs.org/docs/latest/api/crash-reporter). +The instructions [here](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting) help with explaining and toggling telemetry. It is also highly recommended that you review all the settings that "use online services" by following [these instructions](https://code.visualstudio.com/docs/getstarted/telemetry#_managing-online-services). The `@tag:usesOnlineServices` filter on the settings page will show that by default: @@ -46,12 +41,6 @@ These can all be disabled. __Please note that some extensions send telemetry data to Microsoft as well. We have no control over this and can only recommend removing the extension.__ _(For example, the C# extension `ms-vscode.csharp` sends tracking data to Microsoft.)_ -### Enabling and Customizing the built-in Crashpad - -As [implemented by VS Code](https://github.com/microsoft/vscode/wiki/Native-Crash-Issues), the directory where Electron places its crash minidumps can be customized, if one launches VSCodium with the `--crash-reporter-directory ` cli option. - -Note that when launched with this cli option, Crashpad will always be enabled, but never telemetered, regardless of the enable-crash-reporter configurations in `settings.json` and `argv.json`. The minidumps will be stored in your specified `` and never uploaded. - ### Replacements to Microsoft Online Services When searching the `@tag:usesOnlineServices` filter, note that while the "Update: Mode" setting description still says "The updates are fetched from a Microsoft online service", VSCodium's build script [sets the `updateUrl` field](https://github.com/VSCodium/vscodium/blob/master/prepare_vscode.sh#L36) in `product.json` to that of VSCodium's own small [update server](https://github.com/VSCodium/update-api), so enabling that setting won't actually result in any calls to Microsoft servers.