Skip to content

Commit

Permalink
DISTPG-690 Telemetry (#460)
Browse files Browse the repository at this point in the history
new file:   docs/telemetry.md
	modified:   mkdocs-base.yml
  • Loading branch information
nastena1606 authored Nov 29, 2023
1 parent 20f8381 commit 3979920
Show file tree
Hide file tree
Showing 4 changed files with 64 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/apt.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ This document describes how to install Percona Server for PostgreSQL from Percon

## Preconditions

Debian and other systems that use the `apt` package manager include the upstream PostgreSQL server package `postgresql-16` by default. The components of Percona Distribution for PostgreSQL 16 can only be installed together with the PostgreSQL server shipped by Percona (`percona-postgresql-16`). If you wish to use Percona Distribution for PostgreSQL, uninstall the `postgresql-16` package provided by your distribution and then install the chosen components from Percona Distribution for PostgreSQL.
1. Debian and other systems that use the `apt` package manager include the upstream PostgreSQL server package `postgresql-16` by default. The components of Percona Distribution for PostgreSQL 16 can only be installed together with the PostgreSQL server shipped by Percona (`percona-postgresql-16`). If you wish to use Percona Distribution for PostgreSQL, uninstall the `postgresql-16` package provided by your distribution and then install the chosen components from Percona Distribution for PostgreSQL.
2. Install `curl` for [Telemetry](telemetry.md). We use it to better understand the use of our products and improve them.

## Procedure

Expand Down
53 changes: 53 additions & 0 deletions docs/telemetry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Telemetry on Percona Distribution for PostgreSQL

Percona telemetry fills in the gaps in our understanding of how you use Percona Distribution for PostgreSQL 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_PPG",
"instanceId" : "6aef422e-56a7-4530-af9d-94cc02198343",
"createTime" : "2023-10-16T10:46:23Z",
"metrics":
[{"key" : "deployment","value" : "PACKAGE"},
{"key" : "pillar_version","value" : "16.1"},
{"key" : "OS","value" : "Oracle Linux Server 8.8"},
{"key" : "hardware_arch","value" : "x86_64 x86_64"}]}]
```

## Disable telemetry

Starting with Percona Distribution for PostgreSQL 16.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-postgresql-{{pgversion}}
```

=== "Red Hat-derived distribution"

Add the environment variable before the install process.

```{.bash data-prompt="$"}
$ sudo PERCONA_TELEMETRY_DISABLE=1 yum install percona-postgresql{{pgversion}}-server
```

=== "DOCKER"

Add the environment variable when running a command in a new container.

```{.bash data-prompt="$"}
$ docker run --name container-name -e POSTGRES_PASSWORD=secret -e PERCONA_TELEMETRY_DISABLE=1 -d perconalab/percona-distribution-postgresql:tag
```

[Percona Privacy statement]: https://www.percona.com/privacy-policy#h.e34c40q8sb1a
8 changes: 8 additions & 0 deletions docs/yum.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,14 @@ For Red Hat Enterprise Linux 8 and derivatives, replace the operating system ver

Run all the commands in the following sections as root or using the `sudo` command:

### Install dependencies

Install `curl` for [Telemetry](telemetry.md). We use it to better understand the use of our products and improve them.

```{.bash data-prompt="$"}
$ sudo yum -y install curl
```

### Configure the repository

1. Install the `percona-release` repository management tool to subscribe to Percona repositories:
Expand Down
1 change: 1 addition & 0 deletions mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,7 @@ nav:
- LDAP authentication:
- ldap.md
- Uninstall: uninstalling.md
- Telemetry: telemetry.md
- Licensing: licensing.md
- Trademark policy:
- trademark-policy.md
Expand Down

0 comments on commit 3979920

Please sign in to comment.