PSMDB-1369 Added Telemetry (#791)

* PSMDB-1369 Added Telemetry modified: docs/404.md modified: docs/install/apt.md modified: docs/install/docker.md modified: docs/install/index.md modified: docs/install/yum.md new file: docs/telemetry.md modified: mkdocs-base.yml * Resolved merge conflicts
percona · Dec 13, 2023 · a9ae24a · a9ae24a
1 parent 61db4be
commit a9ae24a
Show file tree

Hide file tree

Showing 6 changed files with 65 additions and 4 deletions.
diff --git a/docs/install/apt.md b/docs/install/apt.md
@@ -1,6 +1,6 @@
 # Install Percona Server for MongoDB on Debian and Ubuntu
 
-This document describes how to install Percona Server for MongoDB from Percona repositories on DEB-based distributions such as Debian and Ubuntu.
+This document describes how to install Percona Server for MongoDB from Percona repositories on DEB-based distributions such as Debian and Ubuntu. We gather [Telemetry data](telemetry.md) to understand the use of the software and improve our products.
 
 !!! note
 

diff --git a/docs/install/docker.md b/docs/install/docker.md
@@ -10,6 +10,9 @@ For more information about using Docker, see the [Docker Docs](https://docs.dock
 
     By default, Docker will pull the image from Docker Hub if it is not available locally.
 
+    We gather [Telemetry data](telemetry.md) to understand the use of the software and improve our products.
+
+
 To run the latest Percona Server for MongoDB 7.0 in a Docker container, run the following command as the root user or via `sudo`:
 
 === "On x86_64 platforms"

diff --git a/docs/install/index.md b/docs/install/index.md
@@ -12,8 +12,8 @@ Starting in MongoDB 5.0, `mongod`, `mongos`, and the legacy `mongo` shell are su
 
 * Only Oracle Linux running the Red Hat Compatible Kernel (RHCK) is supported. MongoDB does not support the Unbreakable Enterprise Kernel (UEK).
 
-* MongoDB 5.0 and above requires the use of the AVX instruction set, available on 
-[select Intel and AMD processors](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions#CPUs_with_AVX). 
+
+* MongoDB 5.0 and above requires the use of the AVX instruction set, available on [select Intel and AMD processors](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions#CPUs_with_AVX). 
 
 ### ARM64
 
@@ -38,6 +38,8 @@ Choose how you wish to install Percona Server for MongoDB:
 
 * [Run in Docker](docker.md)
 
+We gather [Telemetry data](../telemetry.md) in Percona packages and Docker images.
+
 
 ## Upgrade instructions
 

diff --git a/docs/install/yum.md b/docs/install/yum.md
@@ -1,6 +1,6 @@
 # Install Percona Server for MongoDB on Red Hat Enterprise Linux and derivatives
 
-This document describes how to install Percona Server for MongoDB on RPM-based distributions such as Red Hat Enterprise Linux and compatible derivatives.
+This document describes how to install Percona Server for MongoDB on RPM-based distributions such as Red Hat Enterprise Linux and compatible derivatives. We gather [Telemetry data](telemetry.md) to understand the use of the software and improve our products.
 
 !!! note
 

diff --git a/docs/telemetry.md b/docs/telemetry.md
@@ -0,0 +1,55 @@
+# Telemetry on Percona Server for MongoDB
+
+Percona telemetry fills in the gaps in our understanding of how you use Percona Server for MongoDB to improve our products. Participation in this anonymous program is optional. You can opt-out if you prefer to not share this information.
+
+## What information is collected
+
+Currently, telemetry is added only to the Percona packages and Docker images. It collects only information about the installation environment. Future releases may add additional telemetry 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 the [Percona Privacy statement].
+
+The following is an example of the collected data:
+
+```json
+[{"id" : "c416c3ee-48cd-471c-9733-37c2886f8231",
+"product_family" : "PRODUCT_FAMILY_PSMDB",
+"instanceId" : "6aef422e-56a7-4530-af9d-94cc02198343",
+"createTime" : "2023-11-01T10:46:23Z",
+"metrics":
+[{"key" : "deployment","value" : "PACKAGE"},
+{"key" : "pillar_version","value" : "7.0.3-2"},
+{"key" : "OS","value" : "Oracle Linux Server 8.8"},
+{"key" : "hardware_arch","value" : "x86_64 x86_64"}]}]
+```
+
+## Disable telemetry
+
+Starting with Percona Server for MongoDB 7.0.4-2, 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-server-mongodb
+    ```
+
+=== "Red Hat-derived distribution"
+
+    Add the environment variable before the install process.
+
+    ```{.bash data-prompt="$"}
+    $ sudo PERCONA_TELEMETRY_DISABLE=1 yum install percona-server-mongodb
+    ```
+
+=== "Docker"
+
+    Add the environment variable when running a command in a new container.
+
+    ```{.bash data-prompt="$"}
+    $ docker run -d --name psmdb --restart always \
+      -e PERCONA_TELEMETRY_DISABLE=1 \
+      percona/percona-server-mongodb:<TAG>
+    ```
+
+[Percona Privacy statement]: https://www.percona.com/privacy-policy#h.e34c40q8sb1a
diff --git a/mkdocs-base.yml b/mkdocs-base.yml
@@ -190,5 +190,6 @@ nav:
       - release_notes/7.0.4-2.md
       - release_notes/7.0.2-1.md
   - glossary.md
+  - "Telemetry": telemetry.md
   - copyright.md
   - trademark-policy.md