You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Reorganize Segment/Telemetry instructions into its own category
Reorganize Segment/Telemetry instructions into its own category
Reorganize Segment/Telemetry instructions into its own category
Reorganize Segment/Telemetry instructions into its own category
Reorganize Segment/Telemetry instructions into its own category
The telemetry data collection feature helps in collecting and analyzing the telemetry data to improve your experience with {product}. This feature is enabled by default.
5
5
@@ -10,32 +10,44 @@ As an administrator, you can disable the telemetry data collection feature based
10
10
11
11
{company-name} collects and analyzes the following data:
12
12
13
+
*Web Analytics (Segment)*
14
+
15
+
Web Analytics tracks user behavior and interactions with {product}. Specifically, it tracks the following:
16
+
13
17
* Events of page visits and clicks on links or buttons.
14
-
* System-related information, for example, locale, timezone, user agent including browser and OS details.
18
+
* System-related information, for example, locale, time zone, user agent including browser and OS details.
15
19
* Page-related information, for example, title, category, extension name, URL, path, referrer, and search parameters.
16
20
* Anonymized IP addresses, recorded as `0.0.0.0`.
17
21
* Anonymized username hashes, which are unique identifiers used solely to identify the number of unique users of the {product-very-short} application.
18
22
19
-
With {product-very-short}, you can customize the telemetry data collection feature and the telemetry Segment source configuration based on your needs.
23
+
*System Observability (OpenTelemetry)*
24
+
25
+
System Observability tracks the performance of the {product-very-short}. Specifically, it tracks the following:
26
+
27
+
* Key system metrics such as CPU usage, memory usage, and other performance indicators.
28
+
* Information about system components, such as the locale, timezone, and user agent (including details of the browser and operating system).
29
+
* Traces and logs monitor system processes, allowing you to troubleshoot potential issues impacting the performance of {product-very-short}.
30
+
31
+
With {product-very-short}, you can customize the _Web Analytics_ and _System Observability_ configuration based on your needs.
= Disabling telemetry data collection using the Helm Chart
3
+
4
+
You can disable the telemetry data collection feature by using the Helm Chart.
5
+
6
+
.Prerequisites
7
+
8
+
* You have logged in as an administrator in the {ocp-short} web console.
9
+
* You have installed {product} on {ocp-short} using the Helm Chart.
10
+
11
+
.Procedure
12
+
13
+
. In the *Developer* perspective of the {ocp-short} web console, go to the *Helm* view to see the list of Helm releases.
14
+
. Click the *overflow* menu on the Helm release that you want to use and select *Upgrade*.
15
+
+
16
+
[NOTE]
17
+
====
18
+
You can also create a new Helm release by clicking the *Create* button and edit the configuration to disable telemetry.
19
+
====
20
+
21
+
. Use either the *Form* view or *YAML* view to edit the Helm configuration:
22
+
** Using *Form view*
23
+
+
24
+
.. Expand *Root Schema → global → Dynamic plugins configuration. → List of dynamic plugins that should be installed in the backstage application*.
25
+
.. Click the *Add list of dynamic plugins that should be installed in the backstage application.* link.
26
+
27
+
.. Perform one of the following steps:
28
+
+
29
+
*** 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:
*** 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.
36
+
37
+
.. Select the *Disable the plugin* checkbox.
38
+
.. Click *Upgrade*.
39
+
40
+
** Using *YAML view*
41
+
+
42
+
.. Perform one of the following steps:
43
+
+
44
+
*** If you have not configured the plugin, add the following YAML code in your `values.yaml` Helm configuration file:
= Disabling telemetry data collection using the Operator
3
+
4
+
You can disable the telemetry data collection feature by using the Operator.
5
+
6
+
.Prerequisites
7
+
8
+
* You have logged in as an administrator in the {ocp-short} web console.
9
+
* You have installed {product} on {ocp-short} using the Operator.
10
+
11
+
.Procedure
12
+
13
+
. Perform one of the following steps:
14
+
+
15
+
* 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`.
16
+
+
17
+
* 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`.
18
+
+
19
+
* If you have not created the ConfigMap file, create it with the following YAML code:
. Set the value of the `dynamicPluginsConfigMapName` parameter to the name of your `dynamic-plugins-rhdh` config map in your `{product-custom-resource-type}` custom resource:
= Enabling telemetry data collection using the Helm Chart
3
+
4
+
You can enable the telemetry data collection feature by using the Helm Chart.
5
+
6
+
.Prerequisites
7
+
8
+
* You have logged in as an administrator in the {ocp-short} web console.
9
+
* You have installed {product} on {ocp-short} using the Helm Chart.
10
+
11
+
.Procedure
12
+
13
+
. In the *Developer* perspective of the {ocp-short} web console, go to the *Helm* view to see the list of Helm releases.
14
+
. Click the *overflow* menu on the Helm release that you want to use and select *Upgrade*.
15
+
+
16
+
[NOTE]
17
+
====
18
+
You can also create a new Helm release by clicking the *Create* button and edit the configuration to enable telemetry.
19
+
====
20
+
21
+
. Use either the *Form* view or *YAML* view to edit the Helm configuration:
22
+
** Using *Form view*
23
+
+
24
+
.. Expand *Root Schema → global → Dynamic plugins configuration. → List of dynamic plugins that should be installed in the backstage application*.
25
+
.. Click the *Add list of dynamic plugins that should be installed in the backstage application.* link.
26
+
27
+
.. Perform one of the following steps:
28
+
+
29
+
*** 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:
*** 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.
34
+
35
+
.. Clear the *Disable the plugin* checkbox.
36
+
.. Click *Upgrade*.
37
+
38
+
** Using *YAML view*
39
+
+
40
+
.. Perform one of the following steps:
41
+
+
42
+
*** If you have not configured the plugin, add the following YAML code in your Helm configuration file:
= Enabling telemetry data collection using the Operator
3
+
4
+
You can enable the telemetry data collection feature by using the Operator.
5
+
6
+
.Prerequisites
7
+
8
+
* You have logged in as an administrator in the {ocp-short} web console.
9
+
* You have installed {product} on {ocp-short} using the Operator.
10
+
11
+
.Procedure
12
+
13
+
. Perform one of the following steps:
14
+
+
15
+
* 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`.
16
+
+
17
+
* 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`.
18
+
+
19
+
* If you have not created the ConfigMap file, create it with the following YAML code:
. Set the value of the `dynamicPluginsConfigMapName` parameter to the name of your `dynamic-plugins-rhdh` config map in your `{product-custom-resource-type}` custom resource:
The `analytics-provider-segment` plugin sends the collected web analytics data to {company-name} by default. However, you can configure a new Segment source that receives web analytics data based on your needs. For configuration, you need a unique Segment write key that points to the Segment source.
6
+
7
+
[NOTE]
8
+
====
9
+
By configuring a new Segment source, you can collect and analyze the same set of data that is mentioned in link:{telemetry-data-collection-book-url}[{telemetry-data-collection-book-title}]. You might also require to create your own web analytics data collection notice for your application users.
= Disabling telemetry data collection in {product-very-short}
3
+
4
+
To disable telemetry data collection, you must disable the `analytics-provider-segment` plugin either using the Helm Chart or the {product} Operator configuration.
= Enabling telemetry data collection in {product-very-short}
3
+
4
+
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 {product} Operator configuration.
0 commit comments