Ce contenu n'est pas disponible dans la langue sélectionnée.
Chapter 5. Telemetry data collection
The telemetry data collection feature is enabled by default. Red Hat Developer Hub sends telemetry data to Red Hat by using the backstage-plugin-analytics-provider-segment plugin.
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 to improve your experience with Red Hat Developer Hub:
- 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.
5.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.
If the analytics-provider-segment plugin is already present in your dynamic plugins configuration, set the value of the plugins.disabled parameter to true to disable telemetry data collection.
Procedure
Disable the
analytics-provider-segmentplugin by using one of the following options:Using Helm Chart
Add the following YAML code in your Helm configuration file:
# ... global: dynamic: plugins: - package: './dynamic-plugins/dist/janus-idp-backstage-plugin-analytics-provider-segment' disabled: true # ...
Using the Operator
Perform one of the following steps:
-
If you have created the
dynamic-plugins-rhdhConfigMap file, add theanalytics-provider-segmentplugin to the list of plugins and set itsplugins.disabledparameter totrue. 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/janus-idp-backstage-plugin-analytics-provider-segment' disabled: true
-
If you have created the
Set the value of the
dynamicPluginsConfigMapNameparameter to the name of the ConfigMap file in yourBackstagecustom resource:# ... spec: application: dynamicPluginsConfigMapName: dynamic-plugins-rhdh # ...
- Save the configuration changes.
5.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.
If the analytics-provider-segment plugin is already present in your dynamic plugins configuration, set the value of the plugins.disabled parameter to false to enable telemetry data collection.
Procedure
Configure the
analytics-provider-segmentplugin by using one of the following options:Using Helm Chart
Add the following YAML code in your Helm configuration file:
# ... global: dynamic: plugins: - package: './dynamic-plugins/dist/janus-idp-backstage-plugin-analytics-provider-segment' disabled: false # ...
Using the Operator
Perform one of the following steps:
-
If you have created the
dynamic-plugins-rhdhConfigMap file, add theanalytics-provider-segmentplugin to the list of plugins and set itsplugins.disabledparameter tofalse. 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/janus-idp-backstage-plugin-analytics-provider-segment' disabled: false
-
If you have created the
Set the value of the
dynamicPluginsConfigMapNameparameter to the name of the ConfigMap file in yourBackstagecustom resource:# ... spec: application: dynamicPluginsConfigMapName: dynamic-plugins-rhdh # ...
- Save the configuration changes.
5.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.
By configuring a new Segment source, you can collect and analyze the same set of data that is mentioned in the Telemetry data collection section. You might also require to create your own telemetry data collection notice for your application users.
Procedure
Configure integration with your Segment source by using one of the following options:
Using Helm Chart
Add the following YAML code in your Helm configuration file:
# ... upstream: backstage: extraEnvVars: - name: SEGMENT_WRITE_KEY value: <segment_key> 1 # ...- 1
<segment_key>denotes a unique identifier for your Segment source.
Using the Operator
Add the following YAML code in your
Backstagecustom resource (CR):# ... extraEnvs: envs: - name: SEGMENT_WRITE_KEY value: <segment_key> 1 # ...- 1
<segment_key>denotes a unique identifier for your Segment source.
- Save the configuration changes.
