Skip to content

RHDHPAI-735: Configuration info and other issues to fix #1060

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
merged 7 commits into from
Apr 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ As organizations generate an increasing number of data events, there is a growin

You can use Adoption Insights in {product} to visualize key metrics and trends to get information about the usage of {product-short} in your organization. The information provided by Adoption Insights in {product-short} pinpoints areas of improvement, highlights popular features, and evaluates progress toward adoption goals. You can also monitor user growth against license users and identify trends over time.

[NOTE]
====
Currently, the Adoption Insights plugin cannot be used alongside the built-in `plugin-analytics-provider-segment` plugin. For a workaround, see link:{release-notes-book-url}#developer-preview-rhdhpai-510[Adoption Insights in {product}.]
====

The Adoption Insights dashboard in {product-short} includes the following cards:

* *Active users*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can enable the Adoption Insights plugin by configuring the {product} Helm ch
.`app-config.yaml` fragment
[source,terminal]
----
App:
app:
analytics:
adoptionInsights:
maxBufferSize: 20 <1>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ To enable the Adoption Insights plugin, complete the following steps:
- importName: AdoptionInsightsAnalyticsApiFactory
----

. Configure the required RBAC permission for the users who are not administrators as shown in the following example:
. Optional: Configure the required RBAC permission for the users who are not administrators as shown in the following example:
+
[source,yaml]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

The *Active users* card displays the total number of active users over a specified time range. It also provides a breakdown comparison of *New users* and *Returning users* in a line/area graph format. You can export the user data in a .csv format.

*Returning users*: Existing users who have logged into {product-short}
* *Returning users*: Existing users who have logged into {product-short}

*New users*: New users who have registered and logged into {product-short}
* *New users*: New users who have registered and logged into {product-short}

image::rhdh-plugins-reference/active-users.jpg[active users]

Expand All @@ -24,9 +24,9 @@ image::rhdh-plugins-reference/active-users.jpg[active users]

This card displays the total number of users that have license to use {product}. It also provides a comparison of the number of *Logged-in users* and *Licensed users* in numeric and percentage form.

*Logged-in users*: Total number of users, including licensed and unlicensed users, currently logged in {product-short}
* *Logged-in users*: Total number of users, including licensed and unlicensed users, currently logged in to {product-short}.

*Licensed users*: Total number of licensed users logged in {product-short}. You can set the number of licensed users in your {product-short} app-config.yaml file.
* *Licensed users*: Total number of licensed users logged in to {product-short}. You can set the number of licensed users in your {product-short} app-config.yaml file.

.Procedure

Expand All @@ -38,12 +38,12 @@ This card displays the total number of users that have license to use {product}.

This card lists the most viewed catalog entities (like components, APIs, and so on) and documentation entries, including usage statistics, in a table.

Each item displays *Name*, *Kind*, *Last used*, and *Views*.
Each item displays the following details:

*Name*: Name of the catalog
*Kind*: Type of the catalog
*Last used*: The last time the catalog was used
*Views*: The number of times the catalog was viewed
* *Name*: Name of the catalog
* *Kind*: Type of the catalog
* *Last used*: The last time the catalog was used
* *Views*: The number of times the catalog was viewed

.Procedure

Expand All @@ -55,9 +55,9 @@ Each item displays *Name*, *Kind*, *Last used*, and *Views*.

This card lists the three most commonly used templates in a table. You can click the down arrow next to *3 rows* to view the full list of the commonly used templates.

*Name*: Name of the template
*Mostly in use by*: Type of user that used this template
*Executions*: Number of times this template was used
* *Name*: Name of the template
* *Mostly in use by*: Type of user using this template most frequently
* *Executions*: Number of times this template was used

.Procedure

Expand All @@ -69,10 +69,10 @@ This card lists the three most commonly used templates in a table. You can click

This card lists the most viewed documentation entries, including the total views, in a table.

*Name*: Name of the TechDoc
*Entity*: Type of the TechDoc
*Last used*: The last time the TechDoc was viewed
*Views*: Number of times the TechDocs was visited
* *Name*: Name of the documentation
* *Entity*: Type of the documentation
* *Last used*: The last time the documentation was viewed
* *Views*: Number of times the documentation was visited

.Procedure

Expand All @@ -84,9 +84,9 @@ This card lists the most viewed documentation entries, including the total views

This card lists the three most commonly used plugins in a table. You can click the down arrow next to *3 rows* to view the full list of the commonly used plugins.

*Name*: Name of the plugin
*Trend*: Popularity of the plugin as a graph
*Views*: Number of times this plugin was seen
* *Name*: Name of the plugin
* *Trend*: Popularity of the plugin as a graph
* *Views*: Number of times this plugin was seen

.Procedure

Expand Down