From 91b4aa51e117a191848c2c0c4324e8a4927b837c Mon Sep 17 00:00:00 2001 From: Beth Dean Date: Tue, 11 Jun 2019 18:33:14 -0700 Subject: [PATCH] Add statement to clarify enable/disable default status of client (#537) * Add statement to clarify enable/disable default status of client * Fix duplicate -is- and embolden opt-in * Update the telemetry concept page to reflect opt-in nature of telemetry * Add important callout regarding enable/disable telemetry * Reword important note to be stronger. --- source/clear-linux/concepts/telemetry-about.rst | 4 ++++ .../clear-linux/guides/telemetrics/telem-guide.rst | 14 +++++++++++--- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/source/clear-linux/concepts/telemetry-about.rst b/source/clear-linux/concepts/telemetry-about.rst index 1c371078..750277c8 100644 --- a/source/clear-linux/concepts/telemetry-about.rst +++ b/source/clear-linux/concepts/telemetry-about.rst @@ -24,6 +24,10 @@ for debugging purposes. You can use **libtelemetry** in your code to create cust telemetry records. You can also use **telem-record-gen** in script files or call it from another program. +.. note:: + + The |CL| telemetry client is disabled by default until you decide to enable it. Telemetry is an **opt-in** solution and can be easily enabled or disabled. + Architecture ************ diff --git a/source/clear-linux/guides/telemetrics/telem-guide.rst b/source/clear-linux/guides/telemetrics/telem-guide.rst index 2b538a5b..d9b7f089 100644 --- a/source/clear-linux/guides/telemetrics/telem-guide.rst +++ b/source/clear-linux/guides/telemetrics/telem-guide.rst @@ -5,6 +5,15 @@ Telemetrics Telemetrics in |CL-ATTR| is a client and server solution used to collect data from running |CL| systems to help quickly identify and fix bugs in the OS. Both client and server are customizable, and an API is available on the client side for instrumenting your code for debug and analysis. +.. important:: + + Telemetry in |CL| is **opt-in**. The telemetry client is **not** active and sends **no** data until you explicitly enable it. + +.. note:: + + The telemetry functionality adheres to `Intel privacy policies`_ regarding the collection and use of :abbr:`PII (Personally Identifiable Information)` and is open source. + Specifically, no intentionally identifiable information about the user or system owner is collected. + .. contents:: :local: :depth: 1 @@ -24,6 +33,8 @@ Telemetrics is a combination word made from: |CL| telemetry is fully customizable and can be used during software development for debugging purposes. You can use the libtelemetry library in your code to create custom telemetry records. You can also use the telem-record-gen utility in script files for light touch record creation where instrumenting code files doesn't make sense. +The |CL| telemetrics solution is an **opt-in** choice on the client side. By default, the telemetry client is disabled until you choose to enable it. Enabling the client is covered in this guide. + Architecture ============ @@ -57,10 +68,7 @@ The telemetry backend provides the server-side component of the telemetrics solu The default telemetry backend server is hosted by the Intel |CL| development team and is not viewable outside the Intel firewall. To collect your own records, you must set up your own telemetry backend server. -.. note:: - The telemetry functionality adheres to `Intel privacy policies`_ regarding the collection and use of :abbr:`PII (Personally Identifiable Information)` and is open source. - Specifically, no intentionally identifiable information about the user or system owner is collected. How To Use **********