generated from redhat-developer/new-project-template
-
Notifications
You must be signed in to change notification settings - Fork 47
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.
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
Merged
hmanwani-rh
merged 7 commits into
redhat-developer:main
from
jmagak:RHIDP-5653-Reorganize-Segment/Telemetry-instructions-into-its-own-category
May 5, 2025
Merged
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
7678e0b
Reorganize Segment/Telemetry instructions into its own category
invalid-email-address d7874e7
Reorganize Segment/Telemetry instructions into its own category
invalid-email-address 96f5892
Reorganize Segment/Telemetry instructions into its own category
invalid-email-address cf12513
Reorganize Segment/Telemetry instructions into its own category
invalid-email-address 02ac3cc
Reorganize Segment/Telemetry instructions into its own category
invalid-email-address f1167ce
Reorganize Segment/Telemetry instructions into its own category
invalid-email-address 70d65c2
Reorganize Segment/Telemetry instructions into its own category
invalid-email-address File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
:_mod-docs-content-type: ASSEMBLY | ||
[id="assembly-customizing-segment-source"] | ||
= 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-telemetry-segment-using-operator.adoc[leveloffset=+1] | ||
|
||
include::modules/analytics/proc-customizing-segment-source-using-helm.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}]. |
11 changes: 11 additions & 0 deletions
11
assemblies/assembly-disabling-telemetry-data-collection.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
:_mod-docs-content-type: ASSEMBLY | ||
[id="assembly-disabling-telemetry-data-collection"] | ||
jmagak marked this conversation as resolved.
Show resolved
Hide resolved
|
||
= 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] |
6 changes: 5 additions & 1 deletion
6
modules/observe/ref-enabling-telemetry.adoc → ...y-enabling-telemetry-data-collection.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,9 @@ | ||
[id="enabling-telemetry-data-collection_{context}"] | ||
:_mod-docs-content-type: ASSEMBLY | ||
[id="assembly-enabling-telemetry-data-collection"] | ||
jmagak marked this conversation as resolved.
Show resolved
Hide resolved
|
||
= 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] |
This file was deleted.
Oops, something went wrong.
34 changes: 34 additions & 0 deletions
34
modules/analytics/con-telemetry-data-collection-and-analysis.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
[id="con-telemetry-data-collection-and-analysis_{context}"] | ||
jmagak marked this conversation as resolved.
Show resolved
Hide resolved
|
||
= 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: | ||
|
||
jmagak marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* 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. | ||
|
||
jmagak marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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: | ||
|
||
jmagak marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* 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. |
6 changes: 3 additions & 3 deletions
6
...omizing-telemetry-segment-using-helm.adoc → ...ustomizing-segment-source-using-helm.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...ing-telemetry-segment-using-operator.adoc → ...ing-telemetry-segment-using-operator.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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] |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.