+

Search Tips   |   Advanced Search


Telemetry

  1. What information is collected
  2. Show data collected by Telemetry
  3. Show data collected from the cluster
  4. Opt out of Telemetry


About

Telemetry collects anonymized aggregated information about:

This information is used by Red Hat to help make OpenShift better and more intuitive to use. None of the information is shared with third parties.


What information is collected

Telemetry does not collect, and will never collect, identifying information like user names, passwords, or the names or addresses of user resources.

Primary information collected includes:

  • Number of updates available per cluster
  • Channel and image repository used for an update
  • Number of errors that occurred during an update
  • Progress information of an update that is running
  • Number of machines per cluster
  • Number of CPU cores and size of RAM of the machines
  • Number of members in the etcd cluster and number of objects currently stored in the etcd cluster
  • Number of CPU cores and RAM used per machine type - infra or master
  • Number of CPU cores and RAM used per cluster
  • Use of OpenShift framework components per cluster
  • Version of the OpenShift cluster
  • Health, condition, and status for any OpenShift framework component that is installed on the cluster, for example Cluster Version Operator, Cluster Monitoring, Image Registry, and Elasticsearch for Logging
  • A unique random identifier that is generated during installation
  • Name of the platform OpenShift is deployed on, such as Amazon Web Services


Show data collected by Telemetry

An administrator might need to review the metrics that Telemetry collects.


Show data collected from the cluster

We can see the cluster and components time series data captured by Telemetry.

Prerequisites

Procedure

  1. Find the URL for the Prometheus service that runs in the OpenShift cluster:

      $ oc get route prometheus-k8s -n openshift-monitoring -o jsonpath="{.spec.host}"

  2. Navigate to the URL.

  3. Enter this query in the Expression input box and press Execute:

      {__name__="up"} or {__name__="cluster_version"} or {__name__="cluster_version_available_updates"} or {__name__="cluster_operator_up"} or {__name__="cluster_operator_conditions"} or {__name__="cluster_version_payload"} or {__name__="cluster_version_payload_errors"} or {__name__="instance:etcd_object_counts:sum"} or {__name__="ALERTS",alertstate="firing"} or {__name__="code:apiserver_request_count:rate:sum"} or {__name__="kube_pod_status_ready:etcd:sum"} or {__name__="kube_pod_status_ready:image_registry:sum"} or {__name__="cluster:capacity_cpu_cores:sum"} or {__name__="cluster:capacity_memory_bytes:sum"} or {__name__="cluster:cpu_usage_cores:sum"} or {__name__="cluster:memory_usage_bytes:sum"} or {__name__="openshift:cpu_usage_cores:sum"} or {__name__="openshift:memory_usage_bytes:sum"} or {__name__="cluster:node_instance_type_count:sum"}

    This query replicates the request that Telemetry makes against a running OpenShift cluster's Prometheus service and returns the full set of time series captured by Telemetry.


Opt out of Telemetry

You might need to opt out of Telemetry for the cluster. For example, we might need to comply with privacy laws.

Prerequisites


Consequences of disabling Telemetry

In OpenShift 4.1, customers can opt out of the Telemetry service. However, Telemetry is embedded as a core component and serves as part of the overall function of the cluster. Therefore, opting out is strongly discouraged.

Some of the consequences of opting out of Telemetry are:

  • The Red Hat OpenShift Cluster Manager does not work as expected and does not show critical information about the clusters.

  • We cannot perform subscription management, including legally entitling a purchase Red Hat through cloud.redhat.com. There is no disconnected subscription management. We cannot both opt out of sending data to Red Hat and entitle a purchase.

  • You will not gain quality assurance by reporting faults encountered during upgrades.

  • We cannot entitle the cluster.

    Deployment and management of OpenShift for disconnected environments is a critical goal and will be delivered in a future version of OpenShift.


    • Disable Telemetry

    We can disable Telemetry.

    Procedure

    1. Start editing the cluster-monitoring-config ConfigMap:

        $ oc -n openshift-monitoring edit configmap cluster-monitoring-config

    2. Add the two lines required to disable Telemetry to the data/config.yaml section, as shown: 
      apiVersion: v1
kind: ConfigMap
metadata:
  name: cluster-monitoring-config
  namespace: openshift-monitoring
data:
  config.yaml: |+
    telemeterClient:
      enabled: false



    Quick Links


    Help


    Site Info


    Related Sites


    About