Skip to content

Commit e56c172

Browse files
authored
Merge pull request #8300 from microsoft/telemetry
Update instructions for showing telemetry events
2 parents 7ef53ec + b378445 commit e56c172

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/configure/telemetry.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,14 @@ With the `setting(telemetry.telemetryLevel)` user [setting](/docs/configure/sett
3232
| crash || - | - |
3333
| off | - | - | - |
3434

35-
For example, if you don't want to send any telemetry data to Microsoft, you can set the `setting(telemetry.telemetryLevel)` user [setting](/docs/configure/settings.md) to `off`.
36-
37-
From **File** > **Preferences** > **Settings**, search for `telemetry`, and set the **Telemetry: Telemetry Level** setting to `off`. This will silence all telemetry events from VS Code going forward. Telemetry information may have been collected and sent up until the point when you disable the setting.
35+
For example, if you don't want to send any telemetry data to Microsoft, you can set the `setting(telemetry.telemetryLevel)` user [setting](/docs/configure/settings.md) to `off`. This will silence all telemetry events from VS Code going forward. Note that telemetry information may have been collected and sent up until the point when you disable the setting.
3836

3937
![disable telemetry](images/telemetry/disable-telemetry.png)
4038

4139
If you use the JSON editor for your settings, add the following line:
4240

4341
```json
44-
"telemetry.telemetryLevel": "off"
42+
"telemetry.telemetryLevel": "off"
4543
```
4644

4745
## Extensions and telemetry
@@ -52,14 +50,16 @@ Extension authors may refer to the ["For Extension Authors"](#for-extension-auth
5250

5351
## Output channel for telemetry events
5452

55-
If you'd like to review the telemetry events in VS Code as they are sent, you can enable tracing and it will record telemetry events. Using the **Developer: Set Log Level...** command and select log level **Trace**. To view the logging output, go to the Output panel (`kb(workbench.action.output.toggleOutput)`) and pick **Telemetry** from the dropdown.
53+
To review the telemetry events in VS Code as they are sent, run the **Developer: Show Telemetry** command from the Command Palette (`kb(workbench.action.showTelemetry)`). This command enables tracing for telemetry events and opens the **Telemetry** output channel in the Output panel (`kb(workbench.action.output.toggleOutput)`). As telemetry events are sent, the output channel shows the event details.
5654

5755
![output panel log telemetry](images/telemetry/output-log-telemetry.png)
5856

59-
When tracing telemetry events, the events are also logged to a local file `telemetry.log`, which you can view using the **Developer: Open Log File...** command and choosing **Telemetry** from the dropdown.
57+
When tracing telemetry events, the events are also logged to a local file `telemetry.log`, which you can view using the **Developer: Open Log...** command and choosing **Telemetry** from the dropdown.
6058

6159
![open telemetry log file](images/telemetry/open-telemetry-log.png)
6260

61+
To disable tracing telemetry events, reload the VS Code window (**Developer: Reload Window** command).
62+
6363
## Viewing all telemetry events
6464

6565
If you'd like to view all the possible telemetry events that VS Code could send, you can use the `--telemetry` flag in the CLI. This will generate a JSON report that you can then view within VS Code. These reports are generated per build and do not contain extension telemetry unless the extension author adds a `telemetry.json` file to their root build directory.

0 commit comments

Comments
 (0)