fix: product docs installation status #226919

arturoliduena · 2025-07-08T06:56:25Z

Summary

After switching the KB model, product documentation was not automatically installed, even if it had been installed previously. The user must reload the page to view the current installation status of the product documentation.

Screen.Recording.2025-07-07.at.17.17.13.mov

github-actions · 2025-07-08T06:56:39Z

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

/oblt-deploy : Deploy a Kibana instance using the Observability test environments.
run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

elasticmachine · 2025-07-08T07:19:44Z

Pinging @elastic/obs-ai-assistant (Team:Obs AI Assistant)

viduni94 · 2025-07-08T14:31:29Z

Hey @arturoliduena
Quick question, when you say

product documentation was not automatically installed

Do we expect the KB installation to automatically install product docs,
OR do we expect the Install button to be enabled for product doc installation after the KB is installed without needed a refresh?

viduni94

I did the following steps:

Installed the KB with ELSER
The product docs install button was successfully enabled ✅
Then I changed the KB model to e5
After the model change was completed, I can see the product doc install button is enabled again, but the new docs are also getting installed in the background.

Ideally, we should show the Installing... status if the product docs are already being installed in the background when the KB model is changed. Otherwise it feels like the user has to click install again and the UI represents an incorrect state.

Screen.Recording.2025-07-08.at.1.48.04.PM.mov

arturoliduena · 2025-07-09T08:13:56Z

Do we expect the KB installation to automatically install product docs,
OR do we expect the Install button to be enabled for product doc installation after the KB is installed without needed a refresh?

@viduni94, sorry for the confusion. After [AI Infra] Disables the Install product doc button when the Knowledge Base hasn't been installed #226604 changes, we see this small bug, where the install product doc button doesn't enable after installing the KB (the user needs to refresh the page), that what I am trying to fix here.

arturoliduena · 2025-07-09T10:21:56Z

Ideally, we should show the Installing... status if the product docs are already being installed in the background when the KB model is changed. Otherwise it feels like the user has to click install again and the UI represents an incorrect state.

