Skip to content

Commit 59b566e

Browse files
ShaunaDiazShaunaDiaz
committed
OSDOCS-13293: adds telemetry details to MicroShift
1 parent 106cb3c commit 59b566e

File tree

5 files changed

+158
-0
lines changed

5 files changed

+158
-0
lines changed

‎_topic_maps/_topic_map_ms.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,8 @@ Topics:
111111
File: microshift-getting-cluster-id
112112
- Name: Getting support
113113
File: microshift-getting-support
114+
- Name: Remote health monitoring with a connected cluster
115+
File: microshift-remote-cluster-monitoring
114116
---
115117
Name: Configuring
116118
Dir: microshift_configuring

‎microshift_support/microshift-remote-cluster-monitoring.adoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="microshift-remote-cluster-monitoring"]
3+
= Remote health monitoring with a connected cluster
4+
include::_attributes/attributes-microshift.adoc[]
5+
:context: microshift-remote-cluster-monitoring
6+
7+
toc::[]
8+
9+
Telemetry and configuration data about your cluster can be collected and reported to Red{nbsp}Hat.
10+
11+
include::modules/microshift-about-remote-health-monitoring.adoc[leveloffset=+1]
12+
13+
include::modules/microshift-info-collected-telemetry.adoc[leveloffset=+1]
14+
15+
include::modules/microshift-opt-out-telemetry.adoc[leveloffset=+1]
16+
17+
[id="additional-resources_microshift-remote-cluster-monitoring_{context}"]
18+
== Additional resources
19+
20+
* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-config-snippets_microshift-configuring[Using configuration snippets].

‎modules/microshift-about-remote-health-monitoring.adoc

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
// Module included in the following assemblies:
2+
//
3+
// microshift_support/microshift-remote-cluster-monitoring.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="microshift-about-remote-health-monitoring_{context}"]
7+
= About remote health monitoring with {microshift-short}
8+
9+
Remote health monitoring is conducted in {microshift-short} by the collection of telemetry and configuration data about your cluster that is reported to Red{nbsp}Hat with the Telemeter API. A cluster that reports Telemetry to Red{nbsp}Hat is considered a _connected cluster_.
10+
11+
*Telemetry* is the term that Red{nbsp}Hat uses to describe the information being sent to Red{nbsp}Hat by the {microshift-short} Telemeter API. Lightweight attributes are sent from a connected cluster to Red{nbsp}Hat to monitor the health of clusters.
12+
13+
.Telemetry benefits
14+
15+
Telemetry provides the following benefits:
16+
17+
* *Enhanced identification and resolution of issues*. Events that might seem normal to an end-user can be observed by Red{nbsp}Hat from a broader perspective. Some issues can be more rapidly identified from this point of view and resolved without an end-user needing to open a support case or file a link:https://issues.redhat.com/secure/CreateIssueDetails!init.jspa?pid=12332330&summary=Summary&issuetype=1&priority=10200&versions=12385624[Jira issue].
18+
19+
* *Targeted prioritization of new features and functionality*. The data collected provides information about system capabilities and usage characteristics. With this information, Red{nbsp}Hat can focus on developing the new features and functionality that have the greatest impact for our customers.
20+
21+
Telemetry sends a carefully chosen subset of the cluster monitoring metrics to Red{nbsp}Hat. The Telemeter API fetches the metrics values every hour and uploads the data to Red{nbsp}Hat. This stream of data is used by Red{nbsp}Hat to monitor a cluster over time.
22+
23+
This debugging information is available to Red{nbsp}Hat Support and Engineering teams with the same restrictions as accessing data reported through support cases. All _connected cluster_ information is used by Red{nbsp}Hat to help make {microshift-short} better.
24+
25+
[NOTE]
26+
====
27+
{microshift-short} does not support Prometheus. To view the Telemetry gathered from your cluster, you must contact Red{nbsp}Hat Support.
28+
====

