PSMDB-1491 Updated telemetry doc with chages in Phase 1 (#887)

PSMDB-1491 Updated telemetry doc with chages in Phase 1 modified: docs/telemetry.md --------- Co-authored-by: radoslawszulgo <radoslaw.szulgo@percona.com>
percona · Jul 23, 2024 · acccb86 · acccb86
1 parent 4149c53
commit acccb86
Showing 1 changed file with 301 additions and 19 deletions.
diff --git a/docs/telemetry.md b/docs/telemetry.md
@@ -1,42 +1,240 @@
-# Telemetry on Percona Server for MongoDB
+# Telemetry and data collection
 
-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.
+Percona collects usage data to improve its software. The telemetry feature helps us identify popular features, detect problems, and plan future improvements. 
+
+Currently, telemetry is added only to the Percona packages for both basic and Pro builds and to Docker images. 
 
 ## 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.
+Telemetry collects the following information:
+
+* The information about the installation environment when you install the software.
+* The information about the operating system such as OS name, the architecture, the list of Percona packages. See more in the [Telemetry Agent section](#telemetry-agent).
+* The metrics from the database instance. See more in the [Telemetry Subsystem section](#telemetry-subsystem).
+
+## What is NOT collected
+
+Percona protects your privacy and doesn't collect any personal information about you like database names, user names or credentials or any user-entered values. 
+
+All collected data is anonymous, meaning it can't be traced back to any individual user. To learn more about how Percona handles your data, read the [Percona Privacy statement](https://www.percona.com/privacy-policy).
+
+You control whether to share this information. Participation in this program is completely voluntary. If don't want to share anonymous data, you can [disable telemetry](#disable-telemetry).
+
+## Why telemetry matters
+
+Benefits for Percona:
+
+| Advantages | Description |
+|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| See how people use your software | Telemetry collects anonymous data on how users interact with our software. This tells developers which features are popular, which ones are confusing, and if anything is causing crashes. |
+| Identify issues early | Telemetry can catch bugs or performance problems before they become widespread. |
+
+Benefits for users in the long run:
+
+| Advantages | Description |
+|---------------------------|---------------------------------------------------------------------------------------------------------------------|
+| Faster bug fixes | With telemetry data, developers can pinpoint issues affecting specific users and prioritize fixing them quickly. |
+| Improved features | Telemetry helps developers understand user needs and preferences. This allows them to focus on features that will be genuinely useful and improve your overall experience. |
+| Improved user experience | By identifying and resolving issues early, telemetry helps create a more stable and reliable software experience for everyone. |
+
+## Telemetry components
+
+Percona collects information using the following components:
+
+* Telemetry script that sends the information about the software and the environment where it is installed. This information is collected only once during the installation.
+
+* The Telemetry Subsystem collects the necessary metrics directly from the database and stores them in a Metrics File.
+
+* The Metrics File stores the metrics and is a standalone file located on the database host's file system.
+
+* The Telemetry Agent is an independent process running on your database host's operating system and carries out the following tasks:
+
+ * Collects OS-level metrics
+
+ * Reads the Metrics File, adds the OS-level metrics
+
+ * Sends the full set of metrics to the Percona Platform
+
+ * Collects the list of installed Percona packages using the local package manager
+
+The telemetry also uses the Percona Platform with the following components:
+
+* Telemetry Service - offers an API endpoint for sending telemetry. The service handles incoming requests. This service saves the data into Telemetry Storage.
+
+* Telemetry Storage - stores all telemetry data for the long term.
+
+### Telemetry Subsystem
+
+The Telemetry Subsystem extends the functionality of the database. It is built-in in Percona Server for MongoDB and is implemented separately for `mongod` and `mongos` instances. The Telemetry Subsystem is enabled by default during the initial database deployment.
+
+The Telemetry Subsystem collects metrics from the database instance daily to the Metrics File. It creates a new Metrics File for each collection. Before generating a new file, the Telemetry Subsystem deletes the Metrics Files that are older than seven days. This process ensures that only the most recent week's data is maintained.
+
+The Telemetry Subsystem creates a file in the local file system using a timestamp as the name with a `.json` extension.
 
-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].
+### Metrics File
 
-The following is an example of the collected data:
+The Metrics File is a JSON file with the metrics collected by the Telemetry Subsystem. 
+
+#### Locations 
+
+Percona stores the Metrics File in one of the following directories on the local file system. The location depends on the product.
+
+* Telemetry root path - `/usr/local/percona/telemetry`
+
+* Percona Server for MongoDB has two root paths since the telemetry Subsystem is enabled both for the `mongod` and `mongos` instances. The paths are the following: 
+
+ * `mongod` root path - `${telemetry root path}/psmdb/`
+ * `mongos` root path - `${telemetry root path}/psmdbs/`
+
+* PS root path - `${telemetry root path}/ps/`
+
+* PXC root path - `${telemetry root path}/pxc/`
+
+* PG root path - `${telemetry root path}/pg/`
+
+Percona archives the telemetry history in `${telemetry root path}/history/`.
+
+#### Metrics File format
+
+The Metrics File uses the Javascript Object Notation (JSON) format. Percona reserves the right to extend the current set of JSON structure attributes in the future.
+
+=== "`mongod` Metrics File"
+
+ The following is an example of the collected data generated by the `mongod` instance of the config server replica set of the sharded cluster: 
+
+ ```json
+ {
+  "source": "mongod",
+  "pillar_version": "7.0.0",
+  "pro_features": [],
+  "db_instance_id": "65e9977d58deb2f66faa591c",
+  "db_internal_id": "65e9977d58deb2f66faa591c",
+  "db_cluster_id": "65e997cb58deb2f66faa5954",
+  "shard_svr": "true",
+  "config_svr": "true",
+  "uptime": "102",
+  "storage_engine": "wiredTiger",
+  "db_replication_id": "65e997cb58deb2f66faa5944",
+  "replication_state": "PRIMARY"
+ }
+ ```
+
+=== "`mongos` Metrics File"
+
+ The following is an example of the collected data generated by the `mongos` instance. 
+
+ ```json
+ {
+  "source": "mongos",
+  "pillar_version": "7.0.0",
+  "pro_features": [],
+  "db_instance_id": "6690fea9066216c6d9d77044",
+  "uptime": "4",
+  "db_cluster_id": "6690fea65d86eb061c0bd728"
+ }
+ ```
+
+### Telemetry Agent
+
+The Percona Telemetry Agent runs as a dedicated OS daemon process `percona-telemetry-agent`. It creates, reads, writes, and deletes JSON files in the [`${telemetry root path}`](#locations). You can find the agent's log file at `/var/log/percona/telemetry-agent.log`.
+
+The agent does not send anything if there are no Percona-specific files in the target directory.
+
+The following is an example of a Telemetry Agent payload:
 
 ```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"}]}]
+{
+ "reports": [
+ {
+ "id": "B5BDC47B-B717-4EF5-AEDF-41A17C9C18BB",
+ "createTime": "2023-09-01T10:56:49Z",
+ "instanceId": "B5BDC47B-B717-4EF5-AEDF-41A17C9C18BA",
+ "productFamily": "PRODUCT_FAMILY",
+ "metrics": [
+ {
+ "key": "OS",
+ "value": "Ubuntu"
+ },
+ {
+ "key": "pillar_version",
+ "value": "7.0.0"
+ }
+ ]
+ }
+ ]
+}
 ```
 
-## Disable telemetry
+The agent sends information about the database and metrics.
+
+| Key | Description |
+|---|---|
+| "id" | A generated Universally Unique Identifier (UUID) version 4 |
+| "createTime" | UNIX timestamp |
+| "instanceId" | The DB Host ID. The value can be taken from the `instanceId`, the `/usr/local/percona/telemetry_uuid` or generated as a UUID version 4 if the file is absent. |
+| "productFamily" | The value from the file path |
+| "metrics" | An array of key:value pairs collected from the Metrics File.
+
+The following operating system-level metrics are sent with each check:
+
+| Key | Description |
+|---|---|
+| "OS" | The name of the operating system |
+| "hardware_arch" | The type of process used in the environment |
+| "deployment" | How the application was deployed. <br> The possible values could be "PACKAGE" or "DOCKER". |
+| "installed_packages" | A list of the installed Percona packages.|
+
+The information includes the following:
+
+* Package name
 
-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.
+* Package version - the same format as Red Hat Enterprise Linux or Debian
+
+* Package repository - if possible
+
+The package names must fit the following pattern:
+
+* `percona-*`
+
+* `Percona-*`
+
+* `proxysql*`
+
+* `pmm`
+
+* `etcd*`
+
+* `haproxy`
+
+* `patroni`
+
+* `pg*`
+
+* `postgis`
+
+* `wal2json`
+
+## Disable telemetry 
+
+Telemetry is enabled by default when you install the software. It is also included in the software packages (Telemetry Subsystem and Telemetry Agent) and enabled by default.
+
+If you don't want to send the telemetry data, here's how: 
+
+### Disable the telemetry collected during the installation
+
+If you decide not to send usage data to Percona when you install the software, 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.
+ Add the environment variable before the installation 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.
+ Add the environment variable before the installation process.
 
  ```{.bash data-prompt="$"}
  $ sudo PERCONA_TELEMETRY_DISABLE=1 yum install percona-server-mongodb
@@ -52,4 +250,88 @@ Starting with Percona Server for MongoDB 7.0.4-2, telemetry is enabled by defaul
   percona/percona-server-mongodb:<TAG>
  ```
 
-[Percona Privacy statement]: https://www.percona.com/privacy-policy#h.e34c40q8sb1a
+ The command does the following:
+
+ * `docker run` - This is the command to run a Docker container.
+ * `-d` - This flag specifies that the container should run in detached mode (in the background).
+ * `--name psmdb` - Assigns the name “psmdb” to the container.
+ * `--restart always` - Configures the container to restart automatically if it stops or crashes.
+ * `-e PERCONA_TELEMETRY_DISABLE=1` - Sets an environment variable within the container. In this case, it disables telemetry for Percona Server for MongoDB.
+ * `percona/percona-server-mongodb:<TAG>-multi` - Specifies the image to use for the container. For example, `{{release}}-multi`. The `multi` part of the tag serves to identify the architecture (x86_64 or ARM64) and use the respective image.
+
+## Disable telemetry for the installed software
+
+Percona software you installed includes the telemetry feature that collects information about how you use this software. It is enabled by default. To turn off telemetry, you need to disable both the Telemetry Agent and the Telemetry Subsystem.
+
+### Disable Telemetry Agent
+
+In the first 24 hours, no information is collected or sent.
+
+You can either disable the Telemetry Agent temporarily or permanently.
+
+=== "Disable temporarily"
+
+ Turn off Telemetry Agent temporarily until the next server restart with this command:
+
+ ```{.bash data-prompt=$}
+ $ systemctl stop percona-telemetry-agent
+ ```
+
+=== "Disable permanently"
+
+ Turn off Telemetry Agent permanently with this command:
+
+ ```{.bash data-prompt=$}
+ $ systemctl disable percona-telemetry-agent
+ ```
+
+Even after stopping the Telemetry Agent service, a different part of the software (Telemetry Subsystem) continues to create the Metrics File related to telemetry every day and saves that file for seven days.
+
+### Telemetry Agent dependencies and removal considerations
+
+If you decide to remove the Telemetry Agent, this also removes the database. That's because the Telemetry Agent is a mandatory dependency for Percona Server for MongoDB. 
+
+On YUM-based systems, the system removes the Telemetry Agent package when you remove the last dependency package.
+
+On APT-based systems, you must use the '--autoremove' option to remove all dependencies, as the system doesn't automatically remove the Telemetry Agent when you remove the database package.
+
+The '--autoremove' option only removes unnecessary dependencies. It doesn't remove dependencies required by other packages or guarantee the removal of all package-associated dependencies.
+
+### Disable the Telemetry Subsystem
+
+To disable the Telemetry Subsystem, set the `perconaTelemetry` server parameter to `false`. You can do this in one of the following ways:
+
+=== ":octicons-file-code-24: Configuration file"
+
+ Use the `setParameter.perconaTelemetry` parameter in the configuration file
+ for persistent changes: 
+
+ ```yaml
+ setParameter:
+  perconaTelemetry: false
+ ```
+
+=== ":material-console: Command line"
+
+ Use the `--setParameter` command line option arguments for both `mongod` and `mongos` processes. The server starts with the telemetry Subsystem disabled: 
+
+ ```{.bash data-prompt="$"}
+ $ mongod \
+  --setParameter perconaTelemetry=false
+ $ mongos \
+  --setParameter perconaTelemetry=false
+ ```
+
+=== ":simple-mongodb: `setParameter` command" 
+
+ Use the `setParameter` command on the `admin` database
+ to make changes at runtime. The changes apply until the server restart.
+
+ ```{.javascript data-prompt=">"}
+ > db.adminCommand({setParameter: 1, "perconaTelemetry": false})
+ ```
+
+!!! tip
+
+ If you wish to re-enable the Telemetry Subsystem, set the `perconaTelemetry` to `true` for the `setParameter` command.
+