From bc3b6fdd112b9ccc60fc03507ac24b0d47972ffe Mon Sep 17 00:00:00 2001 From: Anastasia Alexandrova Date: Mon, 18 Dec 2023 15:14:45 +0100 Subject: [PATCH] PSMDB-1369 Telemetry documentation (6.0) (#803) --- .gitignore | 1 + docs/install/apt.md | 2 +- docs/install/docker.md | 2 ++ docs/install/index.md | 2 ++ docs/install/yum.md | 2 ++ docs/telemetry.md | 55 ++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 63 insertions(+), 1 deletion(-) create mode 100644 docs/telemetry.md diff --git a/.gitignore b/.gitignore index e6883f8a8..e9cd987eb 100644 --- a/.gitignore +++ b/.gitignore @@ -6,4 +6,5 @@ __pycache__ # Local Netlify folder .netlify + site/ diff --git a/docs/install/apt.md b/docs/install/apt.md index 2467b69fb..023cbdb9b 100644 --- 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 index 8f441473d..65b055527 100644 --- a/docs/install/docker.md +++ b/docs/install/docker.md @@ -11,6 +11,8 @@ 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 4.4 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 index e7d84610d..6ee029323 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -38,6 +38,8 @@ Choose how you wish to install Percona Server for MongoDB: * [Run in a Docker](docker.md). +We gather [Telemetry data](../telemetry.md) in Percona packages and Docker images. + ## Upgrade instructions If you are currently using MongoDB, see [Upgrading from MongoDB](upgrade-from-mongodb.md#upgrade-from-mongodb). diff --git a/docs/install/yum.md b/docs/install/yum.md index d36dee80e..5efce2f59 100644 --- a/docs/install/yum.md +++ b/docs/install/yum.md @@ -2,6 +2,8 @@ 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 Percona Server for MongoDB should work on other RPM-based distributions (for example, Amazon Linux AMI and Oracle Linux), but it is tested only on platforms listed on the [Percona Software and Platform Lifecycle](https://www.percona.com/services/policies/percona-software-platform-lifecycle#mongodb) page [^1]. diff --git a/docs/telemetry.md b/docs/telemetry.md new file mode 100644 index 000000000..47ba82668 --- /dev/null +++ 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" : "4.4.26-25"}, +{"key" : "OS","value" : "Oracle Linux Server 8.8"}, +{"key" : "hardware_arch","value" : "x86_64 x86_64"}]}] +``` + +## Disable telemetry + +Starting with Percona Server for MongoDB 4.4.26-25, 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: + ``` + +[Percona Privacy statement]: https://www.percona.com/privacy-policy#h.e34c40q8sb1a \ No newline at end of file