Skip to content

Commit cd54a2e

Browse files
jmagakGitHub Actions
jmagak
and
GitHub Actions
authored
RHIDP-5653: Reorganize Segment/Telemetry instructions into its own category (#1034)
* 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 * 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 * Reorganize Segment/Telemetry instructions into its own category --------- Co-authored-by: GitHub Actions <[email protected]>
1 parent 1f3ef29 commit cd54a2e

14 files changed

+79
-69
lines changed

‎assemblies/assembly-customizing-segment-source.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="customizing-segment-source_{context}"]
3+
= Customizing Segment source
4+
5+
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+
Create your own web analytics data collection notice for your application users.
10+
====
11+
12+
include::modules/analytics/proc-customizing-segment-source-using-the-operator.adoc[leveloffset=+1]
13+
14+
include::modules/analytics/proc-customizing-segment-source-using-helm-the-helm-chart.adoc[leveloffset=+1]
15+
16+
.Additional resources
17+
* 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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="disabling-telemetry-data-collection_{context}"]
3+
= Disabling telemetry data collection in {product-very-short}
4+
5+
To disable telemetry data collection, you must disable the `analytics-provider-segment` plugin either using the Helm Chart or the {product} Operator configuration.
6+
7+
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.
8+
9+
include::modules/analytics/proc-disabling-telemetry-using-operator.adoc[leveloffset=+1]
10+
11+
include::modules/analytics/proc-disabling-telemetry-using-helm.adoc[leveloffset=+1]

‎modules/observe/ref-enabling-telemetry.adoc renamed to ‎assemblies/assembly-enabling-telemetry-data-collection.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1+
:_mod-docs-content-type: ASSEMBLY
12
[id="enabling-telemetry-data-collection_{context}"]
23
= Enabling telemetry data collection in {product-very-short}
34

45
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.
56

7+
include::modules/analytics/proc-enabling-telemetry-using-operator.adoc[leveloffset=+1]
8+
9+
include::modules/analytics/proc-enabling-telemetry-using-helm.adoc[leveloffset=+1]

‎assemblies/assembly-rhdh-telemetry.adoc

Lines changed: 0 additions & 41 deletions
This file was deleted.

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
[id="telemetry-data-collection-and-analysis_{context}"]
2+
= Telemetry data collection and analysis
3+
4+
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+
6+
{company-name} collects and analyzes the following data:
7+
8+
Web Analytics::
9+
Web Analytics use the Segment tool.
10+
It is the tracking of user behavior and interactions with {product}.
11+
Specifically, it tracks the following:
12+
13+
* Events of page visits and clicks on links or buttons.
14+
* System-related information, for example, locale, time zone, user agent including browser and operating system details.
15+
* Page-related information, for example, title, category, extension name, URL, path, referrer, and search parameters.
16+
* Anonymized IP addresses, recorded as `0.0.0.0`.
17+
* Anonymized username hashes, which are unique identifiers used solely to identify the number of unique users of the {product-very-short} application.
18+
19+
System Observability::
20+
System Observability uses the OpenTelemetry tool.
21+
It is the tracking of the performance of the {product-very-short}.
22+
Specifically, it tracks the following metrics:
23+
24+
* Key system metrics such as CPU usage, memory usage, and other performance indicators.
25+
* Information about system components, such as the locale, time zone, and user agent (including details of the browser and operating system).
26+
* Traces and logs monitor system processes, allowing you to troubleshoot potential issues impacting the performance of {product-very-short}.
27+
28+
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 renamed to ‎modules/analytics/proc-customizing-segment-source-using-helm-the-helm-chart.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
[id="proc-customizing-telemetry-segment-using-helm_{context}"]
2-
= Customizing telemetry Segment source using the Helm Chart
1+
[id="customizing-segment-source-using-helm-the-helm-chart_{context}"]
2+
= Customizing Segment source using the Helm Chart
33

4-
You can configure integration with your Segment source by using the Helm Chart.
4+
You can configure integration with your Segment source by using the {product} Helm Chart.
55

66
.Prerequisites
77

‎modules/observe/proc-customizing-telemetry-segment-using-operator.adoc renamed to ‎modules/analytics/proc-customizing-segment-source-using-the-operator.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[id="proc-customizing-telemetry-segment-using-operator_{context}"]
2-
= Customizing telemetry Segment source using the Operator
2+
= Customizing Segment source using the Operator
33

4-
You can configure integration with your Segment source by using the Operator.
4+
You can configure integration with your Segment source by using the {product} Operator.
55

66
.Prerequisites
77

‎modules/observe/proc-disabling-telemetry-using-helm.adoc renamed to ‎modules/analytics/proc-disabling-telemetry-using-helm.adoc

File renamed without changes.

‎modules/observe/proc-disabling-telemetry-using-operator.adoc renamed to ‎modules/analytics/proc-disabling-telemetry-using-operator.adoc

File renamed without changes.

‎modules/observe/proc-enabling-telemetry-using-helm.adoc renamed to ‎modules/analytics/proc-enabling-telemetry-using-helm.adoc

File renamed without changes.

‎modules/observe/proc-enabling-telemetry-using-operator.adoc renamed to ‎modules/analytics/proc-enabling-telemetry-using-operator.adoc

File renamed without changes.

‎modules/observe/ref-customizing-telemetry-segment.adoc

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎modules/observe/ref-disabling-telemetry.adoc

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎titles/telemetry/master.adoc

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
11
include::artifacts/attributes.adoc[]
22
:context: title-telemetry
33
:imagesdir: images
4-
:title: Telemetry data collection
5-
:subtitle: Collecting and analyzing telemetry data to enhance {product} experience
6-
:abstract: As a {product} administrator, you can collect and analyze telemetry data to enhance your {product} experience.
4+
:title: Telemetry data collection and analysis
5+
:subtitle: Collecting and analyzing web analytics and system observability data to enhance {product} experience
6+
: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.
77

88
= {title}
99

10-
//Telemetry data collection
11-
include::assemblies/assembly-rhdh-telemetry.adoc[leveloffset=+1]
10+
//Telemetry data collection and analysis
11+
include::modules/analytics/con-telemetry-data-collection-and-analysis.adoc[leveloffset=+1]
12+
13+
// disabling telemetry
14+
include::assemblies/assembly-disabling-telemetry-data-collection.adoc[leveloffset=+1]
15+
16+
// enabling telemetry
17+
include::assemblies/assembly-enabling-telemetry-data-collection.adoc[leveloffset=+1]
18+
19+
// customizing segment source
20+
include::assemblies/assembly-customizing-segment-source.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)