Skip to content

Commit faf4427

Browse files
author
GitHub Actions
committed
Reorganize Segment/Telemetry instructions into its own category
1 parent 4c55a99 commit faf4427

File tree

5 files changed

+22
-10
lines changed

5 files changed

+22
-10
lines changed

assemblies/assembly-rhdh-telemetry.adoc

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[id="assembly-rhdh-telemetry"]
2-
= Telemetry data collection
2+
= Telemetry data collection and analysis
33

44
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.
55

@@ -10,12 +10,24 @@ As an administrator, you can disable the telemetry data collection feature based
1010

1111
{company-name} collects and analyzes the following data:
1212

13+
*Web Analytics (Segment)*
14+
15+
Web Analytics tracks user behavior and interactions with {product}. Specifically, it tracks the following:
16+
1317
* Events of page visits and clicks on links or buttons.
1418
* System-related information, for example, locale, timezone, user agent including browser and OS details.
1519
* Page-related information, for example, title, category, extension name, URL, path, referrer, and search parameters.
1620
* Anonymized IP addresses, recorded as `0.0.0.0`.
1721
* Anonymized username hashes, which are unique identifiers used solely to identify the number of unique users of the {product-very-short} application.
1822

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+
1931
With {product-very-short}, you can customize the telemetry data collection feature and the telemetry Segment source configuration based on your needs.
2032

2133

modules/analytics/proc-customizing-telemetry-segment-using-helm.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[id="proc-customizing-telemetry-segment-using-helm_{context}"]
2-
= Customizing telemetry Segment source using the Helm Chart
2+
= Customizing Segment source using the Helm Chart
33

44
You can configure integration with your Segment source by using the Helm Chart.
55

modules/analytics/proc-customizing-telemetry-segment-using-operator.adoc

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

44
You can configure integration with your Segment source by using the Operator.
55

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
[id="customizing-telemetry-segment_{context}"]
2-
= Customizing telemetry Segment source
2+
= Customizing Segment source
33

44

5-
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.
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.
66

77
[NOTE]
88
====
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 telemetry data collection notice for your application users.
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.
1010
====
1111

1212

titles/telemetry/master.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
include::artifacts/attributes.adoc[]
22
:context: title-telemetry
33
:imagesdir: images
4-
:title: Telemetry data collection
4+
:title: Telemetry data collection and analysis
55
: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.
6+
:abstract: As a {product} administrator, you can collect and analyze two distinct types of telemetry data to enhance the {product} experience:_Web analytics_ (`Segment`) and _System Observability_ (`OpenTelemetry`).
77

88
= {title}
99

10-
//Telemetry data collection
10+
//Telemetry data collection and analysis
1111
include::assemblies/assembly-rhdh-telemetry.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)