Questo contenuto non è disponibile nella lingua selezionata.
Chapter 5. Remote health monitoring with a connected cluster
Telemetry and configuration data about your cluster can be collected and reported to Red Hat.
5.1. About remote health monitoring with MicroShift Copia collegamentoCollegamento copiato negli appunti!
Remote health monitoring is conducted in MicroShift by the collection of telemetry and configuration data about your cluster that is reported to Red Hat with the Telemeter API. A cluster that reports Telemetry to Red Hat is considered a connected cluster.
Telemetry is the term that Red Hat uses to describe the information being sent to Red Hat by the MicroShift Telemeter API. Lightweight attributes are sent from a connected cluster to Red Hat to monitor the health of clusters.
Telemetry benefits
Telemetry provides the following benefits:
- Enhanced identification and resolution of issues. Events that might seem normal to an end-user can be observed by Red 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 Jira issue.
- Targeted prioritization of new features and functionality. The data collected provides information about system capabilities and usage characteristics. With this information, Red Hat can focus on developing the new features and functionality that have the greatest impact for our customers.
Telemetry sends a carefully chosen subset of the cluster monitoring metrics to Red Hat. The Telemeter API fetches the metrics values every hour and uploads the data to Red Hat. This stream of data is used by Red Hat to monitor a cluster over time.
This debugging information is available to Red Hat Support and Engineering teams with the same restrictions as accessing data reported through support cases. All connected cluster information is used by Red Hat to help make MicroShift better.
MicroShift does not support Prometheus. To view the Telemetry gathered from your cluster, you must contact Red Hat Support.
5.2. Information collected by the MicroShift Telemetry API Copia collegamentoCollegamento copiato negli appunti!
All metrics combined are generally under 2KB and not expected to consume cluster resources.
The following information is collected by Telemetry:
5.2.1. System information Copia collegamentoCollegamento copiato negli appunti!
The system information describes the basic configuration of your MicroShift cluster and where it is running, for example:
- Version information, including the MicroShift cluster version.
- The Red Hat Enterprise Linux (RHEL) version.
- The RHEL deployment type.
5.2.2. Sizing information Copia collegamentoCollegamento copiato negli appunti!
Sizing information details the cluster capacity, for example:
- The CPU cores MicroShift can use.
- Architecture information.
- The usable bytes of memory.
5.2.3. Usage information Copia collegamentoCollegamento copiato negli appunti!
Usage information outlines what is happening in the cluster, for example:
- The CPU usage in percentage.
- The memory usage in percentage.
- The number of Kubernetes objects by resource type (CRDs).
- The number of running containers, namespaces, and running pods.
- The number of routes, ingress, services.
Telemetry does not collect identifying information such as usernames or passwords. Red Hat does not intend to collect personal information. If Red Hat discovers that personal information has been inadvertently received, Red Hat deletes such information. To the extent that any Telemetry constitutes personal data, refer to the Red Hat Privacy Statement for more information about Red Hat’s privacy practices.
5.2.4. Additional details about how remote health monitoring data is used Copia collegamentoCollegamento copiato negli appunti!
Red Hat collects data about your use of the Red 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.
Collection safeguards
Red Hat employs technical and organizational measures designed to protect Telemetry data.
Sharing
Red Hat might share the data collected through the Telemetry API internally within Red Hat to improve your user experience. Red 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 Hat offerings, or to ensure the successful integration of products jointly supported by those partners.
Third parties
Red Hat might engage certain third parties to assist in the collection, analysis, and storage of Telemetry data.
User control: Disabling Telemetry data collection
You can disable MicroShift Telemetry by following the instructions in the "Opting out of remote health reporting for MicroShift" section.
5.3. Opting out of Telemetry for MicroShift Copia collegamentoCollegamento copiato negli appunti!
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 configuration file.
Prerequisties
-
You installed OpenShift CLI (
oc
). - You have root access to the cluster.
Procedure
-
If you have not done so, make a copy of the provided
config.yaml.default
file in the/etc/microshift/
directory, renaming itconfig.yaml
. Keep the new MicroShift
config.yaml
in the/etc/microshift/
directory. Yourconfig.yaml
file is read every time the MicroShift service starts.NoteAfter you create it, the
config.yaml
file takes precedence over built-in settings.- Optional: Use a configuration snippet if you are using an existing MicroShift YAML. See "Using configuration snippets" in the Additional resources section for more information.
Set the
telemetry.status
section of the MicroShift YAML with theDisabled
value.Example disabled Telemetry configuration
Copy to Clipboard Copied! Toggle word wrap Toggle overflow