Merge pull request #246 from clearlinux/bd-telemetry

updates to reflect telemetry client refactoring
This commit is contained in:
michael vincerra
2018-10-01 13:36:55 -07:00
committed by GitHub
3 changed files with 12 additions and 10 deletions
Binary file not shown.

Before

Width:  |  Height:  |  Size: 59 KiB

After

Width:  |  Height:  |  Size: 131 KiB

@@ -3,7 +3,7 @@
Telemetrics
###########
One of the key features of |CLOSIA| is telemetry, which is used to
One of the key features of |CL-ATTR| is telemetry, which is used to
monitor system health. Telemetry enables developers to observe and proactively
address issues before end users are impacted.
@@ -47,11 +47,13 @@ Architecture
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
spools the records on disk in case it cannot successfully deliver them.
* Probes that collect specific types of data from the operating system.
* **telemprobd**, a daemon that prepares the telemetry records and spools them on disk prior to delivery
* **telempostd**, a daemon that sends the records to the telemetry backend server or leaves them on disk until deleting after the record expires.
* **probes**, that collect specific types of data from the operating system.
* **libtelemetry**, that telemetrics probes use to create telemetrics records and
send them to the telemd daemon for further processing.
send them to the telemprobd daemon for further processing.
The telemetry backend provides the server-side component of a complete telemetrics solution and
consists of:
@@ -3,7 +3,7 @@
Enable and disable telemetry in Clear Linux
###########################################
|CLOSIA| includes a telemetry solution as part of the OS that records events
|CL| 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, **telemd**. This functionality is maintained in the
**telemetrics** software bundle.
@@ -21,7 +21,7 @@ Install the telemetry software bundle
*************************************
During the initial installation of |CL|, you are requested to join the
stability enhancement program and allow |CLOSIA| to collect anonymous reports
stability enhancement program and allow |CL| to collect anonymous reports
to improve system stability. If you choose not to join this program, then the
telemetry software bundle is not added to your system.
@@ -36,7 +36,7 @@ This adds the telemetrics-client to your system and you will automatically
opt-in for the service.
Enable Telemetry
****************
*****************
To start telemetry on your system, run the following command:
@@ -44,7 +44,7 @@ To start telemetry on your system, run the following command:
sudo telemctl start
This enables and starts the :command:`telemd` daemon and your system will
This enables and starts the :command:`telemprobd` and :command:`telempostd` daemons and your system will
begin to send telemetry data to the server defined in the file
:file:`/etc/telemetrics/telemetrics.conf`. If this file does not exist, the
:command:`telemd` daemon will use the file
@@ -53,7 +53,7 @@ begin to send telemetry data to the server defined in the file
Disable Telemetry
*****************
To disable the telemetry daemon, run the following command:
To disable both of the telemetry daemons, run the following command:
.. code-block:: bash