‎modules/microshift-info-collected-telemetry.adoc

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * microshift_support/microshift-remote-cluster-monitoring.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="microshift-info-collected-by-telemetry_{context}"]
7+
= Information collected by the {microshift-short} Telemetry API
8+
9+
All metrics combined are generally under 2KB and not expected to consume cluster resources.
10+
11+
The following information is collected by Telemetry:
12+
13+
[id="microshift-telemetry-system-information_{context}"]
14+
== System information
15+
16+
The system information describes the basic configuration of your {microshift-short} cluster and where it is running, for example:
17+
18+
* Version information, including the {microshift-short} cluster version.
19+
* The {op-system-base-full} version.
20+
* The {op-system-base} deployment type.
21+
22+
[id="microshift-telemetry-sizing-information_{context}"]
23+
== Sizing information
24+
25+
Sizing information details the cluster capacity, for example:
26+
27+
* The CPU cores {microshift-short} can use.
28+
* Architecture information.
29+
* The usable bytes of memory.
30+
31+
[id="microshift-telemetry-usage-information_{context}"]
32+
== Usage information
33+
34+
Usage information outlines what is happening in the cluster, for example:
35+
36+
* The CPU usage in percentage.
37+
* The memory usage in percentage.
38+
* The number of Kubernetes objects by resource type (CRDs).
39+
* The number of running containers, namespaces, and running pods.
40+
* The number of routes, ingress, services.
41+
42+
[NOTE]
43+
====
44+
Telemetry does not collect identifying information such as usernames or passwords. Red{nbsp}Hat does not intend to collect personal information. If Red{nbsp}Hat discovers that personal information has been inadvertently received, Red{nbsp}Hat deletes such information. To the extent that any Telemetry constitutes personal data, refer to the link:https://www.redhat.com/en/about/privacy-policy[Red{nbsp}Hat Privacy Statement] for more information about Red{nbsp}Hat's privacy practices.
45+
====
46+
47+
[id="microshift-additional-details-rhm-data-use_{context}"]
48+
== Additional details about how remote health monitoring data is used
49+
50+
Red{nbsp}Hat collects data about your use of the Red{nbsp}Hat product(s) for purposes such as providing support and troubleshooting, improving the offerings and user experience, responding to issues, and for billing purposes if applicable.
51+
52+
.Collection safeguards
53+
54+
Red{nbsp}Hat employs technical and organizational measures designed to protect Telemetry data.
55+
56+
.Sharing
57+
58+
Red{nbsp}Hat might share the data collected through the Telemetry API internally within Red{nbsp}Hat to improve your user experience. Red{nbsp}Hat might share Telemetry data with its business partners in an aggregated form that does not identify customers to help the partners better understand their markets and their customers' use of Red{nbsp}Hat offerings, or to ensure the successful integration of products jointly supported by those partners.
59+
60+
.Third parties
61+
62+
Red{nbsp}Hat might engage certain third parties to assist in the collection, analysis, and storage of Telemetry data.
63+
64+
.User control: Disabling Telemetry data collection
65+
66+
You can disable {microshift-short} Telemetry by following the instructions in the "Opting out of remote health reporting for {microshift-short}" section.

‎modules/microshift-opt-out-telemetry.adoc

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
// Module included in the following assemblies:
2+
//
3+
// microshift_support/microshift-remote-cluster-monitoring.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="microshift-opt-out-telemetry_{context}"]
7+
= Opting out of Telemetry for {microshift-short}
8+
9+
If your cluster is not connected to a network, or you do not want Telemetry gathered, you can easily opt out of Telemetry by disabling the parameter in the {microshift-short} configuration file.
10+
11+
.Prerequisties
12+
13+
* You installed {oc-first}.
14+
* You have root access to the cluster.
15+
16+
.Procedure
17+
18+
. If you have not done so, make a copy of the provided `config.yaml.default` file in the `/etc/microshift/` directory, renaming it `config.yaml`.
19+
20+
. Keep the new {microshift-short} `config.yaml` in the `/etc/microshift/` directory. Your `config.yaml` file is read every time the {microshift-short} service starts.
21+
+
22+
[NOTE]
23+
====
24+
After you create it, the `config.yaml` file takes precedence over built-in settings.
25+
====
26+
27+
. Optional: Use a configuration snippet if you are using an existing {microshift-short} YAML. See "Using configuration snippets" in the _Additional resources_ section for more information.
28+
29+
. Set the `telemetry.status` section of the {microshift-short} YAML with the `Disabled` value.
30+
+
31+
.Example disabled Telemetry configuration
32+
[source,yaml]
33+
----
34+
apiServer:
35+
# ...
36+
telemetry:
37+
endpoint: https://infogw.api.openshift.com
38+
status: Disabled
39+
# ...
40+
----
41+
42+
//Should the user also delete the endpoint, or does that not matter?

0 commit comments

Comments
 (0)