diff --git a/docs/generated/manifests/menus.json b/docs/generated/manifests/menus.json index d9b7d81b05f85..bf15a1b82c1fc 100644 --- a/docs/generated/manifests/menus.json +++ b/docs/generated/manifests/menus.json @@ -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", @@ -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", diff --git a/docs/generated/manifests/recipes.json b/docs/generated/manifests/recipes.json index c0ad3bee9e567..3d4d84be28385 100644 --- a/docs/generated/manifests/recipes.json +++ b/docs/generated/manifests/recipes.json @@ -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", @@ -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", diff --git a/docs/generated/manifests/tags.json b/docs/generated/manifests/tags.json index caa837aab7d65..1aff8f12159dc 100644 --- a/docs/generated/manifests/tags.json +++ b/docs/generated/manifests/tags.json @@ -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", diff --git a/docs/map.json b/docs/map.json index f5af614c0fe39..3cf6fd2442463 100644 --- a/docs/map.json +++ b/docs/map.json @@ -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", diff --git a/docs/shared/recipes/console-telemetry.md b/docs/shared/recipes/console-telemetry.md new file mode 100644 index 0000000000000..6e77094cda158 --- /dev/null +++ b/docs/shared/recipes/console-telemetry.md @@ -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**