Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7678e0b
Reorganize Segment/Telemetry instructions into its own category
invalid-email-address Apr 24, 2025
d7874e7
Reorganize Segment/Telemetry instructions into its own category
invalid-email-address Apr 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 24 additions & 12 deletions assemblies/assembly-rhdh-telemetry.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -10,32 +10,44 @@

{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.

Check warning on line 18 in assemblies/assembly-rhdh-telemetry.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.CaseSensitiveTerms] Use 'operating system' rather than 'OS'.

Raw Output:
{"message": "[RedHat.CaseSensitiveTerms] Use 'operating system' rather than 'OS'.", "location": {"path": "assemblies/assembly-rhdh-telemetry.adoc", "range": {"start": {"line": 18, "column": 96}}}, "severity": "WARNING"}

Check warning on line 18 in assemblies/assembly-rhdh-telemetry.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.CaseSensitiveTerms] Use 'operating system' rather than 'OS'.

Raw Output:
{"message": "[RedHat.CaseSensitiveTerms] Use 'operating system' rather than 'OS'.", "location": {"path": "assemblies/assembly-rhdh-telemetry.adoc", "range": {"start": {"line": 18, "column": 96}}}, "severity": "WARNING"}
* 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).

Check failure on line 28 in assemblies/assembly-rhdh-telemetry.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.TermsErrors] Use 'time zone' rather than 'timezone'.

Raw Output:
{"message": "[RedHat.TermsErrors] Use 'time zone' rather than 'timezone'.", "location": {"path": "assemblies/assembly-rhdh-telemetry.adoc", "range": {"start": {"line": 28, "column": 60}}}, "severity": "ERROR"}

Check failure on line 28 in assemblies/assembly-rhdh-telemetry.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.TermsErrors] Use 'time zone' rather than 'timezone'.

Raw Output:
{"message": "[RedHat.TermsErrors] Use 'time zone' rather than 'timezone'.", "location": {"path": "assemblies/assembly-rhdh-telemetry.adoc", "range": {"start": {"line": 28, "column": 60}}}, "severity": "ERROR"}
* 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]
2 changes: 1 addition & 1 deletion ...omizing-telemetry-segment-using-helm.adoc → ...omizing-telemetry-segment-using-helm.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion ...ing-telemetry-segment-using-operator.adoc → ...ing-telemetry-segment-using-operator.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
0 .../proc-disabling-telemetry-using-helm.adoc → .../proc-disabling-telemetry-using-helm.adoc
View file
Open in desktop
File renamed without changes.
0 ...c-disabling-telemetry-using-operator.adoc → ...c-disabling-telemetry-using-operator.adoc
View file
Open in desktop
File renamed without changes.
0 ...e/proc-enabling-telemetry-using-helm.adoc → ...s/proc-enabling-telemetry-using-helm.adoc
View file
Open in desktop
File renamed without changes.
0 ...oc-enabling-telemetry-using-operator.adoc → ...oc-enabling-telemetry-using-operator.adoc
View file
Open in desktop
File renamed without changes.
12 changes: 12 additions & 0 deletions modules/observe/analytics/ref-customizing-telemetry-segment.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
====


0 modules/observe/ref-disabling-telemetry.adoc → ...ve/analytics/ref-disabling-telemetry.adoc
View file
Open in desktop
File renamed without changes.
0 modules/observe/ref-enabling-telemetry.adoc → ...rve/analytics/ref-enabling-telemetry.adoc
View file
Open in desktop
File renamed without changes.
12 changes: 0 additions & 12 deletions modules/observe/ref-customizing-telemetry-segment.adoc
View file
Open in desktop

This file was deleted.

8 changes: 4 additions & 4 deletions titles/telemetry/master.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]