Red Hat Developer Hub 1.5

Adoption Insights in Red Hat Developer Hub

Delivers detailed analytics on adoption and engagement within your internal developer portal.

Red Hat Customer Content Services

Abstract

As a platform engineer, you can configure Adoption Insights in RHDH to visualize key metrics and trends to get information about the usage of RHDH in your organization.

1. Adoption Insights

1. Adoption Insights

Important

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.

For more information about the support scope of Red Hat Developer Preview features, see Developer Preview Support Scope.

1.1. About Adoption Insights

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.

You can use Adoption Insights in Red Hat Developer Hub to visualize key metrics and trends to get information about the usage of Developer Hub in your organization. The information provided by Adoption Insights in Developer Hub 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.

The Adoption Insights dashboard in Developer Hub includes the following cards:

Active users
Total nuber of users
Top catalog entities
Top 3 templates
Top 3 techdocs
Top 3 plugins
Portal searches

1.2. Installing the Adoption Insights plugin in Red Hat Developer Hub

For the Red Hat Developer Hub Adoption Insights plugin, you must manually install the plugin.

Procedure

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:

- package: oci://quay.io/_<your_rhdh_plugins_repo>_/adoption-insights:latest!red-hat-developer-hub-backstage-plugin-adoption-insights
  disabled: false
  pluginConfig:
    dynamicPlugins:
      frontend:
        red-hat-developer-hub.backstage-plugin-adoption-insights:
          appIcons:
            - name: adoptionInsightsIcon
              importName: AdoptionInsightsIcon
          dynamicRoutes:
            - path: /adoption-insights
              importName: AdoptionInsightsPage
              menuItem:
                icon: adoptionInsightsIcon
                text: Adoption Insights
          menuItems:
            adoption-insights:
              parent: admin
              icon: adoptionInsightsIcon

- package: oci://quay.io/_<your_rhdh_plugins_repo>_/adoption-insights:latest!red-hat-developer-hub-backstage-plugin-adoption-insights-backend-dynamic
  disabled: false

- package: oci://quay.io/_<your_rhdh_plugins_repo>_/adoption-insights:latest!red-hat-developer-hub-backstage-plugin-analytics-module-adoption-insights
  disabled: false
  pluginConfig:
    dynamicPlugins:
      frontend:
        red-hat-developer-hub.backstage-plugin-analytics-module-adoption-insights:
          apiFactories:
            - importName: AdoptionInsightsAnalyticsApiFactory

1.3. Configuring the Adoption Insights plugin in Red Hat Developer Hub

You can enable the Adoption Insights plugin by configuring the Red Hat Developer Hub Helm chart or the Red Hat Developer Hub Operator ConfigMap.

Procedure

To configure the Adoption Insights plugin in Developer Hub, in your Red Hat Developer Hub app-config.yaml file, add the following code:
app-config.yaml fragment
```
	App:
  analytics:
    adoptionInsights:
      maxBufferSize: 20 1
      flushInterval: 5000 2
      debug: false 3
      licensedUsers: 2000 4
```
1
(Optional) Specifies the maximum buffer size for event batching. The default value is 20.
2
(Optional) Specifies the flush interval in milliseconds for event batching. The default value is 5000ms.
3
(Optional) The default value is false.
4
(Optional) Specifies the maximum number of licensed users who can access the RHDH instance. The default value is 100.

1.4. Using Adoption Insights in Red Hat Developer Hub

In the Developer Hub application, on the navigation menu, click Administration → Adoption Insights.

1.4.1. Setting the duration of data metrics

You can set the data metrics duration using any of the time ranges, such as Today, Last week, Last month, Last 28 days (default), Last year, or Date range….

Procedure

On the top of the screen, click the dropdown list to display the choices.
Select the duration choice for which you want to see the data metrics.

1.5. Viewing the Adoption Insights card

1.5.1. Viewing the active users

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 Developer Hub

New users: New users who have registered and logged into Developer Hub

Procedure

To view the list of active users in your Developer Hub instance, go to Administration → Adoption Insights, see the Active users card.
To view the exact number of users for a particular day, hover over the corresponding date in the Active users card.
To export the user data in a .csv format, click the Export CSV label.

1.5.2. Viewing the total number of users

This card displays the total number of users that have license to use Red Hat Developer Hub. 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 Developer Hub

Licensed users: Total number of licensed users logged in Developer Hub. You can set the number of licensed users in your Developer Hub app-config.yaml file.

Procedure

To view the total number of users in your Developer Hub instance in numeric and percentage forms, go to Administration → Adoption Insights and see the Total number of users card.
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.

1.5.3. Viewing the top catalog entities

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.

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

To view the most commonly used catalog entities in your Developer Hub instance, go to Administration → Adoption Insights and see the Top catalog entities card.
To know more about the displayed catalog entity, hover over the catalog entity name.

1.5.4. Viewing the top 3 templates

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

Procedure

To view the most commonly used templates in your Developer Hub instance, go to Administration → Adoption Insights and see the Top 3 templates card.
To know more about the displayed template, hover over the template name.

1.5.5. Viewing the top 3 techdocs

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

Procedure

To view the most commonly used templates in your Developer Hub instance, go to Administration → Adoption Insights and see the Top 3 techdocs card.
To know more about the displayed techdocs, hover over the techdocs name.

1.5.6. Viewing the top 3 plugins

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

Procedure

To view the most commonly used plugins and the plugin page visit trends in your Developer Hub instance, go to Administration → Adoption Insights and see the Top 3 plugins card.
To know more about the displayed plugin, hover over the plugin name.

1.6. Modifying the number of displayed records

1.6.1. Modifying the number of displayed records in Top catalog entities

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:

Top 3
Top 5
Top 10
Top 20

By default, the top three most viewed catalog entities are displayed.

Procedure

Go to Administration → Adoption Insights and click the Down arrow next to 3 rows to change the number of displayed records.

1.6.2. Modifying the number of displayed records in Top 3 templates

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:

Top 3
Top 5
Top 10
Top 20

By default, the top three most viewed templates are displayed.

Procedure

Go to Administration → Adoption Insights and click the Down arrow next to 3 rows to change the number of displayed records.

1.6.3. Modifying the number of displayed records in Top 3 techdocs

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:

Top 3
Top 5
Top 10
Top 20

By default, the top three most viewed TechDocs are displayed.

Procedure

Go to Administration → Adoption Insights and click the Down arrow next to 3 rows to change the number of displayed records.

1.6.4. Modifying the number of displayed records in Top 3 plugins

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:

Top 3
Top 5
Top 10
Top 20

By default, the top three most viewed plugins are displayed.

Procedure

Go to Administration → Adoption Insights and click the Down arrow next to 3 rows to change the number of displayed records.

1.7. Filtering records to display specific catalog entities in Top catalog entities

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 Developer Hub instance.

Procedure

To view a specific catalog entity in the table, complete the following step:

Go to Administration → Adoption Insights, click the dropdown filter on the Top catalog entities card, and select the item that you want to view.

1.8. Viewing Searches

In the searches card, you can view the following data:

Visualizes the number of portal searches and trends over time as a graph
Displays the total for the period in the card title
Clarifies the average number each hour/day/week/month depending on the time period chosen

Legal Notice

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.