Skip to content

Commit f7e9a1d

Browse files
pabel-rhpabel-rh
authored
RHDHPAI-596: Added content for RHDH adoption insights plugin (redhat-developer#1000)
* Added content for insights plugin * Fixed build error * Minor change * Adding missing con * Minor change * Minor changeS * Incorporated Karthik's comments * Changed the dev preview * Heena's comments
1 parent e04c251 commit f7e9a1d

19 files changed

+345
-2
lines changed

‎artifacts/snip-developer-preview.adoc

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[IMPORTANT]
2+
====
3+
This section describes Developer Preview features in the Adoption Insights plugin. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to functionality in advance of possible inclusion in a Red Hat product offering. Customers can use these features to test functionality and provide feedback during the development process. Developer Preview features might not have any documentation, are subject to change or removal at any time, and have received limited testing. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA.
4+
5+
For more information about the support scope of Red Hat Developer Preview features, see https://access.redhat.com/support/offerings/devpreview/[Developer Preview Support Scope].
6+
====

‎assemblies/assembly-adoption-insights.adoc

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
[id="assembly-adoption-insights"]
2+
= Adoption Insights
3+
4+
include::../artifacts/snip-developer-preview.adoc[]
5+
6+
//about adoption insights
7+
include::modules/observe/adoption-insights/con-about-adoption-insights.adoc[leveloffset=+1]
8+
9+
//installing adoption insights
10+
include::modules/observe/adoption-insights/proc-install-adoption-insights.adoc[leveloffset=+1]
11+
12+
//configuring adoption insights
13+
include::modules/observe/adoption-insights/proc-configure-adoption-insights.adoc[leveloffset=+1]
14+
15+
//using adoption insights
16+
include::modules/observe/adoption-insights/proc-using-adoption-insights.adoc[leveloffset=+1]
17+
18+
//setting data metrics
19+
include::modules/observe/adoption-insights/proc-setting-duration-of-data-metrics.adoc[leveloffset=+2]
20+
21+
//viewing cards
22+
include::modules/observe/adoption-insights/proc-viewing-adoption-insights-card.adoc[leveloffset=+1]
23+
24+
//modify number of displayed records
25+
include::modules/observe/adoption-insights/proc-modify-number-of-displayed-records.adoc[leveloffset=+1]
26+
27+
//filter records
28+
include::modules/observe/adoption-insights/proc-filter-records-to-display-spec.adoc[leveloffset=+1]
29+
30+
//viewing searches
31+
include::modules/observe/adoption-insights/proc-viewing-searches.adoc[leveloffset=+1]

‎modules/observe/adoption-insights/con-about-adoption-insights.adoc

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
:_mod-docs-content-type: CONCEPT
2+
[id="con-about-adoption-insights_{context}"]
3+
= About Adoption Insights
4+
5+
As organizations generate an increasing number of data events, there is a growing need for detailed insights into the adoption and engagement metrics of the internal developer portal. These insights help platform engineers make data-driven decisions to improve its performance, usability, and translate them into actionable insights.
6+
7+
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.
8+
9+
The Adoption Insights dashboard in {product-short} includes the following cards:
10+
11+
* *Active users*
12+
* *Total nuber of users*
13+
* *Top catalog entities*
14+
* *Top 3 templates*
15+
* *Top 3 techdocs*
16+
* *Top 3 plugins*
17+
* *Portal searches*

‎modules/observe/adoption-insights/proc-configure-adoption-insights.adoc

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-configure-adoption-insights_{context}"]
3+
= Configuring the Adoption Insights plugin in {product}
4+
5+
You can enable the Adoption Insights plugin by configuring the {product} Helm chart or the {product} Operator ConfigMap.
6+
7+
.Procedure
8+
9+
* To configure the Adoption Insights plugin in {product-short}, in your {product} `app-config.yaml` file, add the following code:
10+
+
11+
.`app-config.yaml` fragment
12+
[source,terminal]
13+
----
14+
App:
15+
analytics:
16+
adoptionInsights:
17+
maxBufferSize: 20 <1>
18+
flushInterval: 5000 <2>
19+
debug: false <3>
20+
licensedUsers: 2000 <4>
21+
----
22+
<1> (Optional) Specifies the maximum buffer size for event batching. The default value is `20`.
23+
<2> (Optional) Specifies the flush interval in milliseconds for event batching. The default value is `5000ms`.
24+
<3> (Optional) The default value is `false`.
25+
<4> (Optional) Specifies the maximum number of licensed users who can access the RHDH instance. The default value is `100`.

‎modules/observe/adoption-insights/proc-filter-records-to-display-spec.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-filter-records-to-display-spec_{context}"]
3+
= Filtering records to display specific catalog entities in Top catalog entities
4+
5+
You can use the dropdown filter in the title to filter the table display by any of the items. By default, the *Top catalog entities* card displays all of the items in your {product-short} instance.
6+
7+
.Procedure
8+
9+
To view a specific catalog entity in the table, complete the following step:
10+
11+
* Go to *Administration -> Adoption Insights*, click the dropdown filter on the *Top catalog entities* card, and select the item that you want to view.

‎modules/observe/adoption-insights/proc-install-adoption-insights.adoc

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * assemblies/assembly-rhdh-observability.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="proc-install-adoption-insights_{context}"]
7+
= Installing the Adoption Insights plugin in {product}
8+
9+
For the {product} Adoption Insights plugin, you must manually install the plugin.
10+
11+
.Procedure
12+
13+
* To enable the Adoption Insights plugin, set the `disabled` property to `false` in your `app-config-dynamic.yaml` file as shown in the following example:
14+
+
15+
[source,yaml]
16+
----
17+
- package: oci://quay.io/_<your_rhdh_plugins_repo>_/adoption-insights:latest!red-hat-developer-hub-backstage-plugin-adoption-insights
18+
disabled: false
19+
pluginConfig:
20+
dynamicPlugins:
21+
frontend:
22+
red-hat-developer-hub.backstage-plugin-adoption-insights:
23+
appIcons:
24+
- name: adoptionInsightsIcon
25+
importName: AdoptionInsightsIcon
26+
dynamicRoutes:
27+
- path: /adoption-insights
28+
importName: AdoptionInsightsPage
29+
menuItem:
30+
icon: adoptionInsightsIcon
31+
text: Adoption Insights
32+
menuItems:
33+
adoption-insights:
34+
parent: admin
35+
icon: adoptionInsightsIcon
36+
37+
- package: oci://quay.io/_<your_rhdh_plugins_repo>_/adoption-insights:latest!red-hat-developer-hub-backstage-plugin-adoption-insights-backend-dynamic
38+
disabled: false
39+
40+
- package: oci://quay.io/_<your_rhdh_plugins_repo>_/adoption-insights:latest!red-hat-developer-hub-backstage-plugin-analytics-module-adoption-insights
41+
disabled: false
42+
pluginConfig:
43+
dynamicPlugins:
44+
frontend:
45+
red-hat-developer-hub.backstage-plugin-analytics-module-adoption-insights:
46+
apiFactories:
47+
- importName: AdoptionInsightsAnalyticsApiFactory
48+
----

