From 51cf60b2d25627e89cb37cb4dc6d2450478531a7 Mon Sep 17 00:00:00 2001 From: MCamp859 Date: Thu, 26 Jul 2018 16:32:37 -0400 Subject: [PATCH] Incorporated review feedback. Signed-off-by: MCamp859 --- .../clear-linux/concepts/telemetry-about.rst | 38 +++++++++++-------- .../guides/maintenance/telemetry-enable.rst | 18 ++++----- .../telemetry-backend/telemetry-backend.rst | 8 ++-- 3 files changed, 35 insertions(+), 29 deletions(-) diff --git a/source/clear-linux/concepts/telemetry-about.rst b/source/clear-linux/concepts/telemetry-about.rst index 261cf216..e9249aa6 100644 --- a/source/clear-linux/concepts/telemetry-about.rst +++ b/source/clear-linux/concepts/telemetry-about.rst @@ -3,15 +3,14 @@ Telemetrics ########### -Telemetry is one of the key features of |CLOSIA|. The |CL| team is focused on -the quality of the telemetry data, and is moving from issues that are detected -and reported by users to issues detected and repaired by providers. Ideally, -these issues will be undetected by users. +One of the key features of |CLOSIA| is telemetry, which is used to +monitor system health. Telemetry enables developers to observe and proactively +address issues before end users are impacted. -On the |CL| team, we refer to *telemetrics*, which is a combination word made from: +*Telemetrics* is a combination word made from: -* Telemetry which is sensing and reporting data. -* Analytics which is using visualization and statistical inferencing to make +* *Telemetry* which is sensing and reporting data. +* *Analytics* which is using visualization and statistical inferencing to make sense of the reported data. |CL| telemetry reports system-level debug/crash information using specialized probes. The @@ -21,8 +20,8 @@ failures. Telemetry enables real-time issue reporting to allow system developers to quickly focus on an issue and monitor corrective actions. |CL| telemetry is fully customizable and can be used during software development -for debugging purposes. You can use libtelemetry in your code to create custom -telemetry records. You can also use telem-record-gen in script files or call +for debugging purposes. You can use **libtelemetry** in your code to create custom +telemetry records. You can also use **telem-record-gen** in script files or call it from another program. Architecture @@ -34,7 +33,10 @@ Architecture * Backend: captures records sent from the client and displays the cumulative content through a specialized interface. -Note: To capture records for analysis, you must set up your own backend server. + .. note:: + + If you want to capture your own records for analysis, you must set up + your own backend server. .. figure:: figures/telemetry-about-1.png :scale: 75% @@ -45,10 +47,10 @@ Note: To capture records for analysis, you must set up your own backend server. The telemetry client provides the front end of a complete telemetrics solution and includes the following components: -* telemd, a daemon that prepares the records to send to a telemetrics server or +* **telemd**, a daemon that prepares the records to send to a telemetrics server or spools the records on disk in case it cannot successfully deliver them. * Probes that collect specific types of data from the operating system. -* libtelemetry, that telemetrics probes use to create telemetrics records and +* **libtelemetry**, that telemetrics probes use to create telemetrics records and send them to the telemd daemon for further processing. The telemetry backend provides the server-side component of a complete telemetrics solution and @@ -63,14 +65,18 @@ consists of: * PostgreSQL as the underlying database server. +The default telemetry backend server reports back to the |CL| development team +and is not viewable outside the Intel firewall. If you want to collect your +own records, then you must set up your own telemetry backend server. + Next steps ********** To put this concept into practice, see the following resources: -* :ref:`Enable and disable telemetry in Clear Linux` -* :ref:`Create a telemetry backend server in Clear Linux` +* :ref:`Enable and disable telemetry in Clear Linux` +* :ref:`Create a telemetry backend server in Clear Linux` * `Telemetry feature description`_ -.. _`Telemetry feature description: - `https://clearlinux.org/features/telemetry +.. _`Telemetry feature description`: + https://clearlinux.org/features/telemetry diff --git a/source/clear-linux/guides/maintenance/telemetry-enable.rst b/source/clear-linux/guides/maintenance/telemetry-enable.rst index 1505b2b0..2723c209 100644 --- a/source/clear-linux/guides/maintenance/telemetry-enable.rst +++ b/source/clear-linux/guides/maintenance/telemetry-enable.rst @@ -5,8 +5,8 @@ Enable and disable telemetry in Clear Linux |CLOSIA| includes a telemetry solution as part of the OS that records events of interest and reports them back to the development team via the telemetrics -daemon, :command:`telemd`. This functionality is maintained in the -``telemetrics`` software bundle. +daemon, **telemd**. This functionality is maintained in the +**telemetrics** software bundle. .. note:: The telemetry functionality adheres to `Intel privacy policies`_ @@ -20,10 +20,10 @@ redirect where the records go if they wish to collect records for themselves. Install the telemetry software bundle ************************************* -During the initial installation of |CL| you are requested to join the +During the initial installation of |CL|, you are requested to join the stability enhancement program and allow |CLOSIA| to collect anonymous reports -to improve system stability. If you chose not to join this program at that -time then the telemetry software bundle is not added to your system. +to improve system stability. If you choose not to join this program, then the +telemetry software bundle is not added to your system. To install the telemetry bundle, enter the following command as either the root user or with :command:`sudo` privileges: @@ -105,12 +105,12 @@ Additional resources ******************** * `Telemetry feature description`_ -* :ref:`Telemetry architecture` -* :ref:`Create a telemetry backend server in Clear Linux` +* :ref:`Telemetry architecture` +* :ref:`Create a telemetry backend server in Clear Linux` * https://github.com/clearlinux/telemetrics-client .. _`Intel privacy policies`: https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html -.. _`Telemetry feature description: - `https://clearlinux.org/features/telemetry +.. _`Telemetry feature description`: + https://clearlinux.org/features/telemetry diff --git a/source/clear-linux/tutorials/telemetry-backend/telemetry-backend.rst b/source/clear-linux/tutorials/telemetry-backend/telemetry-backend.rst index 9d1ac866..06fe6384 100644 --- a/source/clear-linux/tutorials/telemetry-backend/telemetry-backend.rst +++ b/source/clear-linux/tutorials/telemetry-backend/telemetry-backend.rst @@ -463,8 +463,8 @@ Additional resources ******************** * `Telemetry feature description`_ -* :ref:`Telemetry architecture` -* :ref:`Enable and disable telemetry in Clear Linux` +* :ref:`Telemetry architecture` +* :ref:`Enable and disable telemetry in Clear Linux` * https://github.com/clearlinux/telemetrics-client * https://github.com/clearlinux/telemetrics-backend @@ -474,5 +474,5 @@ Additional resources .. _`Intel privacy policies`: https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html -.. _`Telemetry feature description: - `https://clearlinux.org/features/telemetry +.. _`Telemetry feature description`: + https://clearlinux.org/features/telemetry