Red Hat Developer Hub 1.4

Telemetry data collection

Collecting and analyzing telemetry data to enhance Red Hat Developer Hub experience

Red Hat Customer Content Services

Abstract

As a Red Hat Developer Hub administrator, you can collect and analyze telemetry data to enhance your Red Hat Developer Hub experience.

1. Telemetry data collection

The telemetry data collection feature helps in collecting and analyzing the telemetry data to improve your experience with Red Hat Developer Hub. This feature is enabled by default.

Important

As an administrator, you can disable the telemetry data collection feature based on your needs. For example, in an air-gapped environment, you can disable this feature to avoid needless outbound requests affecting the responsiveness of the RHDH application. For more details, see the Disabling telemetry data collection in RHDH section.

Red Hat collects and analyzes the following data:

  • Events of page visits and clicks on links or buttons.
  • System-related information, for example, locale, timezone, user agent including browser and OS details.
  • Page-related information, for example, title, category, extension name, URL, path, referrer, and search parameters.
  • Anonymized IP addresses, recorded as 0.0.0.0.
  • Anonymized username hashes, which are unique identifiers used solely to identify the number of unique users of the RHDH application.

With RHDH, you can customize the telemetry data collection feature and the telemetry Segment source configuration based on your needs.

1.1. Disabling telemetry data collection in RHDH

To disable telemetry data collection, you must disable the analytics-provider-segment plugin either using the Helm Chart or the Red Hat Developer Hub Operator configuration.

1.1.1. Disabling telemetry data collection using the Operator

You can disable the telemetry data collection feature by using the Operator.

Prerequisites

  • You have logged in as an administrator in the OpenShift Container Platform web console.
  • You have installed Red Hat Developer Hub on OpenShift Container Platform using the Operator.

Procedure

  1. Perform one of the following steps:

    • If you have created the dynamic-plugins-rhdh ConfigMap file and not configured the analytics-provider-segment plugin, add the plugin to the list of plugins and set its plugins.disabled parameter to true.
    • If you have created the dynamic-plugins-rhdh ConfigMap file and configured the analytics-provider-segment plugin, search the plugin in the list of plugins and set its plugins.disabled parameter to true.

    • If you have not created the ConfigMap file, create it with the following YAML code: 

      kind: ConfigMap
apiVersion: v1
metadata:
  name: dynamic-plugins-rhdh
data:
  dynamic-plugins.yaml: |
    includes:
      - dynamic-plugins.default.yaml
    plugins:
      - package: './dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment'
        disabled: true

  2. Set the value of the dynamicPluginsConfigMapName parameter to the name of the ConfigMap file in your Backstage custom resource: 

    # ...
spec:
  application:
    dynamicPluginsConfigMapName: dynamic-plugins-rhdh
# ...
  3. Save the configuration changes.

1.1.2. Disabling telemetry data collection using the Helm Chart

You can disable the telemetry data collection feature by using the Helm Chart.

Prerequisites

  • You have logged in as an administrator in the OpenShift Container Platform web console.
  • You have installed Red Hat Developer Hub on OpenShift Container Platform using the Helm Chart.

Procedure

  1. In the Developer perspective of the OpenShift Container Platform web console, go to the Helm view to see the list of Helm releases.

  2. Click the overflow menu on the Helm release that you want to use and select Upgrade.

    Note

    You can also create a new Helm release by clicking the Create button and edit the configuration to disable telemetry.

  3. Use either the Form view or YAML view to edit the Helm configuration:

    • Using Form view

      1. Expand Root Schema → global → Dynamic plugins configuration. → List of dynamic plugins that should be installed in the backstage application.
      2. Click the Add list of dynamic plugins that should be installed in the backstage application. link.

      3. Perform one of the following steps:

        • If you have not configured the plugin, add the following value in the Package specification of the dynamic plugin to install. It should be usable by the npm pack command. field:

          ./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment

          disabling telemetry
        • If you have configured the plugin, find the Package specification of the dynamic plugin to install. It should be usable by the npm pack command. field with the ./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment value.
      4. Select the Disable the plugin checkbox.
      5. Click Upgrade.

    • Using YAML view

      1. Perform one of the following steps:

        • If you have not configured the plugin, add the following YAML code in your values.yaml Helm configuration file: 

          # ...
global:
  dynamic:
    plugins:
      - package: './dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment'
        disabled: true
# ...
        • If you have configured the plugin, search it in your Helm configuration and set the value of the plugins.disabled parameter to true.
      2. Click Upgrade.

1.2. Enabling telemetry data collection in RHDH

The telemetry data collection feature is enabled by default. However, if you have disabled the feature and want to re-enable it, you must enable the analytics-provider-segment plugin either by using the Helm Chart or the Red Hat Developer Hub Operator configuration.

1.2.1. Enabling telemetry data collection using the Operator

You can enable the telemetry data collection feature by using the Operator.

Prerequisites

  • You have logged in as an administrator in the OpenShift Container Platform web console.
  • You have installed Red Hat Developer Hub on OpenShift Container Platform using the Operator.

