From 87e364a13da00cc91478db594adfd4d3d0423f69 Mon Sep 17 00:00:00 2001
From: Patrick Birch <48594400+patrickbirch@users.noreply.github.com>
Date: Wed, 1 Nov 2023 06:55:48 -0500
Subject: [PATCH] PXC-4234 Add telemetry topics (8.0) (#124)

new file:   docs/telemetry.md
	modified:   mkdocs-base.yml
---
 docs/apt.md           |  4 ++++
 docs/docker.md        |  4 ++++
 docs/install-index.md |  4 ++++
 docs/telemetry.md     | 53 +++++++++++++++++++++++++++++++++++++++++++
 docs/yum.md           |  4 ++++
 mkdocs-base.yml       |  3 ++-
 6 files changed, 71 insertions(+), 1 deletion(-)
 create mode 100644 docs/telemetry.md

diff --git a/docs/apt.md b/docs/apt.md
index da811cff..b21f72ad 100644
--- a/docs/apt.md
+++ b/docs/apt.md
@@ -8,6 +8,8 @@ and on the [download page](https://www.percona.com/downloads/Percona-XtraDB-Clus
 It is recommended to install Percona XtraDB Cluster from the official repository
 using APT.
 
+We gather [Telemetry data] in the Percona packages and Docker images.
+
 ## Prerequisites
 
 * You need to have root access on the node where you will be installing Percona XtraDB Cluster (either logged in as a user with root privileges or be able to run commands with sudo).
@@ -111,3 +113,5 @@ During the installation, you are requested to provide a password for the `root`
 
 After you install Percona XtraDB Cluster and stop the `mysql` service,
 configure the node according to the procedure described in [Configuring Nodes for Write-Set Replication](configure-nodes.md#configure).
+
+[Telemetry data]: telemetry.md
\ No newline at end of file
diff --git a/docs/docker.md b/docs/docker.md
index a3774172..c9e46e26 100644
--- a/docs/docker.md
+++ b/docs/docker.md
@@ -7,6 +7,8 @@ For more information about using Docker, see the [Docker Docs](https://docs.dock
 sure that you are using the latest version of Docker. The ones
 provided via `apt` and `yum` may be outdated and cause errors.
 
+We gather [Telemetry data] in the Percona packages and Docker images.
+
 !!! note
 
     By default, Docker pulls the image from Docker Hub if the image is not
@@ -152,3 +154,5 @@ To verify the cluster is available, do the following:
         +------------------------------+-------------------------------------------------+
         59 rows in set (0.02 sec)
         ```
+
+[Telemetry data]: telemetry.md
\ No newline at end of file
diff --git a/docs/install-index.md b/docs/install-index.md
index 11193272..87bb2819 100644
--- a/docs/install-index.md
+++ b/docs/install-index.md
@@ -3,6 +3,8 @@
 Install Percona XtraDB Cluster on all hosts that you are planning to use as cluster nodes
 and ensure that you have root access to the MySQL server on each one.
 
+We gather [Telemetry data] in the Percona packages and Docker images.
+
 It is recommended to install Percona XtraDB Cluster from official Percona software repositories
 using the corresponding package manager for your system:
 
@@ -39,3 +41,5 @@ The version number in PXC releases contains the following components:
 
 For example, version number *8.0.18-9.3* means that this is the third PXC
 build based on Percona Server for MySQL 8.0.18-9.
+
+[Telemetry data]: telemetry.md
diff --git a/docs/telemetry.md b/docs/telemetry.md
new file mode 100644
index 00000000..4b042f41
--- /dev/null
+++ b/docs/telemetry.md
@@ -0,0 +1,53 @@
+# Telemetry on Percona XtraDB Cluster
+
+Percona telemetry fills in the gaps in our understanding of how you use Percona XtraDB Cluster to improve our products. Participation in the anonymous program is optional. You can opt-out if you prefer to not share this information.
+
+## What information is collected
+
+At this time, telemetry is added only to the Percona packages and Docker images. Percona XtraDB Cluster collects only information about the installation environment. Future releases may add additional metrics.
+
+Be assured that access to this raw data is rigorously controlled. Percona does not collect personal data. All data is anonymous and cannot be traced to a specific user. To learn more about our privacy practices, read our [Percona Privacy statement].
+
+An example of the data collected is the following:
+
+```JSON
+[{"id" : "c416c3ee-48cd-471c-9733-37c2886f8231",
+"product_family" : "PRODUCT_FAMILY_PXC",
+"instanceId" : "6aef422e-56a7-4530-af9d-94cc02198343",
+"createTime" : "2023-10-16T10:46:23Z",
+"metrics":
+[{"key" : "deployment","value" : "PACKAGE"},
+{"key" : "pillar_version","value" : "8.0.34-26"},
+{"key" : "OS","value" : "Oracle Linux Server 8.8"},
+{"key" : "hardware_arch","value" : "x86_64 x86_64"}]}]
+```
+
+## Disable telemetry
+
+Starting with Percona XtraDB Cluster 8.0.34-26-1, telemetry is enabled by default. If you decide not to send usage data to Percona, you can set the `PERCONA_TELEMETRY_DISABLE=1` environment variable for either the root user or in the operating system prior to the installation process.
+
+=== "Debian-derived distribution"
+
+    Add the environment variable before the install process.
+
+    ```{.bash data-prompt="$"}
+    $ sudo PERCONA_TELEMETRY_DISABLE=1 apt install percona-xtradb-cluster
+    ```
+
+=== "Red Hat-derived distribution"
+
+    Add the environment variable before the install process.
+    
+    ```{.bash data-prompt="$"}
+    $ sudo PERCONA_TELEMETRY_DISABLE=1 yum install percona-xtradb-cluster
+    ```
+
+=== "DOCKER"
+
+    Add the environment variable when running a command in a new container.
+    
+    ```{.bash data-prompt="$"}
+    $ docker run -d -e MYSQL_ROOT_PASSWORD=test1234# -e PERCONA_TELEMETRY_DISABLE=1 -e CLUSTER_NAME=pxc-cluster1 --name=pxc-node1 percona/percona-xtradb-cluster:8.0
+    ```
+
+[Percona Privacy statement]: https://www.percona.com/privacy-policy#h.e34c40q8sb1a
\ No newline at end of file
diff --git a/docs/yum.md b/docs/yum.md
index 4e4858ff..5f5d5af4 100644
--- a/docs/yum.md
+++ b/docs/yum.md
@@ -3,6 +3,8 @@
 A list of the supported platforms by products and versions
 is available in [Percona Software and Platform Lifecycle](https://www.percona.com/services/policies/percona-software-platform-lifecycle#mysql).
 
+We gather [Telemetry data] in the Percona packages and Docker images.
+
 You can install Percona XtraDB Cluster with the following methods:
 
 * Use the official repository using YUM
@@ -77,3 +79,5 @@ $ sudo service mysql stop
 ## Next steps
 
 Configure the node according to the procedure described in [Configuring Nodes for Write-Set Replication](configure-nodes.md#configure).
+
+[Telemetry data]: telemetry.md
\ No newline at end of file
diff --git a/mkdocs-base.yml b/mkdocs-base.yml
index 477728b7..86822246 100644
--- a/mkdocs-base.yml
+++ b/mkdocs-base.yml
@@ -209,11 +209,12 @@ nav:
       - proxysql-v2.md
       - virtual-sandbox.md
 
-  - References:
+  - Reference:
       - wsrep-status-index.md
       - wsrep-system-index.md
       - wsrep-provider-index.md
       - wsrep-files-index.md
+      - telemetry.md
       - faq.md
       - glossary.md
       - copyright-and-licensing-information.md