‎modules/observe/adoption-insights/proc-modify-number-of-displayed-records.adoc

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-modify-number-of-displayed-records_{context}"]
3+
= Modifying the number of displayed records
4+
5+
== Modifying the number of displayed records in Top catalog entities
6+
7+
You can modify the number of records that are displayed in the *Top catalog entities* card. You can select any of the following number of records for display:
8+
9+
* *Top 3*
10+
* *Top 5*
11+
* *Top 10*
12+
* *Top 20*
13+
14+
By default, the top three most viewed catalog entities are displayed.
15+
16+
.Procedure
17+
18+
* Go to *Administration -> Adoption Insights* and click the *Down* arrow next to *3 rows* to change the number of displayed records.
19+
20+
== Modifying the number of displayed records in Top 3 templates
21+
22+
You can modify the number of records that are displayed in the *Top 3 templates* card. You can select any of the following number of records for display:
23+
24+
* *Top 3*
25+
* *Top 5*
26+
* *Top 10*
27+
* *Top 20*
28+
29+
By default, the top three most viewed templates are displayed.
30+
31+
.Procedure
32+
33+
* Go to *Administration -> Adoption Insights* and click the *Down* arrow next to *3 rows* to change the number of displayed records.
34+
35+
== Modifying the number of displayed records in Top 3 techdocs
36+
37+
You can modify the number of records that are displayed in the *Top 3 techdocs* card. You can select any of the following number of records for display:
38+
39+
* *Top 3*
40+
* *Top 5*
41+
* *Top 10*
42+
* *Top 20*
43+
44+
By default, the top three most viewed TechDocs are displayed.
45+
46+
.Procedure
47+
48+
* Go to *Administration -> Adoption Insights* and click the *Down* arrow next to *3 rows* to change the number of displayed records.
49+
50+
== Modifying the number of displayed records in Top 3 plugins
51+
52+
You can modify the number of records that are displayed in the *Top 3 plugins* card. You can select any of the following number of records for display:
53+
54+
* *Top 3*
55+
* *Top 5*
56+
* *Top 10*
57+
* *Top 20*
58+
59+
By default, the top three most viewed plugins are displayed.
60+
61+
.Procedure
62+
63+
* Go to *Administration -> Adoption Insights* and click the *Down* arrow next to *3 rows* to change the number of displayed records.