Procedure

  1. Perform one of the following steps:

    • If you have created the dynamic-plugins-rhdh ConfigMap file and not configured the analytics-provider-segment plugin, add the plugin to the list of plugins and set its plugins.disabled parameter to false.
    • If you have created the dynamic-plugins-rhdh ConfigMap file and configured the analytics-provider-segment plugin, search the plugin in the list of plugins and set its plugins.disabled parameter to false.

    • If you have not created the ConfigMap file, create it with the following YAML code: 

      kind: ConfigMap
apiVersion: v1
metadata:
  name: dynamic-plugins-rhdh
data:
  dynamic-plugins.yaml: |
    includes:
      - dynamic-plugins.default.yaml
    plugins:
      - package: './dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment'
        disabled: false

  2. Set the value of the dynamicPluginsConfigMapName parameter to the name of the ConfigMap file in your Backstage custom resource: 

    # ...
spec:
  application:
    dynamicPluginsConfigMapName: dynamic-plugins-rhdh
# ...
  3. Save the configuration changes.

1.2.2. Enabling telemetry data collection using the Helm Chart

You can enable the telemetry data collection feature by using the Helm Chart.

Prerequisites

  • You have logged in as an administrator in the OpenShift Container Platform web console.
  • You have installed Red Hat Developer Hub on OpenShift Container Platform using the Helm Chart.

Procedure

  1. In the Developer perspective of the OpenShift Container Platform web console, go to the Helm view to see the list of Helm releases.

  2. Click the overflow menu on the Helm release that you want to use and select Upgrade.

    Note

    You can also create a new Helm release by clicking the Create button and edit the configuration to enable telemetry.

  3. Use either the Form view or YAML view to edit the Helm configuration:

    • Using Form view

      1. Expand Root Schema → global → Dynamic plugins configuration. → List of dynamic plugins that should be installed in the backstage application.
      2. Click the Add list of dynamic plugins that should be installed in the backstage application. link.

      3. Perform one of the following steps:

        • If you have not configured the plugin, add the following value in the Package specification of the dynamic plugin to install. It should be usable by the npm pack command. field:

          ./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment

        • If you have configured the plugin, find the Package specification of the dynamic plugin to install. It should be usable by the npm pack command. field with the ./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment value.
      4. Clear the Disable the plugin checkbox.
      5. Click Upgrade.

    • Using YAML view

      1. Perform one of the following steps:

        • If you have not configured the plugin, add the following YAML code in your Helm configuration file: 

          # ...
global:
  dynamic:
    plugins:
      - package: './dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment'
        disabled: false
# ...
        • If you have configured the plugin, search it in your Helm configuration and set the value of the plugins.disabled parameter to false.
      2. Click Upgrade.

1.3. Customizing telemetry Segment source

The analytics-provider-segment plugin sends the collected telemetry data to Red Hat by default. However, you can configure a new Segment source that receives telemetry data based on your needs. For configuration, you need a unique Segment write key that points to the Segment source.

Note

By configuring a new Segment source, you can collect and analyze the same set of data that is mentioned in Telemetry data collection. You might also require to create your own telemetry data collection notice for your application users.

1.3.1. Customizing telemetry Segment source using the Operator

You can configure integration with your Segment source by using the Operator.

Prerequisites

  • You have logged in as an administrator in the OpenShift Container Platform web console.
  • You have installed Red Hat Developer Hub on OpenShift Container Platform using the Operator.

Procedure

  1. Add the following YAML code in your Backstage custom resource (CR): 

    # ...
spec:
  application:
    extraEnvs:
      envs:
        - name: SEGMENT_WRITE_KEY
          value: <segment_key> 1
# ...
    1
    Replace <segment_key> with a unique identifier for your Segment source.
  2. Save the configuration changes.

1.3.2. Customizing telemetry Segment source using the Helm Chart

You can configure integration with your Segment source by using the Helm Chart.

Prerequisites

  • You have logged in as an administrator in the OpenShift Container Platform web console.
  • You have installed Red Hat Developer Hub on OpenShift Container Platform using the Helm Chart.

Procedure

  1. In the Developer perspective of the OpenShift Container Platform web console, go to the Helm view to see the list of Helm releases.
  2. Click the overflow menu on the Helm release that you want to use and select Upgrade.

  3. Use either the Form view or YAML view to edit the Helm configuration:

    • Using Form view

      1. Expand Root Schema → Backstage Chart Schema → Backstage Parameters → Backstage container environment variables.
      2. Click the Add Backstage container environment variables link.

      3. Enter the name and value of the Segment key.

        segment source helm
      4. Click Upgrade.

    • Using YAML view

      1. Add the following YAML code in your Helm configuration file: 

        # ...
upstream:
  backstage:
    extraEnvVars:
      - name: SEGMENT_WRITE_KEY
        value: <segment_key> 1
# ...
        1
        Replace <segment_key> with a unique identifier for your Segment source.
      2. Click Upgrade.

Legal Notice

Copyright © 2024 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.