Anonymous statistics (#5113)

* Added shell and dashboard anonymous statistics

* Check for environment var NETDATA_REGISTRY_UNIQUE_ID

* Fix indentation

* Removed health-cmdapi-test

* docs/anonymous-statistics.md

1 files changed, 194 insertions, 0 deletions

diff --git a/daemon/anonymous-statistics.sh.in b/daemon/anonymous-statistics.sh.in
new file mode 100755
index 0000000000..81f2b00627
--- /dev/null
+++ b/daemon/anonymous-statistics.sh.in
@@ -0,0 +1,194 @@
+#!/usr/bin/env sh
+
+# Valid actions:
+
+# - FATAL       - netdata exited due to a fatal condition
+#      ACTION_RESULT  -- program name and thread tag
+#      ACTION_DATA    -- fmt, args passed to fatal
+# - START       - netdata started
+#      ACTION_DATA     -- nan
+# - EXIT     - installation action
+#      ACTION_DATA    -- ret value of
+
+ACTION="${1}"
+ACTION_RESULT="${2}"
+ACTION_DATA="${3}"
+ACTION_DATA=$(echo "${ACTION_DATA}" | tr '"' "'")
+
+# -------------------------------------------------------------------------------------------------
+# check opt-out
+
+if [ -f "@configdir_POST@/.opt-out-from-anonymous-statistics" ]; then
+	exit 0
+fi
+
+# -------------------------------------------------------------------------------------------------
+# detect the operating system
+
+OS_DETECTION="unknown"
+NAME="unknown"
+VERSION="unknown"
+VERSION_ID="unknown"
+ID="unknown"
+ID_LIKE="unknown"
+
+if [ -f "/etc/os-release" ]; then
+	OS_DETECTION="/etc/os-release"
+	eval "$(grep -E "^(NAME|ID|ID_LIKE|VERSION|VERSION_ID)=" </etc/os-release)"
+fi
+
+if [ "${NAME}" = "unknown" ] || [ "${VERSION}" = "unknown" ] || [ "${ID}" = "unknown" ]; then
+	if [ -f "/etc/lsb-release" ]; then
+		if [ "${OS_DETECTION}" = "unknown" ]; then OS_DETECTION="/etc/lsb-release"; else OS_DETECTION="Mixed"; fi
+		DISTRIB_ID="unknown"
+		DISTRIB_RELEASE="unknown"
+		DISTRIB_CODENAME="unknown"
+		eval "$(grep -E "^(DISTRIB_ID|DISTRIB_RELEASE|DISTRIB_CODENAME)=" </etc/lsb-release)"
+		if [ "${NAME}" = "unknown" ]; then NAME="${DISTRIB_ID}"; fi
+		if [ "${VERSION}" = "unknown" ]; then VERSION="${DISTRIB_RELEASE}"; fi
+		if [ "${ID}" = "unknown" ]; then ID="${DISTRIB_CODENAME}"; fi
+	elif [ -n "$(command -v lsb_release 2>/dev/null)" ]; then
+		if [ "${OS_DETECTION}" = "unknown" ]; then OS_DETECTION="lsb_release"; else OS_DETECTION="Mixed"; fi
+		if [ "${NAME}" = "unknown" ]; then NAME="$(lsb_release -is 2>/dev/null)"; fi
+		if [ "${VERSION}" = "unknown" ]; then VERSION="$(lsb_release -rs 2>/dev/null)"; fi
+		if [ "${ID}" = "unknown" ]; then ID="$(lsb_release -cs 2>/dev/null)"; fi
+	fi
+fi
+
+# -------------------------------------------------------------------------------------------------
+# detect the kernel
+
+KERNEL_NAME="$(uname -s)"
+KERNEL_VERSION="$(uname -r)"
+ARCHITECTURE="$(uname -m)"
+
+# -------------------------------------------------------------------------------------------------
+# detect the virtualization
+
+VIRTUALIZATION="unknown"
+VIRT_DETECTION="none"
+
+if [ -n "$(command -v systemd-detect-virt 2>/dev/null)" ]; then
+	VIRTUALIZATION="$(systemd-detect-virt)"
+	VIRT_DETECTION="systemd-detect-virt"
+else
+	if grep -q "^flags.*hypervisor" /proc/cpuinfo 2>/dev/null; then
+		VIRTUALIZATION="hypervisor"
+		VIRT_DETECTION="/proc/cpuinfo"
+	fi
+fi
+
+# -------------------------------------------------------------------------------------------------
+# detect containers
+
+CONTAINER="none"
+CONT_DETECTION="none"
+
+IFS='(, ' read -r process _ </proc/1/sched
+if [ "${process}" = "netdata" ]; then
+	CONTAINER="container"
+	CONT_DETECTION="process"
+fi
+
+# ubuntu and debian supply /bin/running-in-container
+# https://www.apt-browse.org/browse/ubuntu/trusty/main/i386/upstart/1.12.1-0ubuntu4/file/bin/running-in-container
+if /bin/running-in-container >/dev/null 2>&1; then
+	CONTAINER="container"
+	CONT_DETECTION="/bin/running-in-container"
+fi
+
+# lxc sets environment variable 'container'
+#shellcheck disable=SC2154
+if [ -n "${container}" ]; then
+	CONTAINER="lxc"
+	CONT_DETECTION="containerenv"
+fi
+
+# docker creates /.dockerenv
+# http://stackoverflow.com/a/25518345
+if [ -f "/.dockerenv" ]; then
+	CONTAINER="docker"
+	CONT_DETECTION="dockerenv"
+fi
+
+# -------------------------------------------------------------------------------------------------
+# check netdata version
+
+if [ -z "${NETDATA_VERSION}" ]; then
+	NETDATA_VERSION="uknown"
+	netdata -V >/dev/null 2>&1 && NETDATA_VERSION="$(netdata -V 2>&1 | cut -d ' ' -f 2)"
+fi
+
+# -------------------------------------------------------------------------------------------------
+# check netdata unique id
+if [ -z "${NETDATA_REGISTRY_UNIQUE_ID}" ] ; then
+	if [ -f "@registrydir_POST@/netdata.public.unique.id" ]; then
+		NETDATA_REGISTRY_UNIQUE_ID="$(cat "@registrydir_POST@/netdata.public.unique.id")"
+	else
+		NETDATA_REGISTRY_UNIQUE_ID="unknown"
+	fi
+fi
+
+
+# -------------------------------------------------------------------------------------------------
+# send the anonymous statistics to GA
+# https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters
+if [ -n "$(command -v curl 2>/dev/null)" ]; then
+	curl -X POST -Ss --max-time 2 \
+		--data "v=1" \
+		--data "tid=UA-64295674-3" \
+		--data "aip=1" \
+		--data "ds=shell" \
+		--data-urlencode "cid=${NETDATA_REGISTRY_UNIQUE_ID}" \
+		--data-urlencode "cs=${NETDATA_REGISTRY_UNIQUE_ID}" \
+		--data "t=event" \
+		--data "ni=1" \
+		--data "an=anonymous-statistics" \
+		--data-urlencode "av=${NETDATA_VERSION}" \
+		--data-urlencode "ec=${ACTION}" \
+		--data-urlencode "ea=${ACTION_RESULT}" \
+		--data-urlencode "el=${ACTION_DATA}" \
+		--data-urlencode "cd1=${NAME}" \
+		--data-urlencode "cd2=${ID}" \
+		--data-urlencode "cd3=${ID_LIKE}" \
+		--data-urlencode "cd4=${VERSION}" \
+		--data-urlencode "cd5=${VERSION_ID}" \
+		--data-urlencode "cd6=${OS_DETECTION}" \
+		--data-urlencode "cd7=${KERNEL_NAME}" \
+		--data-urlencode "cd8=${KERNEL_VERSION}" \
+		--data-urlencode "cd9=${ARCHITECTURE}" \
+		--data-urlencode "cd10=${VIRTUALIZATION}" \
+		--data-urlencode "cd11=${VIRT_DETECTION}" \
+		--data-urlencode "cd12=${CONTAINER}" \
+		--data-urlencode "cd13=${CONT_DETECTION}" \
+		"https://www.google-analytics.com/collect" >/dev/null 2>&1
+else
+	wget -q -O - --timeout=1 "https://www.google-analytics.com/collect?\
+&v=1\
+&tid=UA-64295674-3\
+&aip=1\
+&ds=shell\
+&cid=${NETDATA_REGISTRY_UNIQUE_ID}\
+&cs=${NETDATA_REGISTRY_UNIQUE_ID}\
+&t=event\
+&ni=1\
+&an=anonymous-statistics\
+&av=${NETDATA_VERSION}\
+&ec=${ACTION}\
+&ea=${ACTION_RESULT}\
+&el=${ACTION_DATA}\
+&cd1=${NAME}\
+&cd2=${ID}\
+&cd3=${ID_LIKE}\
+&cd4=${VERSION}\
+&cd5=${VERSION_ID}\
+&cd6=${OS_DETECTION}\
+&cd7=${KERNEL_NAME}\
+&cd8=${KERNEL_VERSION}\
+&cd9=${ARCHITECTURE}\
+&cd10=${VIRTUALIZATION}\
+&cd11=${VIRT_DETECTION}\
+&cd12=${CONTAINER}\
+&cd13=${CONT_DETECTION}\
+" > /dev/null 2>&1
+fi