diff --git a/aio/content/cli/usage-analytics-gathering.md b/aio/content/cli/usage-analytics-gathering.md index 1b6bb9cdc3..b9966bacef 100644 --- a/aio/content/cli/usage-analytics-gathering.md +++ b/aio/content/cli/usage-analytics-gathering.md @@ -1,38 +1,48 @@ -# Gathering Usage Analytics -Administrators can configure their instances of Angular CLI to share usage analytics with -third parties. This sharing is separate from and in addition to usage analytics shared -with Google. It is disabled by default and cannot be enabled at the project level for -all users. It must be set at the global configuration level for each user to allow -managed users to opt in and share usage analytics. +# Gathering and Viewing Usage Analytics -To configure usage analytics sharing, use the `ng config` command to add both the user ID -and the third-party ID to the user's global Angular CLI configuration. +Users can opt in to share their Angular CLI usage data with [Google Analytics](https://support.google.com/analytics/answer/1008015?hl=en), using the [`ng analytics` CLI command](analytics). +The data is also shared with the Angular team, and used to improve the CLI. -- The third-party ID is the tracking identifier of the third-party Google Analytics - account. This ID is a string that looks like `UA-123456-12`. -- You can choose a user ID, or be assigned a random user ID when you run the CLI command. +The gathering of CLI analytics data is disabled by default, and must be enabled at the project level by individual users. +It cannot be enabled at the project level for all users. -Once you have the third-party tracking ID, add it to your global configuration using the following command: +Data gathered in this way can be viewed on the Google Analytics site, but is not automatically visible on your own organization's Analytics site. +As an administrator for an Angular development group, you can configure your instance of Angular CLI to be able to see analytics data for your own team's usage of the Angular CLI. +This configuration option is separate from and in addition to other usage analytics that your users may be sharing with Google. -``` +## Enable access to CLI usage data + +To configure access to your own users' CLI usage data, use the `ng config` command to add a key to your global [`angular.json` workspace configuration file](guide/workspace-config). +The key goes under `cli.analyticsSharing` at the top level of the file, outside the `projects` sections. +The value of the key is your organization's tracking ID, as assigned by Google Analytics. +This ID is a string that looks like `UA-123456-12`. + +You can choose to use a descriptive string as the key value, or be assigned a random key when you run the CLI command. +For example, the following command adds a configuration key named "tracking". + + ng config --global cli.analyticsSharing.tracking UA-123456-12 -``` - -To add a custom user ID to the global configuration using the following command. This -should be unique per users to identify unique usage of commands and flags. - -``` -ng config --global cli.analyticsSharing.user SOME_USER_NAME -``` - -To generate a new random user ID, run the following command: - -``` -ng config --global cli.analyticsSharing.user "" -``` + To turn off this feature, run the following command: -``` + ng config --global --remove cli.analyticsSharing -``` + + + +## Per user tracking + +You can add a custom user ID to the global configuration, in order to identify unique usage of commands and flags. +If that user enables CLI analytics for their own project, your analytics display tracks and labels their individual usage. + + + +ng config --global cli.analyticsSharing.user SOME_USER_NAME + + +To generate a new random user ID, run the following command: + + +ng config --global cli.analyticsSharing.user "" +