-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- add `HOMEBREW_PRODUCT` global variable - only differentiate between `/usr/local` and `non-/usr/local` Homebrew prefixes to avoid sharing sensitive user information - note if e.g. build errors are occurring under CI - Add `HOMEBREW_NO_ANALYTICS` variable (this will be how people opt-out when this is enabled for everyone) - Add `HOMEBREW_ANALYTICS_DEBUG` variable to output all the analytics that are sent - Move Bash analytics code to `Library/Homebrew/utils/analytics.sh` - Add documentation for our analytics and why/what/when/how and opt-out - Only official Homebrew commands are reported - Ruby analytics are now reported in a forked, background process
- Loading branch information
1 parent
1d9977b
commit 840b6ab
Showing
5 changed files
with
154 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
setup-analytics() { | ||
if [[ -z "$HOMEBREW_ANALYTICS" || -n "$HOMEBREW_NO_ANALYTICS" ]] | ||
then | ||
return | ||
fi | ||
|
||
# User UUID file. Used for Homebrew user counting. Can be deleted and | ||
# recreated with no adverse effect (beyond our user counts being inflated). | ||
HOMEBREW_ANALYTICS_USER_UUID_FILE="$HOME/.homebrew_analytics_user_uuid" | ||
if [[ -r "$HOMEBREW_ANALYTICS_USER_UUID_FILE" ]] | ||
then | ||
HOMEBREW_ANALYTICS_USER_UUID="$(<"$HOMEBREW_ANALYTICS_USER_UUID_FILE")" | ||
else | ||
HOMEBREW_ANALYTICS_USER_UUID="$(uuidgen)" | ||
echo "$HOMEBREW_ANALYTICS_USER_UUID" > "$HOMEBREW_ANALYTICS_USER_UUID_FILE" | ||
fi | ||
export HOMEBREW_ANALYTICS_ID="UA-75654628-1" | ||
export HOMEBREW_ANALYTICS_USER_UUID | ||
} | ||
|
||
report-analytics-screenview-command() { | ||
if [[ -z "$HOMEBREW_ANALYTICS" || -n "$HOMEBREW_NO_ANALYTICS" ]] | ||
then | ||
return | ||
fi | ||
|
||
# Don't report non-official commands. | ||
if ! [[ "$HOMEBREW_COMMAND" = "bundle" || | ||
"$HOMEBREW_COMMAND" = "cask" || | ||
"$HOMEBREW_COMMAND" = "services" || | ||
-f "$HOMEBREW_LIBRARY/Homebrew/cmd/$HOMEBREW_COMMAND.rb" || | ||
-f "$HOMEBREW_LIBRARY/Homebrew/cmd/$HOMEBREW_COMMAND.sh" || | ||
-f "$HOMEBREW_LIBRARY/Homebrew/dev-cmd/$HOMEBREW_COMMAND.rb" || | ||
-f "$HOMEBREW_LIBRARY/Homebrew/dev-cmd/$HOMEBREW_COMMAND.sh" ]] | ||
then | ||
return | ||
fi | ||
|
||
setup-analytics | ||
|
||
if [ -z "$HOMEBREW_ANALYTICS_DEBUG" ] | ||
then | ||
# Send the to-be-executed command as an "App Screen View". Anonymise the IP | ||
# address (aip=1) and don't send or store any personally identifiable | ||
# information. | ||
# https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Analytics.md | ||
# https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#screenView | ||
# https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters | ||
"$HOMEBREW_CURL" https://www.google-analytics.com/collect \ | ||
--max-time 3 \ | ||
--user-agent "$HOMEBREW_USER_AGENT_CURL" \ | ||
-d v="1" \ | ||
-d tid="$HOMEBREW_ANALYTICS_ID" \ | ||
-d cid="$HOMEBREW_ANALYTICS_USER_UUID" \ | ||
-d aip="1" \ | ||
-d an="$HOMEBREW_PRODUCT" \ | ||
-d av="$HOMEBREW_VERSION" \ | ||
-d t="screenview" \ | ||
-d cd="$HOMEBREW_COMMAND" \ | ||
--silent --output /dev/null &>/dev/null & disown | ||
else | ||
"$HOMEBREW_CURL" https://www.google-analytics.com/debug/collect \ | ||
--max-time 3 \ | ||
--user-agent "$HOMEBREW_USER_AGENT_CURL" \ | ||
-d v="1" \ | ||
-d tid="$HOMEBREW_ANALYTICS_ID" \ | ||
-d cid="$HOMEBREW_ANALYTICS_USER_UUID" \ | ||
-d aip="1" \ | ||
-d an="$HOMEBREW_PRODUCT" \ | ||
-d av="$HOMEBREW_VERSION" \ | ||
-d t="screenview" \ | ||
-d cd="$HOMEBREW_COMMAND" | ||
fi | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Analytics | ||
Homebrew will shortly begin gathering anonymous aggregate user behaviour analytics and reporting these to Google Analytics. | ||
|
||
## Why? | ||
Homebrew is provided free of charge and run entirely by volunteers in their spare time. As a result, we do not have the resources to do detailed user studies of Homebrew users to decide on how best to design future features and prioritise current work. Anonymous aggregate user analytics allow us to prioritise fixes and features based on how, where and when people use Homebrew. | ||
|
||
## What? | ||
Homebrew's analytics record some shared information for every event: | ||
|
||
- The Homebrew user agent e.g. `Homebrew/0.9.9 (Macintosh; Intel Mac OS X 10.11.4) curl/7.43.0` | ||
- The Google Analytics version i.e. `1` (https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#v) | ||
- The Homebrew analytics tracking ID e.g. `UA-75654628-1` (https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#tid) | ||
- A Homebrew analytics user ID e.g. `1BAB65CC-FE7F-4D8C-AB45-B7DB5A6BA9CB`. This is generated by `uuidgen` and stored in `~/.homebrew_analytics_user_uuid`. This does not allow us to track individual users but does enable us to accurately measure user counts vs. event counts (https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#cid) | ||
- The Google Analytics anonymous IP setting is enabled i.e. `1` (https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#aip) | ||
- The Homebrew application name e.g. `Homebrew` (https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#an) | ||
- The Homebrew application version e.g. `0.9.9` (https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#av) | ||
- The Homebrew analytics hit type e.g. `screenview` (https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#t) | ||
|
||
Homebrew's analytics records the following different events: | ||
|
||
- a `screenview` hit type with the Homebrew command you have run (with arguments stripped) e.g. `brew list` (not `brew list foo`) | ||
- an `event` hit type with the `install` event category, the Homebrew formula you have requested to install e.g. `ack` as the action and an event label e.g. `Mac OS X 10.11, non-/usr/local, CI=1` | ||
- an `event` hit type with the `BuildError` event category, the Homebrew formula that failed to install e.g. `wget` as the action and an event label e.g. `Mac OS X 10.11, non-/usr/local, CI=1` | ||
- an `exception` hit type with the `exception` event category, exception description of the exception name e.g. `FormulaUnavailableError` and whether the exception was fatal e.g. `1` | ||
|
||
You can also view all the information that is sent by Homebrew's analytics by setting `HOMEBREW_ANALYTICS_DEBUG=1` in your environment. Please note this will also stop any analytics being sent. | ||
|
||
It is impossible for the Homebrew developers to match any particular event to any particular user, even if we had access to the Homebrew analytics user ID (which we do not). | ||
|
||
It is impossible for Google to match a Homebrew analytics user ID to any other Google Analytics user ID. If Google turned evil the only thing they could do would be to lie about anonymising IP addresses and attempt to match users based on IP addresses. | ||
|
||
## When? | ||
Homebrew's analytics are sent throughout Homebrew's execution to Google Analytics. | ||
|
||
## How? | ||
The code is viewable in https://github.com/Homebrew/brew/blob/master/Library/Homebrew/utils/analytics.rb and https://github.com/Homebrew/brew/blob/master/Library/Homebrew/utils/analytics.sh. They are done in a forked, background process and fail fast to avoid delaying any execution. They will fail immediately and silently if you have no network connection. | ||
|
||
## Opting-out | ||
If after everything you've read you still wish to opt-out of Homebrew's analytics you may set `HOMEBREW_NO_ANALYTICS=1` in your environment and we will never send analytics from your machine again. |