‎modules/observe/adoption-insights/proc-setting-duration-of-data-metrics.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-setting-duration-of-data-metrics_{context}"]
3+
= Setting the duration of data metrics
4+
5+
You can set the data metrics duration using any of the time ranges, such as *All time* (default), *today*, *last week*, *last month*, *last year*, or you can select the range from the calendar.
6+
7+
.Procedure
8+
9+
. On the top of the screen, click the dropdown list to display the choices.
10+
. Select the duration choice for which you want to see the data metrics.

‎modules/observe/adoption-insights/proc-using-adoption-insights.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-using-adoption-insights_{context}"]
3+
= Using Adoption Insights in {product}
4+
5+
In the {product-short} application, on the navigation menu, click *Administration -> Adoption Insights*.

‎modules/observe/adoption-insights/proc-viewing-adoption-insights-card.adoc

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-viewing-adoption-insights-card_{context}"]
3+
= Viewing the Adoption Insights card
4+
5+
== Viewing the active users
6+
7+
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.
8+
9+
*Returning users*: Existing users who have logged into {product-short}
10+
11+
*New users*: New users who have registered and logged into {product-short}
12+
13+
.Procedure
14+
15+
* To view the list of active users in your Developer Hub instance, go to *Administration -> Adoption Insights*, see the Active users card.
16+
17+
* To view the exact number of users for a particular day, hover over the corresponding date in the *Active users* card.
18+
19+
* To export the user data in a .csv format, click the *Export CSV* label.
20+
21+
== Viewing the total number of users
22+
23+
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.
24+
25+
*Logged-in users*: Total number of users, including licensed and unlicensed users, currently logged in {product-short}
26+
27+
*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.
28+
29+
.Procedure
30+
31+
* To view the total number of users in your {product-short} instance in numeric and percentage forms, go to *Administration -> Adoption Insights* and see the *Total number of users* card.
32+
33+
* To view a percentage representation of the total number of logged-in users among the total number of licensed users, hover over the tooltip in the *Total number of users* card.
34+
35+
== Viewing the top catalog entities
36+
37+
This card lists the most viewed catalog entities (like components, APIs, and so on) and documentation entries, including usage statistics, in a table.
38+
39+
Each item displays *Name*, *Kind*, *Last used*, and *Views*.
40+
41+
*Name*: Name of the catalog
42+
*Kind*: Type of the catalog
43+
*Last used*: The last time the catalog was used
44+
*Views*: The number of times the catalog was viewed
45+
46+
.Procedure
47+
48+
* To view the most commonly used catalog entities in your {product-short} instance, go to *Administration -> Adoption Insights* and see the *Top catalog entities* card.
49+
50+
* To know more about the displayed catalog entity, hover over the catalog entity name.
51+
52+
== Viewing the top 3 templates
53+
54+
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.
55+
56+
*Name*: Name of the template
57+
*Mostly in use by*: Type of user that used this template
58+
*Executions*: Number of times this template was used
59+
60+
.Procedure
61+
62+
* To view the most commonly used templates in your {product-short} instance, go to *Administration -> Adoption Insights* and see the *Top 3 templates* card.
63+
64+
* To know more about the displayed template, hover over the template name.
65+
66+
== Viewing the top 3 techdocs
67+
68+
This card lists the most viewed documentation entries, including the total views, in a table.
69+
70+
*Name*: Name of the TechDoc
71+
*Entity*: Type of the TechDoc
72+
*Last used*: The last time the TechDoc was viewed
73+
*Views*: Number of times the TechDocs was visited
74+
75+
.Procedure
76+
77+
* To view the most commonly used templates in your {product-short} instance, go to *Administration -> Adoption Insights* and see the *Top 3 techdocs* card.
78+
79+
* To know more about the displayed techdocs, hover over the techdocs name.
80+
81+
== Viewing the top 3 plugins
82+
83+
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.
84+
85+
*Name*: Name of the plugin
86+
*Trend*: Popularity of the plugin as a graph
87+
*Views*: Number of times this plugin was seen
88+
89+
.Procedure
90+
91+
* To view the most commonly used plugins and the plugin page visit trends in your {product-short} instance, go to *Administration -> Adoption Insights* and see the *Top 3 plugins* card.
92+
93+
* To know more about the displayed plugin, hover over the plugin name.

