diff --git a/assemblies/assembly-rhdh-telemetry.adoc b/assemblies/assembly-rhdh-telemetry.adoc index 00ee46fdda..6dc4c673d9 100644 --- a/assemblies/assembly-rhdh-telemetry.adoc +++ b/assemblies/assembly-rhdh-telemetry.adoc @@ -1,5 +1,5 @@ [id="assembly-rhdh-telemetry"] -= Telemetry data collection += 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. @@ -10,32 +10,44 @@ As an administrator, you can disable the telemetry data collection feature based {company-name} collects and analyzes the following data: +*Web Analytics (Segment)* + +Web Analytics tracks 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, timezone, user agent including browser and OS details. +* System-related information, for example, locale, time zone, 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 {product-very-short} application. -With {product-very-short}, you can customize the telemetry data collection feature and the telemetry Segment source configuration based on your needs. +*System Observability (OpenTelemetry)* + +System Observability tracks the performance of the {product-very-short}. Specifically, it tracks the following: + +* Key system metrics such as CPU usage, memory usage, and other performance indicators. +* Information about system components, such as the locale, timezone, 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. // disabling telemetry -include::modules/observe/ref-disabling-telemetry.adoc[leveloffset=+1] +include::modules/observe/analytics/ref-disabling-telemetry.adoc[leveloffset=+1] -include::modules/observe/proc-disabling-telemetry-using-operator.adoc[leveloffset=+2] +include::modules/observe/analytics/proc-disabling-telemetry-using-operator.adoc[leveloffset=+2] -include::modules/observe/proc-disabling-telemetry-using-helm.adoc[leveloffset=+2] +include::modules/observe/analytics/proc-disabling-telemetry-using-helm.adoc[leveloffset=+2] // enabling telemetry -include::modules/observe/ref-enabling-telemetry.adoc[leveloffset=+1] +include::modules/observe/analytics/ref-enabling-telemetry.adoc[leveloffset=+1] -include::modules/observe/proc-enabling-telemetry-using-operator.adoc[leveloffset=+2] +include::modules/observe/analytics/proc-enabling-telemetry-using-operator.adoc[leveloffset=+2] -include::modules/observe/proc-enabling-telemetry-using-helm.adoc[leveloffset=+2] +include::modules/observe/analytics/proc-enabling-telemetry-using-helm.adoc[leveloffset=+2] // customizing telemetry segment source -include::modules/observe/ref-customizing-telemetry-segment.adoc[leveloffset=+1] +include::modules/observe/analytics/ref-customizing-telemetry-segment.adoc[leveloffset=+1] -include::modules/observe/proc-customizing-telemetry-segment-using-operator.adoc[leveloffset=+2] +include::modules/observe/analytics/proc-customizing-telemetry-segment-using-operator.adoc[leveloffset=+2] -include::modules/observe/proc-customizing-telemetry-segment-using-helm.adoc[leveloffset=+2] +include::modules/observe/analytics/proc-customizing-telemetry-segment-using-helm.adoc[leveloffset=+2] diff --git a/modules/observe/proc-customizing-telemetry-segment-using-helm.adoc b/modules/observe/analytics/proc-customizing-telemetry-segment-using-helm.adoc similarity index 95% rename from modules/observe/proc-customizing-telemetry-segment-using-helm.adoc rename to modules/observe/analytics/proc-customizing-telemetry-segment-using-helm.adoc index 3b61cbb981..0be73355c7 100644 --- a/modules/observe/proc-customizing-telemetry-segment-using-helm.adoc +++ b/modules/observe/analytics/proc-customizing-telemetry-segment-using-helm.adoc @@ -1,5 +1,5 @@ [id="proc-customizing-telemetry-segment-using-helm_{context}"] -= Customizing telemetry Segment source using the Helm Chart += Customizing Segment source using the Helm Chart You can configure integration with your Segment source by using the Helm Chart. diff --git a/modules/observe/proc-customizing-telemetry-segment-using-operator.adoc b/modules/observe/analytics/proc-customizing-telemetry-segment-using-operator.adoc similarity index 92% rename from modules/observe/proc-customizing-telemetry-segment-using-operator.adoc rename to modules/observe/analytics/proc-customizing-telemetry-segment-using-operator.adoc index 0d08938f23..f0357e9e38 100644 --- a/modules/observe/proc-customizing-telemetry-segment-using-operator.adoc +++ b/modules/observe/analytics/proc-customizing-telemetry-segment-using-operator.adoc @@ -1,5 +1,5 @@ [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. diff --git a/modules/observe/proc-disabling-telemetry-using-helm.adoc b/modules/observe/analytics/proc-disabling-telemetry-using-helm.adoc similarity index 100% rename from modules/observe/proc-disabling-telemetry-using-helm.adoc rename to modules/observe/analytics/proc-disabling-telemetry-using-helm.adoc diff --git a/modules/observe/proc-disabling-telemetry-using-operator.adoc b/modules/observe/analytics/proc-disabling-telemetry-using-operator.adoc similarity index 100% rename from modules/observe/proc-disabling-telemetry-using-operator.adoc rename to modules/observe/analytics/proc-disabling-telemetry-using-operator.adoc diff --git a/modules/observe/proc-enabling-telemetry-using-helm.adoc b/modules/observe/analytics/proc-enabling-telemetry-using-helm.adoc similarity index 100% rename from modules/observe/proc-enabling-telemetry-using-helm.adoc rename to modules/observe/analytics/proc-enabling-telemetry-using-helm.adoc diff --git a/modules/observe/proc-enabling-telemetry-using-operator.adoc b/modules/observe/analytics/proc-enabling-telemetry-using-operator.adoc similarity index 100% rename from modules/observe/proc-enabling-telemetry-using-operator.adoc rename to modules/observe/analytics/proc-enabling-telemetry-using-operator.adoc diff --git a/modules/observe/analytics/ref-customizing-telemetry-segment.adoc b/modules/observe/analytics/ref-customizing-telemetry-segment.adoc new file mode 100644 index 0000000000..fc9b0fd2ee --- /dev/null +++ b/modules/observe/analytics/ref-customizing-telemetry-segment.adoc @@ -0,0 +1,12 @@ +[id="customizing-telemetry-segment_{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] +==== +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. +==== + + diff --git a/modules/observe/ref-disabling-telemetry.adoc b/modules/observe/analytics/ref-disabling-telemetry.adoc similarity index 100% rename from modules/observe/ref-disabling-telemetry.adoc rename to modules/observe/analytics/ref-disabling-telemetry.adoc diff --git a/modules/observe/ref-enabling-telemetry.adoc b/modules/observe/analytics/ref-enabling-telemetry.adoc similarity index 100% rename from modules/observe/ref-enabling-telemetry.adoc rename to modules/observe/analytics/ref-enabling-telemetry.adoc diff --git a/modules/observe/ref-customizing-telemetry-segment.adoc b/modules/observe/ref-customizing-telemetry-segment.adoc deleted file mode 100644 index 9ee7698713..0000000000 --- a/modules/observe/ref-customizing-telemetry-segment.adoc +++ /dev/null @@ -1,12 +0,0 @@ -[id="customizing-telemetry-segment_{context}"] -= Customizing telemetry Segment source - - -The `analytics-provider-segment` plugin sends the collected telemetry data to {company-name} 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 link:{telemetry-data-collection-book-url}[{telemetry-data-collection-book-title}]. You might also require to create your own telemetry data collection notice for your application users. -==== - - diff --git a/titles/telemetry/master.adoc b/titles/telemetry/master.adoc index 52a59af949..715b79c8ed 100644 --- a/titles/telemetry/master.adoc +++ b/titles/telemetry/master.adoc @@ -1,11 +1,11 @@ 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 +//Telemetry data collection and analysis include::assemblies/assembly-rhdh-telemetry.adoc[leveloffset=+1]