diff --git a/assemblies/assembly-customizing-segment-source.adoc b/assemblies/assembly-customizing-segment-source.adoc new file mode 100644 index 0000000000..010cb9bca9 --- /dev/null +++ b/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}]. \ No newline at end of file diff --git a/assemblies/assembly-disabling-telemetry-data-collection.adoc b/assemblies/assembly-disabling-telemetry-data-collection.adoc new file mode 100644 index 0000000000..421d49db5b --- /dev/null +++ b/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] \ No newline at end of file diff --git a/modules/observe/ref-enabling-telemetry.adoc b/assemblies/assembly-enabling-telemetry-data-collection.adoc similarity index 64% rename from modules/observe/ref-enabling-telemetry.adoc rename to assemblies/assembly-enabling-telemetry-data-collection.adoc index 9df4622324..62fa2dc9dd 100644 --- a/modules/observe/ref-enabling-telemetry.adoc +++ b/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] \ No newline at end of file diff --git a/assemblies/assembly-rhdh-telemetry.adoc b/assemblies/assembly-rhdh-telemetry.adoc deleted file mode 100644 index 00ee46fdda..0000000000 --- a/assemblies/assembly-rhdh-telemetry.adoc +++ /dev/null @@ -1,41 +0,0 @@ -[id="assembly-rhdh-telemetry"] -= Telemetry data collection - -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. - -[IMPORTANT] -==== -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. -==== - -{company-name} collects and analyzes the following data: - -* 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 {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. - - -// disabling telemetry -include::modules/observe/ref-disabling-telemetry.adoc[leveloffset=+1] - -include::modules/observe/proc-disabling-telemetry-using-operator.adoc[leveloffset=+2] - -include::modules/observe/proc-disabling-telemetry-using-helm.adoc[leveloffset=+2] - -// enabling telemetry -include::modules/observe/ref-enabling-telemetry.adoc[leveloffset=+1] - -include::modules/observe/proc-enabling-telemetry-using-operator.adoc[leveloffset=+2] - -include::modules/observe/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/proc-customizing-telemetry-segment-using-operator.adoc[leveloffset=+2] - -include::modules/observe/proc-customizing-telemetry-segment-using-helm.adoc[leveloffset=+2] diff --git a/modules/analytics/con-telemetry-data-collection-and-analysis.adoc b/modules/analytics/con-telemetry-data-collection-and-analysis.adoc new file mode 100644 index 0000000000..c5a48f3954 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/modules/observe/proc-customizing-telemetry-segment-using-helm.adoc b/modules/analytics/proc-customizing-segment-source-using-helm-the-helm-chart.adoc similarity index 89% rename from modules/observe/proc-customizing-telemetry-segment-using-helm.adoc rename to modules/analytics/proc-customizing-segment-source-using-helm-the-helm-chart.adoc index 3b61cbb981..08deb63aa0 100644 --- a/modules/observe/proc-customizing-telemetry-segment-using-helm.adoc +++ b/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 diff --git a/modules/observe/proc-customizing-telemetry-segment-using-operator.adoc b/modules/analytics/proc-customizing-segment-source-using-the-operator.adoc similarity index 90% rename from modules/observe/proc-customizing-telemetry-segment-using-operator.adoc rename to modules/analytics/proc-customizing-segment-source-using-the-operator.adoc index 0d08938f23..5a1f01c9b2 100644 --- a/modules/observe/proc-customizing-telemetry-segment-using-operator.adoc +++ b/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 diff --git a/modules/observe/proc-disabling-telemetry-using-helm.adoc b/modules/analytics/proc-disabling-telemetry-using-helm.adoc similarity index 100% rename from modules/observe/proc-disabling-telemetry-using-helm.adoc rename to modules/analytics/proc-disabling-telemetry-using-helm.adoc diff --git a/modules/observe/proc-disabling-telemetry-using-operator.adoc b/modules/analytics/proc-disabling-telemetry-using-operator.adoc similarity index 100% rename from modules/observe/proc-disabling-telemetry-using-operator.adoc rename to modules/analytics/proc-disabling-telemetry-using-operator.adoc diff --git a/modules/observe/proc-enabling-telemetry-using-helm.adoc b/modules/analytics/proc-enabling-telemetry-using-helm.adoc similarity index 100% rename from modules/observe/proc-enabling-telemetry-using-helm.adoc rename to modules/analytics/proc-enabling-telemetry-using-helm.adoc diff --git a/modules/observe/proc-enabling-telemetry-using-operator.adoc b/modules/analytics/proc-enabling-telemetry-using-operator.adoc similarity index 100% rename from modules/observe/proc-enabling-telemetry-using-operator.adoc rename to modules/analytics/proc-enabling-telemetry-using-operator.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/modules/observe/ref-disabling-telemetry.adoc b/modules/observe/ref-disabling-telemetry.adoc deleted file mode 100644 index 66bf4470e1..0000000000 --- a/modules/observe/ref-disabling-telemetry.adoc +++ /dev/null @@ -1,6 +0,0 @@ -[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. - - diff --git a/titles/telemetry/master.adoc b/titles/telemetry/master.adoc index 52a59af949..2608f4895a 100644 --- a/titles/telemetry/master.adoc +++ b/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] \ No newline at end of file