‎modules/observe/adoption-insights/proc-viewing-searches.adoc

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-viewing-searches_{context}"]
3+
= Viewing Searches
4+
5+
In the *searches* card, you can view the following data:
6+
7+
* Visualizes the number of portal searches and trends over time as a graph
8+
* Displays the total for the period in the card title
9+
* Clarifies the average number each hour/day/week/month depending on the time period chosen

‎modules/observe/con-audit-log-track-changes-catalog.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44
[id="con-audit-log-track-changes-catalog_{context}"]
55
= {product-short} catalog database changes
66

7-
In {product} {ocp-version-min} and later, changes to the catalog database are forwarded to a central log management system, such as ElasticSearch or Splunk by default. Administrators can view changes that add, remove, or update data in the catalog database to help ensure accountability and transparency of user actions.
7+
In {product} {ocp-version-min} and later, changes to the catalog database are forwarded to a central log management system, such as ElasticSearch or Splunk by default. Administrators can view changes that add, remove, or update data in the catalog database to help ensure accountability and transparency of user actions.

‎modules/observe/proc-admin-enabling-metrics-ocp-helm.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ image::rhdh/upgrade-helm-metrics.png[]
4141
.Verification
4242

4343
. From the *Developer* perspective in the {ocp-short} web console, select the *Observe* view.
44-
. Click the *Metrics* tab to view metrics for {product} pods.
44+
. Click the *Metrics* tab to view metrics for {product} pods.

‎titles/adoption-insights/artifacts

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../artifacts

‎titles/adoption-insights/assemblies

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../assemblies

‎titles/adoption-insights/docinfo.xml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<title>{title}</title>
2+
<productname>{product}</productname>
3+
<productnumber>{product-version}</productnumber>
4+
<subtitle>{subtitle}</subtitle>
5+
<abstract>
6+
<para>{abstract}</para>
7+
</abstract>
8+
<authorgroup>
9+
<orgname>{company-name} Customer Content Services</orgname>
10+
</authorgroup>
11+
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

‎titles/adoption-insights/images

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../images

‎titles/adoption-insights/master.adoc

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
include::artifacts/attributes.adoc[]
2+
:context: title-adoption-insights
3+
:imagesdir: images
4+
:title: Adoption Insights in {product}
5+
:subtitle: Delivers detailed analytics on adoption and engagement within your internal developer portal.
6+
:abstract: As a platform engineer, you can configure Adoption Insights in {product-very-short} to visualize key metrics and trends to get information about the usage of {product-very-short} in your organization.
7+
= {title}
8+
9+
//{product} Adoption Insights (Developer Preview)
10+
include::assemblies/assembly-adoption-insights.adoc[leveloffset=+1]

‎titles/adoption-insights/modules

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../modules/

0 commit comments

Comments
 (0)