Chapter 3. Enabling telemetry data collection in RHDH

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

     Copy to Clipboard Toggle word wrap

2. Set the value of the dynamicPluginsConfigMapName parameter to the name of your dynamic-plugins-rhdh config map in your Backstage custom resource:

   # ...
   spec:
     application:
       dynamicPluginsConfigMapName: dynamic-plugins-rhdh
   # ...

   Copy to Clipboard Toggle word wrap
3. Save the configuration changes.

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
          # ...

          Copy to Clipboard Toggle word wrap
        • 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.