RHDHPAI-804: Multi-analytics provider (Adoption Insights plugin) #1229
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
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
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,67 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * assemblies/assembly-rhdh-observability.adoc | ||
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="proc-customize-adoption-insights_{context}"] | ||
| = Customizing the Adoption Insights plugin in {product} | ||
|
|
||
| You can customize the Adoption Insights plugin to suit your needs by disabling or re-enabling it, and adjusting other settings as needed. | ||
|
|
||
|
|
||
| [IMPORTANT] | ||
| ==== | ||
| If you used the developer preview of the Adoption Insights plugin and configured the feature manually, you must remove those earlier configuration changes as they are no longer required. | ||
| In your dynamic plugins ConfigMap, for example: `dynamic-plugins-rhdh.yaml`, update the `package-disabled` value of the plugin to `false` as shown in the following example: | ||
| .`dynamic-plugins.yaml` fragment | ||
| [source,yaml] | ||
| ---- | ||
| plugins: | ||
| - package: ./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment | ||
| disabled: false | ||
| ---- | ||
| ==== | ||
|
|
||
| .Procedure | ||
|
|
||
| * To customize `maxBufferSize`, `flushInterval`, `debug`, and `licensedUsers` in the Adoption Insights plugin, in your {product} `app-config.yaml` file, update the relevant settings as shown in the following code: | ||
| + | ||
| .`app-config.yaml` fragment | ||
| [source,terminal] | ||
| ---- | ||
| app: | ||
| analytics: | ||
| adoptionInsights: | ||
| maxBufferSize: _<maximum_buffer_size>_ <1> | ||
| flushInterval: _<flush_interval>_ <2> | ||
| debug: _<debug_value>_ <3> | ||
| licensedUsers: _<licensed_users>_ <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 {product-very-short} instance. The default value is `100`. | ||
| * To disable the Adoption Insights plugin, in your dynamic plugins ConfigMap, for example `dynamic-plugins-rhdh.yaml` file, update the `package.disabled` value of the plugin to `true` as shown in the following example: | ||
| + | ||
| [source,yaml] | ||
| ---- | ||
| - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-adoption-insights | ||
| disabled: true | ||
| - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-adoption-insights-backend-dynamic | ||
| disabled: true | ||
| - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-analytics-module-adoption-insights-dynamic | ||
| disabled: true | ||
| ---- | ||
| * Optional: Configure the required RBAC permission for the users who are not administrators as shown in the following example: | ||
| + | ||
| [source,yaml] | ||
| ---- | ||
| p, role:default/_<your_team>_, adoption-insights.events.read, read, allow | ||
| g, user:default/_<your_user>_, role:default/_<your_team>_ | ||
| ---- | ||
| See link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in {product}]. | ||
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
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,19 @@ | ||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="proc-viewing-active-users_{context}"] | ||
| = Viewing the active users | ||
|
|
||
| The *Active users* card displays the total number of active users over a specified date and time period. You can export the user data in a .csv format. | ||
|
|
||
| * *Returning users*: Existing users who have logged into {product-short} previously | ||
|
|
||
| * *New users*: New users who have registered and logged into {product-short} for the first time | ||
|
|
||
| image::rhdh-plugins-reference/active-users.jpg[active users] | ||
|
|
||
| .Procedure | ||
|
|
||
| * To view the list of active users in your {product} 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* link. |
Oops, something went wrong.
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.