RHIDP-5653: Reorganize Segment/Telemetry instructions into its own category

assemblies/assembly-customizing-segment-source.adoc

@@ -0,0 +1,17 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="customizing-segment-source_{context}"]
+= Customizing Segment source
+
+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.
+
+[NOTE]
+====
+Create your own web analytics data collection notice for your application users.
+====
+
+include::modules/analytics/proc-customizing-segment-source-using-the-operator.adoc[leveloffset=+1]
+
+include::modules/analytics/proc-customizing-segment-source-using-helm-the-helm-chart.adoc[leveloffset=+1]
+
+.Additional resources
+* To learn how to collect and analyze the same set of data, see link:{telemetry-data-collection-book-url}[{telemetry-data-collection-book-title}].

assemblies/assembly-disabling-telemetry-data-collection.adoc

@@ -0,0 +1,11 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="disabling-telemetry-data-collection_{context}"]
+= Disabling telemetry data collection in {product-very-short}
+
+To disable telemetry data collection, you must disable the `analytics-provider-segment` plugin either using the Helm Chart or the {product} Operator configuration.
+
+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 {product-very-short} application. For more details, see the link:{telemetry-data-collection-book-url}#proc-disabling-telemetry-using-operator_title-telemetry[Disabling telemetry data collection in {product-very-short}] section.
+
+include::modules/analytics/proc-disabling-telemetry-using-operator.adoc[leveloffset=+1]
+
+include::modules/analytics/proc-disabling-telemetry-using-helm.adoc[leveloffset=+1]

modules/observe/ref-enabling-telemetry.adoc → assemblies/assembly-enabling-telemetry-data-collection.adoc

@@ -1,5 +1,9 @@
+:_mod-docs-content-type: ASSEMBLY
 [id="enabling-telemetry-data-collection_{context}"]
 = Enabling telemetry data collection in {product-very-short}
 
 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.
 
+include::modules/analytics/proc-enabling-telemetry-using-operator.adoc[leveloffset=+1]
+
+include::modules/analytics/proc-enabling-telemetry-using-helm.adoc[leveloffset=+1]

modules/analytics/con-telemetry-data-collection-and-analysis.adoc

@@ -0,0 +1,28 @@
+[id="telemetry-data-collection-and-analysis_{context}"]
+= Telemetry data collection and analysis
+
+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.
+
+{company-name} collects and analyzes the following data:
+
+Web Analytics::
+Web Analytics use the Segment tool.
+It is the tracking of user behavior and interactions with {product}.
+Specifically, it tracks the following:
+
+* Events of page visits and clicks on links or buttons.
+* System-related information, for example, locale, time zone, user agent including browser and operating system 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 {product-very-short} application.
+
+System Observability::
+System Observability uses the OpenTelemetry tool.
+It is the tracking of the performance of the {product-very-short}.
+Specifically, it tracks the following metrics:
+
+* Key system metrics such as CPU usage, memory usage, and other performance indicators.
+* Information about system components, such as the locale, time zone, and user agent (including details of the browser and operating system).
+* Traces and logs monitor system processes, allowing you to troubleshoot potential issues impacting the performance of {product-very-short}.
+
+With {product-very-short}, you can customize the _Web Analytics_ and _System Observability_ configuration based on your needs.

modules/observe/proc-customizing-telemetry-segment-using-helm.adoc → modules/analytics/proc-customizing-segment-source-using-helm-the-helm-chart.adoc

@@ -1,7 +1,7 @@
-[id="proc-customizing-telemetry-segment-using-helm_{context}"]
-= Customizing telemetry Segment source using the Helm Chart
+[id="customizing-segment-source-using-helm-the-helm-chart_{context}"]
+= Customizing Segment source using the Helm Chart
 
-You can configure integration with your Segment source by using the Helm Chart.
+You can configure integration with your Segment source by using the {product} Helm Chart.
 
 .Prerequisites
 

modules/observe/proc-customizing-telemetry-segment-using-operator.adoc → modules/analytics/proc-customizing-segment-source-using-the-operator.adoc

@@ -1,7 +1,7 @@
 [id="proc-customizing-telemetry-segment-using-operator_{context}"]
-= Customizing telemetry Segment source using the Operator
+= Customizing Segment source using the Operator
 
-You can configure integration with your Segment source by using the Operator.
+You can configure integration with your Segment source by using the {product} Operator.
 
 .Prerequisites
 

titles/telemetry/master.adoc

@@ -1,11 +1,20 @@
 include::artifacts/attributes.adoc[]
 :context: title-telemetry
 :imagesdir: images
-:title: Telemetry data collection
-:subtitle: Collecting and analyzing telemetry data to enhance {product} experience
-:abstract: As a {product} administrator, you can collect and analyze telemetry data to enhance your {product} experience.
+:title: Telemetry data collection and analysis
+:subtitle: Collecting and analyzing web analytics and system observability data to enhance {product} experience
+:abstract: As a {product} administrator, you can collect and analyze two distinct types of telemetry data: web analytics using Segment and system observability using OpenTelemetry, to enhance the {product} experience.
 
 = {title}
 
-//Telemetry data collection
-include::assemblies/assembly-rhdh-telemetry.adoc[leveloffset=+1]
+//Telemetry data collection and analysis
+include::modules/analytics/con-telemetry-data-collection-and-analysis.adoc[leveloffset=+1]
+
+// disabling telemetry
+include::assemblies/assembly-disabling-telemetry-data-collection.adoc[leveloffset=+1]
+
+// enabling telemetry
+include::assemblies/assembly-enabling-telemetry-data-collection.adoc[leveloffset=+1]
+
+// customizing segment source
+include::assemblies/assembly-customizing-segment-source.adoc[leveloffset=+1]