-
Notifications
You must be signed in to change notification settings - Fork 105
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(CAT-1807) Remove all reference of analytics from the docs
- Loading branch information
1 parent
fe0f662
commit 811449b
Showing
2 changed files
with
5 additions
and
67 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -296,65 +296,3 @@ $env:http_proxy="http://user:[email protected]:port" | |
$env:https_proxy="http://user:[email protected]:port" | ||
``` | ||
|
||
## Analytics | ||
|
||
### PDK data collection | ||
|
||
PDK collects usage data to help us understand how it's being used and how we can | ||
improve it. You can opt out of data collection at any time; see the section | ||
below about opting out. | ||
|
||
We collect these values for every analytics event: | ||
|
||
- A random non-identifying user ID. This ID is shared with Puppet Bolt® analytics, if | ||
you've installed Bolt and enabled analytics. | ||
- PDK installation method (`package` or `gem`). | ||
- Version of PDK. | ||
- Operating system and version. | ||
|
||
For every successful command line invocation of PDK, we collect: | ||
|
||
- The PDK command executed, such as `pdk new module` or ``pdk validate``. | ||
- Anonymised command options and arguments. | ||
- The version of Ruby used to execute the command. | ||
- The output formats for the command. | ||
- `PDK_*` environment variables and their values, if set. | ||
- Whether a template repository, if used, is `default` or `custom` — we do not | ||
record the path to the template repo itself. | ||
- If the default template repo is used, we collect events for each file | ||
rendered, recording whether the file is `unmanaged`, `deleted`, | ||
`customized`, or `default`. For customized files, we do not record what | ||
changed, only that it was changed in the `.sync.yml` file. | ||
|
||
> **Note:** All arguments and non-Boolean option values, except `--puppet-version` are redacted in our collected data | ||
Invalid commands are submitted as a distinct analytics events with the arguments | ||
and option values redacted. | ||
|
||
To see the data PDK collects, add the `--debug` option to any `pdk` command. We | ||
test the analytics calls strictly to ensure that no unexpected data is | ||
accidentally passed in. | ||
|
||
### Opting out of PDK data collection | ||
|
||
The first time you run PDK, it asks you if you want to opt out of data | ||
collection. To opt out of data collection after that, edit the `analytics.yml` | ||
file, setting the `disabled` key to `true`. | ||
|
||
``` | ||
disabled: true | ||
``` | ||
|
||
The location of this configuration file depends on your operating system and | ||
configuration: | ||
|
||
- For most \*nix systems, where the `$XDG_CONFIG_HOME` variable is set: | ||
`${XDG_CONFIG_HOME}/puppet/analytics.yml`. | ||
- For most macOS systems, where the `$XDG_CONFIG_HOME` variable is not set: | ||
`~/.config/puppet/analytics.yml`. | ||
- For Windows: `%LOCALAPPDATA%/puppet/analytics.yml`. | ||
|
||
You can also opt out of analytics by setting the environment variable | ||
`PDK_DISABLE_ANALYTICS=true`. This is useful if you are using PDK in your CI | ||
system. |
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