archive/netdata_netdata
0
0
Fork 0
mirror of https://github.com/netdata/netdata.git synced 2025-04-21 04:10:38 +00:00
Code Issues Projects Releases Wiki Activity

Docs: Improve documentation of opting out of anonymous statistics ()

Browse source 
* Added anon stats to installer page

* Added notes to other pages

* Tweaks to main README and docs homepage

* Path fix

* Tweak and add to Docker page

* Fixing issues from Mansour & Timo

* Linter fixes
This commit is contained in:
Joel Hans 2020-01-08 10:44:44 +02:00 • committed by GitHub
parent 7bcb8c4148
commit 9bccf7afc9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 102 additions and 50 deletions

10
README.md
View file

@ -91,6 +91,12 @@ bash
bash <(curl -Ss https://my-netdata.io/kickstart.sh)
```
Starting with v1.12, Netdata collects anonymous usage information by default and sends it to Google Analytics. Read
about the information collected, and learn how to-opt, on our [anonymous statistics](docs/anonymous-statistics.md) page.
The usage statistics are _vital_ for us, as we use them to discover bugs and priortize new features. We thank you for
_actively_ contributing to Netdata's future.
To learn more about the pros and cons of using *nightly* vs. *stable* releases, see our [notice about the two options](packaging/installer/README.md#nightly-vs-stable-releases).
The above command will:
@ -98,7 +104,9 @@ The above command will:
- Install any required packages on your system (it will ask you to confirm before doing so)
- Compile it, install it, and start it.
More installation methods and additional options can be found at the [installation page](packaging/installer/#installation).
More installation methods and additional options can be found at the [installation page](packaging/installer/README.md).
---
To try Netdata in a docker container, run this:

95
docs/anonymous-statistics.md
View file

@ -1,49 +1,58 @@
# Anonymous Statistics
# Anonymous statistics
From Netdata v1.12 and above, anonymous usage information is collected by default and sent to Google Analytics.
The statistics calculated from this information will be used for:
Starting with v1.12, Netdata collects anonymous usage information by default and sends it to Google Analytics. We use
the statistics gathered from this information for two purposes:
1. **Quality assurance**, to help us understand if Netdata behaves as expected and help us identify repeating issues for certain distributions or environment.
1. **Quality assurance**, to help us understand if Netdata behaves as expected, and to help us classify repeated
issues with certain distributions or environments.
2. **Usage statistics**, to help us focus on the parts of Netdata that are used the most, or help us identify the extend our development decisions influence the community.
2. **Usage statistics**, to help us interpret how people use the Netdata agent in real-world environments, and to help
us identify how our development/design decisions influence the community.
Information is sent to Netdata via two different channels:
Netdata sends information to Google Analytics via two different channels:
- Google Tag Manager is used when an agent's dashboard is accessed.
- The script `anonymous-statistics.sh` is executed by the Netdata daemon, when Netdata starts, stops cleanly, or fails.
- Google Tag Manager fires when you access an agent's dashboard.
- The Netdata daemon executes the [`anonymous-statistics.sh`
script](https://github.com/netdata/netdata/blob/6469cf92724644f5facf343e4bdd76ac0551a418/daemon/anonymous-statistics.sh.in)
when Netdata starts, stops cleanly, or fails.
Both methods are controlled via the same [opt-out mechanism](#opt-out)
You can opt-out from sending anonymous statistics to Netdata through three different [opt-out mechanisms](#opt-out).
## Google tag manager
Google tag manager (GTM) is the recommended way of collecting statistics for new implementations using GA. Unlike the older API, the logic of when to send information to GA and what information to send is controlled centrally.
Google tag manager (GTM) is the recommended way of collecting statistics for new implementations using GA. Unlike the
older API, the logic of when to send information to GA and what information to send is controlled centrally.
We have configured GTM to trigger the tag only when the variable `anonymous_statistics` is true. The value of this variable is controlled via the [opt-out mechanism](#opt-out).
We have configured GTM to trigger the tag only when the variable `anonymous_statistics` is true. The value of this
variable is controlled via the [opt-out mechanism](#opt-out).
To ensure anonymity of the stored information, we have configured GTM's GA variable "Fields to set" as follows:
| Field Name|Value|
|----------|-----|
| page|netdata-dashboard|
| hostname|dashboard.my-netdata.io|
| anonymizeIp|true|
| title|Netdata dashboard|
| campaignSource|{{machine_guid}}|
| campaignMedium|web|
| referrer|<http://dashboard.my-netdata.io>|
| Page URL|<http://dashboard.my-netdata.io/netdata-dashboard>|
| Page Hostname|<http://dashboard.my-netdata.io>|
| Page Path|/netdata-dashboard|
| location|<http://dashboard.my-netdata.io>|
| Field name | Value |
| -------------- | -------------------------------------------------- |
| page | netdata-dashboard |
| hostname | dashboard.my-netdata.io |
| anonymizeIp | true |
| title | Netdata dashboard |
| campaignSource | {{machine_guid}} |
| campaignMedium | web |
| referrer | <http://dashboard.my-netdata.io> |
| Page URL | <http://dashboard.my-netdata.io/netdata-dashboard> |
| Page Hostname | <http://dashboard.my-netdata.io> |
| Page Path | /netdata-dashboard |
| location | <http://dashboard.my-netdata.io> |
In addition, the Netdata-generated unique machine guid is sent to GA via a custom dimension.
You can verify the effect of these settings by examining the GA `collect` request parameters.
The only thing that's impossible for us to prevent from being **sent** is the URL in the "Referrer" Header of the browser request to GA. However, the settings above ensure that all **stored** URLs and host names are anonymized.
The only thing that's impossible for us to prevent from being **sent** is the URL in the "Referrer" Header of the
browser request to GA. However, the settings above ensure that all **stored** URLs and host names are anonymized.
## Anonymous Statistics Script
Every time the daemon is started or stopped and every time a fatal condition is encountered, Netdata uses the anonymous statistics script to collect system information and send it to GA via an http call. The information collected for all events is:
Every time the daemon is started or stopped and every time a fatal condition is encountered, Netdata uses the anonymous
statistics script to collect system information and send it to GA via an http call. The information collected for all
events is:
- Netdata version
- OS name, version, id, id_like
@ -51,16 +60,34 @@ Every time the daemon is started or stopped and every time a fatal condition is
- Virtualization technology
- Containerization technology
Furthermore, the FATAL event sends the Netdata process & thread name, along with the source code function, source code filename and source code line number of the fatal error.
Furthermore, the FATAL event sends the Netdata process & thread name, along with the source code function, source code
filename and source code line number of the fatal error.
To see exactly what and how is collected, you can review the script template `daemon/anonymous-statistics.sh.in`. The template is converted to a bash script called `anonymous-statistics.sh`, installed under the Netdata `plugins directory`, which is usually `/usr/libexec/netdata/plugins.d`.
To see exactly what and how is collected, you can review the script template `daemon/anonymous-statistics.sh.in`. The
template is converted to a bash script called `anonymous-statistics.sh`, installed under the Netdata `plugins
directory`, which is usually `/usr/libexec/netdata/plugins.d`.
## Opt-Out
## Opt-out
To opt-out from sending anonymous statistics, you can create a file called `.opt-out-from-anonymous-statistics` under the user configuration directory (usually `/etc/netdata`). The effect of creating the file is the following:
You can opt-out from sending anonymous statistics to Netdata through three different opt-out mechanisms:
- The daemon will never execute the anonymous statistics script
- The anonymous statistics script will exit immediately if called via any other way (e.g. shell)
- The Google Tag Manager Javascript snippet will remain in the page, but the linked tag will not be fired. The effect is that no data will ever be sent to GA.
**Create a file called `.opt-out-from-anonymous-statistics`.** This empty file, stored in your Netdata configuration
directory (usually `/etc/netdata`), immediately stops the statistics script from running, and works with any type of
installation, including manual, offline, and macOS installations. Create the file by running `touch
.opt-out-from-anonymous-statistics` from your Netdata configuration directory.
You can also disable telemetry by passing the option `--disable-telemetry` to any of the installers.
**Pass the option `--disable-telemetry` to any of the installer scripts in the [installation
docs](../packaging/installer/README.md).** You can append this option during the initial installation or a manual
update.
When using Docker, **set your `DO_NOT_TRACK` environment variable to `1`.** You can set this variable with the following
command: `export DO_NOT_TRACK=1`. When creating a container using Netdata's [Docker
image](../packaging/docker/README.md#run-netdata-with-the-docker-command) for the first time, this variable will disable
the anonymous statistics script inside of the container.
Each of these opt-out processes does the following:
- Prevents the daemon from executing the anonymous statistics script.
- Forces the anonymous statistics script to exit immediately.
- Stops the Google Tag Manager Javascript snippet, which remains on the dashboard, from firing and sending any data to
Google Analytics.

12
docs/netdata-security.md
View file

@ -196,15 +196,13 @@ The default configuration uses a public registry under registry.my-netdata.io (m
If sending this information to the central Netdata registry violates your security policies, you can configure Netdat to [run your own registry](../registry/#run-your-own-registry).
### Opt out of anonymous statistics
### Opt-out of anonymous statistics
Starting with v1.12 Netdata also collects [anonymous statistics](anonymous-statistics.md) on certain events for:
Starting with v1.12, Netdata collects anonymous usage information by default and sends it to Google Analytics. Read
about the information collected, and learn how to-opt, on our [anonymous statistics](anonymous-statistics.md) page.
1. **Quality assurance**, to help us understand if Netdata behaves as expected and help us identify repeating issues for certain distributions or environments.
2. **Usage statistics**, to help us focus on the parts of Netdata that are used the most, or help us identify the extent our development decisions influence the community.
To opt-out from sending anonymous statistics, you can create a file called `.opt-out-from-anonymous-statistics` under the user configuration directory (usually `/etc/netdata`).
The usage statistics are _vital_ for us, as we use them to discover bugs and priortize new features. We thank you for
_actively_ contributing to Netdata's future.
## Netdata directories

7
packaging/docker/README.md
View file

@ -64,6 +64,13 @@ services:
If you don't want to use the apps.plugin functionality, you can remove the mounts of `/etc/passwd` and `/etc/group`
(they are used to get proper user and group names for the monitored host) to get slightly better security.
Starting with v1.12, Netdata collects anonymous usage information by default and sends it to Google Analytics. Read
about the information collected, and learn how to-opt, on our [anonymous statistics](../../docs/anonymous-statistics.md)
page.
The usage statistics are _vital_ for us, as we use them to discover bugs and priortize new features. We thank you for
_actively_ contributing to Netdata's future.
### Docker container names resolution
There are a few options for resolving container names within Netdata. Some methods of doing so will allow root access to

28
packaging/installer/README.md
View file

@ -4,8 +4,18 @@ Netdata is a **monitoring agent**. It is designed to be installed and run on all
The best way to install Netdata is directly from source. Our **automatic installer** will install any required system packages and compile Netdata directly on your systems.
!!! warning
You can find Netdata packages distributed by third parties. In many cases, these packages are either too old or broken. So, the suggested ways to install Netdata are the ones in this page.
Some third parties, such as the packaging teams at various Linux distributions, distribute old, broken, or altered
packages. We recommend you install Netdata using one of the above methods to guarantee you get the latest and
checksum-verified packages.
Starting with v1.12, Netdata collects anonymous usage information by default and sends it to Google Analytics. Read
about the information collected, and learn how to-opt, on our [anonymous statistics](../../docs/anonymous-statistics.md)
page.
The usage statistics are _vital_ for us, as we use them to discover bugs and priortize new features. We thank you for
_actively_ contributing to Netdata's future.
## Installation methods
1. [Automatic one line installation](#one-line-installation), easy installation from source, **this is the default**
2. [Install pre-built static binary on any 64bit Linux](#linux-64bit-pre-built-static-binary)
@ -17,12 +27,7 @@ The best way to install Netdata is directly from source. Our **automatic install
8. [Install on macOS (OS X)](#macos)
9. [Install on a Kubernetes cluster](https://github.com/netdata/helmchart#netdata-helm-chart-for-kubernetes-deployments)
10. [Install using binary packages](#binary-packages)
See also the list of Netdata [package maintainers](../maintainers) for ASUSTOR NAS, OpenWRT, ReadyNAS, etc.
Note: From Netdata v1.12 and above, anonymous usage information is collected by default and sent to Google Analytics. To read more about the information collected and how to opt-out, check the [anonymous statistics page](../../docs/anonymous-statistics.md).
---
11. See also the list of Netdata [package maintainers](../maintainers) for ASUSTOR NAS, OpenWRT, ReadyNAS, etc.
## One-line installation
@ -66,6 +71,8 @@ The `kickstart.sh` script passes all its parameters to `netdata-installer.sh`, s
- `--dont-start-it`: Prevent the installer from starting Netdata automatically.
- `--stable-channel`: Automatically update only on the release of new major versions.
- `--nightly-channel`: Automatically update on every new nightly build.
- `--disable telemetry`: Opt-out of [anonymous statistics](../../docs/anonymous-statistics.md) we use to make Netdata
better.
- `--no-updates`: Prevent automatic updates of any kind.
- `--local-files`: Used for offline installations. Pass four file paths: the Netdata tarball, the checksum file, the go.d plugin tarball, and the go.d plugin config tarball, to force kickstart run the process using those files.
@ -119,6 +126,8 @@ The `kickstart-static64.sh` script passes all its parameters to `netdata-install
- `--dont-wait`: Enable automated installs by not prompting for permission to install any required packages.
- `--dont-start-it`: Prevent the installer from starting Netdata automatically.
- `--stable-channel`: Automatically update only on the release of new major versions.
- `--disable telemetry`: Opt-out of [anonymous statistics](../../docs/anonymous-statistics.md) we use to make Netdata
better.
- `--no-updates`: Prevent automatic updates of any kind.
- `--local-files`: Used for offline installations. Pass two file paths, one for the tarball and one for the checksum file, to force kickstart run the process using those files.
@ -291,6 +300,9 @@ cd netdata
- You can also append `--stable-channel` to fetch and install only the official releases from GitHub, instead of the nightly builds.
- You can append `--disable telemetry` to opt-out of [anonymous statistics](../../docs/anonymous-statistics.md) we use
to make Netdata better.
- If you don't want to install it on the default directories, you can run the installer like this: `./netdata-installer.sh --install /opt`. This one will install Netdata in `/opt/netdata`.
- If your server does not have access to the internet and you have manually put the installation directory on your server, you will need to pass the option `--disable-go` to the installer. The option will prevent the installer from attempting to download and install `go.d.plugin`.