Skip to content

Commit

Permalink
chore(docs): Add docs for Nx Console telemetry (#16062)
Browse files Browse the repository at this point in the history
  • Loading branch information
Cammisuli authored Apr 3, 2023
1 parent ea34e88 commit 762dd1d
Show file tree
Hide file tree
Showing 5 changed files with 92 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/generated/manifests/menus.json
Original file line number Diff line number Diff line change
Expand Up @@ -1764,6 +1764,14 @@
"id": "nx-console",
"isExternal": false,
"children": [
{
"name": "Nx Console Telemetry",
"path": "/recipes/nx-console/console-telemetry",
"id": "console-telemetry",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Nx Console Generate Command",
"path": "/recipes/nx-console/console-generate-command",
Expand Down Expand Up @@ -1807,6 +1815,14 @@
],
"disableCollapsible": false
},
{
"name": "Nx Console Telemetry",
"path": "/recipes/nx-console/console-telemetry",
"id": "console-telemetry",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Nx Console Generate Command",
"path": "/recipes/nx-console/console-generate-command",
Expand Down
20 changes: 20 additions & 0 deletions docs/generated/manifests/recipes.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,16 @@
"description": "Checkout all the recipes related to Nx Console.",
"file": "",
"itemList": [
{
"id": "console-telemetry",
"name": "Nx Console Telemetry",
"description": "",
"file": "shared/recipes/console-telemetry",
"itemList": [],
"isExternal": false,
"path": "/recipes/nx-console/console-telemetry",
"tags": ["integrate-with-editors"]
},
{
"id": "console-generate-command",
"name": "Nx Console Generate Command",
Expand Down Expand Up @@ -91,6 +101,16 @@
"path": "/recipes/nx-console",
"tags": []
},
"/recipes/nx-console/console-telemetry": {
"id": "console-telemetry",
"name": "Nx Console Telemetry",
"description": "",
"file": "shared/recipes/console-telemetry",
"itemList": [],
"isExternal": false,
"path": "/recipes/nx-console/console-telemetry",
"tags": ["integrate-with-editors"]
},
"/recipes/nx-console/console-generate-command": {
"id": "console-generate-command",
"name": "Nx Console Generate Command",
Expand Down
7 changes: 7 additions & 0 deletions docs/generated/manifests/tags.json
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,13 @@
"name": "Integrate with Editors",
"path": "/core-features/integrate-with-editors"
},
{
"description": "",
"file": "shared/recipes/console-telemetry",
"id": "console-telemetry",
"name": "Nx Console Telemetry",
"path": "/recipes/nx-console/console-telemetry"
},
{
"description": "",
"file": "shared/recipes/console-generate-command",
Expand Down
6 changes: 6 additions & 0 deletions docs/map.json
Original file line number Diff line number Diff line change
Expand Up @@ -708,6 +708,12 @@
"id": "nx-console",
"description": "Checkout all the recipes related to Nx Console.",
"itemList": [
{
"name": "Nx Console Telemetry",
"id": "console-telemetry",
"tags": ["integrate-with-editors"],
"file": "shared/recipes/console-telemetry"
},
{
"name": "Nx Console Generate Command",
"id": "console-generate-command",
Expand Down
43 changes: 43 additions & 0 deletions docs/shared/recipes/console-telemetry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## Nx Console Telemetry

To ensure that we focus on creating features that benefit your day-to-day workflow, we collect some data from the Nx Console extensions.

## Collected Data

Here's the information we collect for each extension.

### User Data

> None of the information that we ask for is used to track any personal information
| Property | Description |
| ----------- | ----------------------------------------------------------------------------------------- |
| Client ID | These are retrieved by APIs provided by each editor. We do not generate this information. |
| User ID | We use the same value as the Client ID |
| Session ID | Generated UUID |
| OS | What operating system are you using? |
| Editor | What editor are you using? Visual Studio Code, Intellij, etc |
| App Version | What version of the extension is being used? |

### Event Data

| Property | Description |
| ------------------- | ---------------------------------- |
| Extension Activated | Extension activation timings |
| Action Triggered | Nx Generate, Nx Run, Nx Graph, etc |

## Visual Studio Code

For Visual Studio Code, we use the global telemetry setting provided by the editor. This is controlled by the `telemetry.telemetryLevel` setting

#### How to Disable telemetry for Visual Studio Code

Setting `telemetry.telemetryLevel` to `off` will disable telemetry for Nx Console in Visual Studio Code. Read more about the telemetry settings in Visual Studio Code [here](https://code.visualstudio.com/docs/getstarted/telemetry#_disable-telemetry-reporting)

## Jetbrains (IntelliJ, Webstorm, etc)

When the plugin is first installed, we will prompt you to opt in or out of reporting telemetry.

#### How to Disable Telemetry for Jetbrains editors

To turn off telemetry after opting in, go to **Settings** > **Tools** > **Nx Console** > Uncheck **Enable Telemetry**

1 comment on commit 762dd1d

@vercel
Copy link

@vercel vercel bot commented on 762dd1d Apr 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

nx-dev – ./

nx-dev-git-master-nrwl.vercel.app
nx-dev-nrwl.vercel.app
nx-five.vercel.app
nx.dev

Please sign in to comment.