Skip to content

Commit 391100c

Browse files
committed
Incorporated Rohit's comments
1 parent 22a5fac commit 391100c

File tree

4 files changed

+58
-61
lines changed

4 files changed

+58
-61
lines changed

assemblies/assembly-adoption-insights.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ image::rhdh-plugins-reference/adoption-insights.jpg[adoption insights]
2323
include::modules/observe/adoption-insights/proc-configure-adoption-insights.adoc[leveloffset=+1]
2424

2525
//disabling adoption insights
26-
include::modules/observe/adoption-insights/proc-disable-adoption-insights.adoc[leveloffset=+1]
26+
include::modules/observe/adoption-insights/proc-customize-adoption-insights.adoc[leveloffset=+1]
2727

2828
//using adoption insights
2929
include::modules/observe/adoption-insights/proc-using-adoption-insights.adoc[leveloffset=+1]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
[id="proc-configure-adoption-insights_{context}"]
33
= Configuring the Adoption Insights plugin in {product}
44

5-
The Adoption Insights plugin is preinstalled and enabled on a {product-short} instance by default. You can disable or enable the Adoption Insights plugin, and change other parameters, by configuring the {product} Helm chart or the {product} Operator ConfigMap.
5+
The Adoption Insights plugin is preinstalled and enabled on a {product-short} instance by default. You can disable or enable the Adoption Insights plugin and change other parameters, by configuring the {product} Helm chart or the {product} Operator ConfigMap.
66

77
[IMPORTANT]
88
====
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * assemblies/assembly-rhdh-observability.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="proc-customize-adoption-insights_{context}"]
7+
= Customizing the Adoption Insights plugin in {product}
8+
9+
You can customize the Adoption Insights plugin to suit your needs by disabling or re-enabling it, and adjusting other settings as needed.
10+
11+
For the {product} Adoption Insights plugin, you must manually disable the plugin.
12+
13+
.Procedure
14+
15+
* 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:
16+
+
17+
.`app-config.yaml` fragment
18+
[source,terminal]
19+
----
20+
app:
21+
analytics:
22+
adoptionInsights:
23+
maxBufferSize: _<maximum_buffer_size>_ <1>
24+
flushInterval: _<flush_interval>_ <2>
25+
debug: _<debug_value>_ <3>
26+
licensedUsers: _<licensed_users>_ <4>
27+
----
28+
<1> (Optional) Specifies the maximum buffer size for event batching. The default value is `20`.
29+
<2> (Optional) Specifies the flush interval in milliseconds for event batching. The default value is `5000ms`.
30+
<3> (Optional) The default value is `false`.
31+
<4> (Optional) Specifies the maximum number of licensed users who can access the RHDH instance. The default value is `100`.
32+
33+
* To disable the Adoption Insights plugin, in your `app-config-dynamic.yaml` file, update the `package.disabled` value to `false` as shown in the following example:
34+
+
35+
[source,yaml]
36+
----
37+
- package: ./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment
38+
disabled: true
39+
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-adoption-insights:bs_1.35.1__0.0.3!red-hat-developer-hub-backstage-plugin-adoption-insights
40+
disabled: true
41+
pluginConfig:
42+
dynamicPlugins:
43+
frontend:
44+
red-hat-developer-hub.backstage-plugin-analytics-module-adoption-insights:
45+
analyticsApiExtensions:
46+
- importName: AdoptionInsightsAnalyticsApi
47+
----
48+
49+
* Optional: Configure the required RBAC permission for the users who are not administrators as shown in the following example:
50+
+
51+
[source,yaml]
52+
----
53+
p, role:default/_<your_team>_, adoption-insights.events.read, read, allow
54+
g, user:default/_<your_user>_, role:default/_<your_team>_
55+
----
56+
See link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in {product}].

modules/observe/adoption-insights/proc-disable-adoption-insights.adoc

Lines changed: 0 additions & 59 deletions
This file was deleted.

0 commit comments

Comments
 (0)