From 21953d9c99cc4949e0a98783918797cd93031789 Mon Sep 17 00:00:00 2001 From: Borys Belinsky Date: Wed, 28 Feb 2018 21:02:28 +0200 Subject: [PATCH] Describe the process of creating instance UUID --- docs/installation.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/installation.rst b/docs/installation.rst index c03718d9..30cb8cc9 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -35,6 +35,20 @@ It is recommended to install Percona software from official repositories: sudo yum install percona-toolkit +.. rubric:: Generating an instance UUID for statistics + +During the installating process, the percona-toolkit installer records a unique +identifier specific to the given percona-toolkit instance. This ID is a the +product UUID stored in |product-uud|. The installer copies the product_uuid to +|toolkit-uuid|. + +This unique identifier is used when collecting statistics about the usage of +percona-toolkit. Note that no other information is gathered for this purpose. + +In cases when the installer is not able to read the contents of +|product-uuid|, a random UUID is generated. A random UUID is +also generated if percona-toolkit is run from the binary in the *tar.gz* file. + Alternative Install Methods =========================== @@ -54,3 +68,6 @@ For example, to download the ``pt-summary`` tool, run:: wget percona.com/get/pt-summary + +.. |toolkit-uuid| replace:: :file:`/etc/percona-toolkit/.percona.toolkit.uuid` +.. |product-uuid| replace:: :file:`/sys/class/dmi/id/product_uuid`