Graham/angular-cli
1
0
Fork 0
mirror of https://github.com/angular/angular-cli.git synced 2025-05-15 10:11:50 +08:00
Code Issues Packages Projects Releases Wiki Activity
angular-cli/docs/design/analytics.md
Alan Agius 3928d084e6 ci: add validation for parameters length 
Needed as otherwise if the parameter is longer we are unable to map this in GA4.

GA4 has a limit of:
- 24 characters for custom user dimension parameter names
- 40 characters for custom event dimension parameter names
- 40 characters for custom metric dimension parameter names
2022-10-12 15:32:28 +02:00

4.0 KiB
Raw Blame History

Usage Metrics Gathering

This document list exactly what is gathered and how.

Any change to analytics should most probably include a change to this document.

Dimensions and Metrics

Google Analytics Custom Dimensions are used to track system values and flag values. These dimensions are aggregated automatically on the backend.

One dimension per flag, and although technically there can be an overlap between 2 commands, for simplicity it should remain unique across all CLI commands. The dimension is the value of the x-user-analytics field in the schema.json files.

Adding dimension or metic.

  1. Create the dimension or metric in (https://analytics.google.com/)[Google Analytics] first. These are not tracked if they aren't defined in Google Analytics.
  2. Use the ID of the dimension as the x-user-analytics value in the schema.json file.
  3. New dimension and metrics PRs need to be approved by the tooling lead and require a new (http://go/launch)[Launch].

Deleting a dimension or metic.

  1. Archive the dimension and metric in (https://analytics.google.com/)[Google Analytics].

DO NOT ADD x-user-analytics FOR VALUES THAT ARE USER IDENTIFIABLE (PII), FOR EXAMPLE A PROJECT NAME TO BUILD OR A MODULE NAME.

Limits

Item Standard property limits
Event-scoped custom dimensions 50
User-scoped custom dimensions 25
All custom metrics 50

List of User Custom Dimensions

Name Parameter Type
OsArchitecture up.ng_os_architecture string
NodeVersion up.ng_node_version string
NodeMajorVersion upn.ng_node_major_version number
AngularCLIVersion up.ng_cli_version string
AngularCLIMajorVersion upn.ng_cli_major_version number
PackageManager up.ng_package_manager string
PackageManagerVersion up.ng_pkg_manager_version string
PackageManagerMajorVersion upn.ng_pkg_manager_major_v number

List of Event Custom Dimensions

Name Parameter Type
Command ep.ng_command string
SchematicCollectionName ep.ng_schematic_collection_name string
SchematicName ep.ng_schematic_name string
Standalone ep.ng_standalone string
Style ep.ng_style string
Routing ep.ng_routing string
InlineTemplate ep.ng_inline_template string
InlineStyle ep.ng_inline_style string
BuilderTarget ep.ng_builder_target string
Aot ep.ng_aot string
Optimization ep.ng_optimization string

List of Event Custom Metrics

Name Parameter Type
AllChunksCount epn.ng_all_chunks_count number
LazyChunksCount epn.ng_lazy_chunks_count number
InitialChunksCount epn.ng_initial_chunks_count number
ChangedChunksCount epn.ng_changed_chunks_count number
DurationInMs epn.ng_duration_ms number
CssSizeInBytes epn.ng_css_size_bytes number
JsSizeInBytes epn.ng_js_size_bytes number
NgComponentCount epn.ng_component_count number

Debugging

Using NG_DEBUG=1 will enable Google Analytics debug mode, To view the debug events, in Google Analytics go to Configure > DebugView.

Disabling Usage Analytics

There are 2 ways of disabling usage analytics:

  1. using ng analytics disable --global (or changing the global configuration file yourself). This is the same as answering "No" to the prompt.
  2. There is an NG_CLI_ANALYTICS environment variable that overrides the global configuration. That flag is a string that represents the User ID. If the string "false" is used it will disable analytics for this run.