From 86f27baea35275678725eac6110bd0f04ed609c5 Mon Sep 17 00:00:00 2001 From: Mike McQuaid Date: Sat, 18 Aug 2018 08:49:07 +0100 Subject: [PATCH] docs/Analytics: note `install_on_request` and `cask_install`. --- docs/Analytics.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/Analytics.md b/docs/Analytics.md index 12ded5bc31..b989d30b85 100644 --- a/docs/Analytics.md +++ b/docs/Analytics.md @@ -25,7 +25,9 @@ Homebrew's analytics record some shared information for every event: Homebrew's analytics records the following different events: -- an `event` hit type with the `install` event category and the Homebrew formula from a non-private GitHub tap you have requested to install plus any used options, e.g. `wget --with-pcre` as the action and an event label e.g. `macOS 10.12, non-/usr/local, CI` to indicate the OS version, non-standard installation location and invocation as part of CI. This allows us to identify the formulae that need fixing and where more easily. +- an `event` hit type with the `install` event category and the Homebrew formula from a non-private GitHub tap you install plus any used options, e.g. `wget --with-pcre` as the action and an event label e.g. `macOS 10.12, non-/usr/local, CI` to indicate the OS version, non-standard installation location and invocation as part of CI. This allows us to identify the formulae that need fixing and where more easily. +- an `event` hit type with the `install_on_request` event category and the Homebrew formula from a non-private GitHub tap you have requested to install (e.g. explicitly named it with a `brew install`) plus options and an event label as above. This allows us to differentiate the formulae that users intend to install from those pulled in as dependencies. +- an `event` hit type with the `cask_install` event category and the Homebrew cask from a non-private GitHub tap you install as the action and an event label as above. This allows us to identify the casks that need fixing and where more easily. - an `event` hit type with the `BuildError` event category and the Homebrew formula that failed to install, e.g. `wget` as the action and an event label e.g. `macOS 10.12` 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 from being sent.