Skip to content
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

fix: Crashpad disabled regardless of enable-crash-reporter argv #1832 #1838

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 12 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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:

Expand All @@ -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.)_

### <a id="customize-crashpad"></a>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 <absolute-path>` 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 `<absolute-path>` and never uploaded.

### <a id="replacement-online-services"></a>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.
Expand Down
13 changes: 0 additions & 13 deletions patches/crash-reporter.patch

This file was deleted.