@viduni94, do you think we should address this in this PR? We are planning to make product docs an implementation detail of the knowledge base (#225580), so this won't be necessary.

viduni94 · 2025-07-09T11:10:45Z

@viduni94, do you think we should address this in this PR? We are planning to make product docs an implementation detail of the knowledge base (#225580), so this won't be necessary.

I feel like we should address it. Even though we are planning to change the implementation later, because until that is released the user would have a confusing experience right? Is it a complex fix?

What happens if the user clicks install again when the product docs are being installed in the background? Does it restart it? Or does it start another task to install?

I feel the best option is to show the correct UI state if possible.

arturoliduena · 2025-07-10T06:06:53Z

I feel like we should address it. Even though we are planning to change the implementation later, because until that is released the user would have a confusing experience right? Is it a complex fix?

agree with you @viduni94, I just pushed the changes to address this

…ation-status

viduni94 · 2025-07-10T17:45:14Z

...ervability_ai_assistant_management/public/routes/components/settings_tab/change_kb_model.tsx

@@ -144,6 +146,9 @@ export function ChangeKbModel({ knowledgeBase }: { knowledgeBase: UseKnowledgeBa
          knowledgeBase.warmupModel(selectedInferenceId);
        } else {
          knowledgeBase.install(selectedInferenceId);
+          installProductDoc(selectedInferenceId).then(() => {


This makes the product doc install with the KB (even when the KB is being installed for the first time)
I saw you've created an issue to do this anyway, but was it intentional to include that behaviour in this PR?

The idea of [Obs AI Assistant] Unify product docs installation with KB installation is to move the installation of product docs to the KB installation flow, unlike now, where we have to call 2 different endpoints and handle them as different actions.

Do you think we shouldn't install product docs when users install KB for the first time? We can add it later in the unification. I don't have a strong preference. What do you think?

good that we will do this, but A) let's do it server-side, B) make sure the UX is updated to reflect the fact that the "knowledge base" as a feature includes product docs.

Yes, @dgieselaar, we will do it server-side. A and B are considered in [Obs AI Assistant] Make product docs an implementation detail of the knowledge base ticket.

ok, so we'll move it out of this PR?

Agree with @dgieselaar

was it intentional to include that behaviour in this PR

I asked this because the UX seemed a little confusing because the product doc button's status changes when the user performs an action on the KB model for the first time here. And when we are coupling the implementation as part of #227475 we should make it clear in the UX.

It was intentional to include it here, but I agree that the UX isn't clear. Let's remove this and implement it right as part of #227475, thanks @viduni94 and @dgieselaar

dgieselaar · 2025-07-11T06:48:36Z

...vability_ai_assistant_management/public/routes/components/settings_tab/product_doc_entry.tsx

+        setInstalling(true);
+        setInstalled(false);
+      } else if (status.overall === 'installed') {
+        setInstalling(false);
+        setInstalled(true);
+      } else if (status.overall === 'uninstalled') {
+        setInstalling(false);
+        setInstalled(false);


This looks odd?

horrible TBH, do you think there is a better solution at the moment? I didn't want to introduce a new hook (useProductDoc). combining useGetProductDocStatus, useInstallProductDoc, and useUninstallProductDoc. Could this be better?

This whole file is weird (I know that's not you). We have isInstalling, isInstalled, isStatusLoading. I would expect something like this in terms of state management:

installStatusFetch (inferenceEndpointId) { loading: boolean, installStatus: 'notInstalled' | 'installing' | 'installed' | 'failed' }

and everything to be managed via one hook. e.g. useGetProductStatus needs to know when the product docs have been uninstalled or installed. So you'd have something like useProductDocs(knowledgeBase.inferenceEndpointId).

Thanks, @dgieselaar, for the suggestion. I have changed useGetProductStatus to useProductDocs and handled the status there. It is clearer

…nstalled for the first time

…ation-status

viduni94

Just making a note here about a behaviour I noticed.

When I switch models from ELSER --> e5 --> ELSER, we get a notification immediately saying product docs are successfully installed. It's a confusing UX experience because when updating the model we don't mention that we are updating product docs as well.

But I think it's okay for now since we are planning to improve this experience by coupling product docs with KB. (cc: @isaclfreire )

Screen.Recording.2025-07-14.at.1.56.22.PM.mov

…ation-status

elasticmachine · 2025-07-15T08:41:05Z

💚 Build Succeeded

Buildkite Build
Commit: 70f32df
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-226919-70f32dfe577a

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`observabilityAiAssistantManagement`	97.8KB	97.8KB	-19.0B

History

💔 Build #319063 failed b45ff32
💚 Build #319024 succeeded 4d59c90
💛 Build #318967 was flaky cb2b080
💚 Build #318455 succeeded 4051d13
💚 Build #318221 succeeded 71dccba

kibanamachine · 2025-07-15T11:51:46Z

Starting backport for target branches: 8.19, 9.1

https://github.com/elastic/kibana/actions/runs/16292475408

Closes [226914](elastic#226914) ## Summary After switching the KB model, product documentation was not automatically installed, even if it had been installed previously. The user must reload the page to view the current installation status of the product documentation. https://github.com/user-attachments/assets/a60a98e2-30a3-4253-b423-366fe00f1845 --------- Co-authored-by: Viduni Wickramarachchi <[email protected]> (cherry picked from commit 28e765c)

kibanamachine · 2025-07-15T11:58:57Z

💔 Some backports could not be created

Status	Branch	Result
❌	8.19	Backport failed because of merge conflicts You might need to backport the following PRs to 8.19: - [ska] relocate dataset quality api-integration tests (#227826) - Fixes FIPS test skips in ML Disabled suite (#227677) - [ResponseOps][Cases] Skip the execution of the CAI tasks when the feature is disabled (#227860) - [Security Solution] [AI assistant] Fix bug with assistant visibility introduced by global security AI assistant (#227877) - [Explore][Entity Analytics] - Transfer explore pages ownership (#227911) - [ResponseOps][Rules] Floating help icon should be aligned to column title (#226946) - [ska] relocate fleet api integration tests (#227769) - [Synthetics] Fixed EnableDefaultAlerting test (#227779) - [Alerts table] Unskipped pagination test (#227486) - [Investigations][DataViews] - Remove non-performant toSpec usage (#225726)
✅	9.1

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

node scripts/backport --pr 226919

Questions ?

Please refer to the Backport tool documentation

# Backport This will backport the following commits from `main` to `9.1`: - [fix: product docs installation status (#226919)](#226919)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)  Co-authored-by: Arturo Lidueña <[email protected]> Co-authored-by: Viduni Wickramarachchi <[email protected]>

arturoliduena · 2025-07-16T07:49:26Z

💚 All backports created successfully

Status	Branch	Result
✅	8.19

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

Closes [226914](elastic#226914) ## Summary After switching the KB model, product documentation was not automatically installed, even if it had been installed previously. The user must reload the page to view the current installation status of the product documentation. https://github.com/user-attachments/assets/a60a98e2-30a3-4253-b423-366fe00f1845 --------- Co-authored-by: Viduni Wickramarachchi <[email protected]> (cherry picked from commit 28e765c) # Conflicts: # x-pack/platform/plugins/private/observability_ai_assistant_management/public/hooks/use_get_product_doc_status.ts # x-pack/solutions/observability/plugins/observability_ai_assistant_management/public/hooks/use_get_product_doc.ts # x-pack/solutions/observability/plugins/observability_ai_assistant_management/public/hooks/use_get_product_doc_status.ts

# Backport This will backport the following commits from `main` to `8.19`: - [fix: product docs installation status (#226919)](#226919)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)

fix: product docs installation status

3b7d4bd

arturoliduena requested a review from a team as a code owner July 8, 2025 06:56

botelastic bot added the ci:project-deploy-observability Create an Observability project label Jul 8, 2025

arturoliduena added backport:version Backport to applied version labels release_note:fix v9.1.0 v8.19.0 Team:Obs AI Assistant Observability AI Assistant labels Jul 8, 2025

viduni94 reviewed Jul 8, 2025

View reviewed changes

fix: enhance product document installation status handling

e49a6d4

Merge branch 'main' into obs-ai-assistant-226914-product-docs-install…

8eae2d6

…ation-status

viduni94 reviewed Jul 10, 2025

View reviewed changes

dgieselaar reviewed Jul 11, 2025

View reviewed changes

dgieselaar mentioned this pull request Jul 11, 2025

[AI Infra] Fix Observability AI assistant product docs missing multilingual support #224274

Merged

9 tasks

arturoliduena and others added 3 commits July 11, 2025 15:02

remove product document automatically installation when KB is being i…

71dccba

…nstalled for the first time

update product docs status hook

4051d13

Merge branch 'main' into obs-ai-assistant-226914-product-docs-install…

cb2b080

…ation-status

viduni94 approved these changes Jul 14, 2025

View reviewed changes

viduni94 and others added 3 commits July 14, 2025 16:39

Merge branch 'main' into obs-ai-assistant-226914-product-docs-install…

4d59c90

…ation-status

Merge branch 'main' into obs-ai-assistant-226914-product-docs-install…

b45ff32

…ation-status

Merge branch 'main' into obs-ai-assistant-226914-product-docs-install…

70f32df

…ation-status

arturoliduena merged commit 28e765c into elastic:main Jul 15, 2025
11 of 12 checks passed

kibanamachine added the v9.2.0 label Jul 15, 2025

kibanamachine mentioned this pull request Jul 15, 2025

[9.1] fix: product docs installation status (#226919) #227992

Merged

kibanamachine mentioned this pull request Jul 15, 2025

[Synthetics] Fix for metric_item component #227969

Merged

kibanamachine mentioned this pull request Jul 16, 2025

[ES|QL] Fixes wrong validation on expressions between aggregations #227989

Merged

1 task

arturoliduena mentioned this pull request Jul 16, 2025

[8.19] fix: product docs installation status (#226919) #228144

Merged

arturoliduena mentioned this pull request Jul 16, 2025

[Obs AI Assistant] Upgrade testing for product docs with E5 #226524

Closed

fix: product docs installation status #226919

fix: product docs installation status #226919

Conversation

arturoliduena commented Jul 8, 2025 • edited by kibanamachine Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

github-actions bot commented Jul 8, 2025

🤖 GitHub comments

Uh oh!

elasticmachine commented Jul 8, 2025

Uh oh!

viduni94 commented Jul 8, 2025

Uh oh!

viduni94 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

arturoliduena commented Jul 9, 2025

Uh oh!

arturoliduena commented Jul 9, 2025

Uh oh!

viduni94 commented Jul 9, 2025

Uh oh!

arturoliduena commented Jul 10, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

viduni94 left a comment

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💚 Build Succeeded

Metrics [docs]

Async chunks

History

Uh oh!

Uh oh!

kibanamachine commented Jul 15, 2025

Uh oh!

kibanamachine commented Jul 15, 2025

💔 Some backports could not be created

Manual backport

Questions ?

Uh oh!

arturoliduena commented Jul 16, 2025

💚 All backports created successfully

Questions ?

Uh oh!

Uh oh!

arturoliduena commented Jul 8, 2025 •

edited by kibanamachine

Loading

viduni94 left a comment •

edited

Loading

elasticmachine commented Jul 15, 2025 •

edited

Loading