Skip to content

Commit 86ce7e7

Browse files
committed
Add analytics section to the appendix
1 parent fa0831f commit 86ce7e7

File tree

2 files changed

+103
-0
lines changed

2 files changed

+103
-0
lines changed

guides/appendix/analytics.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
Ember-cli tracks data points related to the use of the Ember-cli tool. This information is used by the
2+
Ember and Ember-cli core teams to identify upgrade blockers, monitor build performance, and understand which
3+
features are being used. Users who are uncomfortable with this data collection can permanently disable it by
4+
updating their .ember-cli file.
5+
6+
Ember-cli tracks (only) the following data points:
7+
8+
- ember-cli version
9+
- build/rebuild/live-reload times
10+
- how many errors occurred
11+
12+
**Note:** No personally identifying information is tracked, if something is
13+
being leaked please [disclose responsibly](https://emberjs.com/security)
14+
15+
This information is used to:
16+
17+
- See if there are upgrade blockers (users stuck on old version)
18+
- Have a broad idea for build performance (to make sure we don't regress, and how to prioritize)
19+
- See which high-level features are used (serve/test/build/generate etc.)
20+
- See an increase/decrease in error rates
21+
22+
## Still Not comfortable?
23+
24+
We understand! To permanently disable any analytics gathering you can update your project's `.ember-cli` file (or `$HOME/.ember-cli` for user-wide):
25+
26+
```json
27+
{
28+
"disableAnalytics": true
29+
}
30+
```
31+
32+
## Who has access
33+
34+
The ember and ember-cli core [teams](https://emberjs.com/teams/).
35+
These teams have been granted access to the analytics data in order to make informed decisions about the direction
36+
and future of the projects.
37+
38+
## Links to each code-point where ember-cli emits tracking information
39+
40+
### Command Name: To understand what high-level features are used
41+
42+
- [ember-cli/lib/models/command.js](https://github.com/ember-cli/ember-cli/blob/2da9de596370c0e78ea0c0c3ffcd6a551d2863a9/lib/models/command.js#L277)
43+
44+
```js
45+
this.analytics.track({
46+
name: 'ember ',
47+
message: this.name,
48+
});
49+
```
50+
51+
### Build Error: The name of the error
52+
53+
- [ember-cli/lib/models/watcher.js](https://github.com/ember-cli/ember-cli/blob/6ec50a1fd21d961f0b0e2ca4daf66a8e7dea6417/lib/models/watcher.js#L32-L34)
54+
55+
```js
56+
this.analytics.trackError({
57+
description: error && error.message,
58+
});
59+
```
60+
61+
### Build/Rebuild Time: Can help identify areas of optimization
62+
63+
- [ember-cli/lib/tasks/build.js](https://github.com/ember-cli/ember-cli/blob/503ede1fcb5224d54dc36f82af84550a91d90f26/lib/tasks/build.js#L33)
64+
65+
```js
66+
analytics.track({
67+
name: 'ember build',
68+
message: `${totalTime}ms`,
69+
});
70+
```
71+
72+
- [ember-cli/lib/tasks/build.js](https://github.com/ember-cli/ember-cli/blob/503ede1fcb5224d54dc36f82af84550a91d90f26/lib/tasks/build.js#L44)
73+
74+
```js
75+
analytics.trackTiming({
76+
category: 'rebuild',
77+
variable: 'build time',
78+
label: 'broccoli build time',
79+
value: parseInt(totalTime, 10),
80+
});
81+
```
82+
83+
### Live Reload
84+
85+
- [ember-cli/lib/tasks/server/livereload-server.js](https://github.com/ember-cli/ember-cli/blob/503ede1fcb5224d54dc36f82af84550a91d90f26/lib/tasks/server/livereload-server.js#L167)
86+
87+
```js
88+
this.analytics.track({
89+
name: 'broccoli watcher',
90+
message: 'live-reload',
91+
});
92+
```
93+
94+
- [ember-cli/lib/tasks/server/livereload-server.js](https://github.com/ember-cli/ember-cli/blob/503ede1fcb5224d54dc36f82af84550a91d90f26/lib/tasks/server/livereload-server.js#L181)
95+
96+
```js
97+
this.analytics.track({
98+
name: 'express server',
99+
message: 'live-reload',
100+
});
101+
```

guides/pages.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,3 +83,5 @@
8383
url: 'common-issues'
8484
- title: 'Live reload integration'
8585
url: 'live-reload'
86+
- title: 'Analytics'
87+
url: 'analytics'

0 commit comments

Comments
 (0)