[Infra] Provide troubleshooting information on the host details page #191104

jennypavlova · 2024-08-22T15:37:48Z

Closes #190523

Summary

This PR provides troubleshooting information in the services section on the host details page.

Testing

Go to the hosts details page / host flyout

using a host without services monitored with system integration
using a host without services not monitored with system integration ( only detected by APM )
icon next to the title (same as the table)

For hosts with services, nothing changes (the service is shown):

…trics

obltmachine · 2024-08-22T15:38:05Z

🤖 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!)

…tion-on-the-host-details-page

jennypavlova · 2024-08-22T15:54:27Z

/ci

elasticmachine · 2024-08-22T16:16:18Z

Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services)

crespocarlos

Thanks for this change!

The only thing that seems to be missing is the? icon next to the host name (first item of the AC).

crespocarlos · 2024-08-23T07:33:22Z

x-pack/plugins/observability_solution/infra/server/routes/metadata/lib/get_metric_metadata.ts

+        monitoredHost: {
+          filter: getFilterByIntegration(SYSTEM_INTEGRATION),
+          aggs: {
+            name: {
+              terms: {
+                field: HOST_NAME_FIELD,
+                size: 1,
+                order: {
+                  _key: 'asc',
+                },
+              },
+            },
+          },
+        },


This endpoint is used for other asset types. We might want to run this agg only if nodeType === 'host'.

Also, perhaps running a query like getHasDataFromSystemIntegration parallel to this query might be faster than this term agg because it early terminates as soon as it finds a document that satisfies the criteria.

I made the aggregation conditional so it will be set only if we have nodeType === 'host' In this query we already filter by node name so it shouldn't be slow I think 🤔 Wdyt? I can also write an extra query again filtered by node name and use it as a boolean flag (if any data is returned or not) but I am not sure if there is a big benefit in this case as you need to query and filter again to get the results as the aggregation is added to an existing query.

Hey! Thanks for adding the condition.

The fact that the query filters by host.name helps, but elasticsearch still needs to collect documents to build the aggregation. getHasDataFromSystemIntegration requires less computation - this function could even be reused.

Another potential downside is if we need to do something similar for other asset types. I'm not sure if adding aggregations to this query will scale nicely.

But it's up to you. We can always revisit this in the future.

Got it, thanks. Yeah, when I think about it it is a good idea - it brings dependency to the infraMetricsClient but I guess that is fine as we can use it in case we have similar queries for different assets.

crespocarlos · 2024-08-23T07:50:17Z

x-pack/plugins/observability_solution/infra/server/routes/metadata/lib/get_metric_metadata.ts


  return {
    id: nodeId,
    name: get(response, ['aggregations', 'nodeName', 'buckets', 0, 'key'], nodeId),
+    hasSystemIntegration,


This attribute kind of makes it harder to extend the same idea to other asset types because this condition is specific to hosts.

For now, I think it's OK because we don't know if the problem we're solving here will happen to other asset types, but I would return this attribute only when nodeType === host. wdyt?

I changed that to be returned only for hosts, thanks for catching that!

crespocarlos · 2024-08-23T07:51:45Z

x-pack/plugins/observability_solution/infra/server/routes/metadata/lib/get_metric_metadata.ts

+  const hostWithSystemIntegration =
+    response.aggregations && (response.aggregations?.monitoredHost?.name?.buckets ?? []).length > 0
+      ? response.aggregations?.monitoredHost?.name.buckets[0]?.key
+      : null;
+
+  const hasSystemIntegration = hostWithSystemIntegration === nodeId;


This could also be done only when nodeType === 'host'

…tion-on-the-host-details-page

crespocarlos

Thanks for adding the missing (?) to the header! Left a couple more comments.

crespocarlos · 2024-08-23T13:08:48Z

x-pack/plugins/observability_solution/infra/public/components/asset_details/template/flyout.tsx

@@ -53,7 +55,7 @@ export const Flyout = ({
      data-component-name={ASSET_DETAILS_FLYOUT_COMPONENT_NAME}
      data-asset-type={asset.type}
    >
-      {loading ? (
+      {loading || metadataLoading ? (


This will block the loading of components in the flyout that doesn't depend on metadata.

blocking_loading_spinner.mov

This is not necessarily part of this PR, but how about removing this InfraLoadingPanel and passing loading and metadataLoading via props to FlyoutHeader? This way we can have a loading spinner that doesn't block the loading rest of the flyout.

For the full page view, we do this

Thanks for spotting that! I changed it to use the loading spinner inside FlyoutHeader like on the page view:

flyout_loading.mov

It looks great now! thanks.

crespocarlos · 2024-08-23T13:10:00Z

x-pack/plugins/observability_solution/infra/server/routes/metadata/lib/get_metric_metadata.ts

+    set(metricQuery, 'body.aggs', {
+      monitoredHost: {
+        filter: getFilterByIntegration(SYSTEM_INTEGRATION),
+        aggs: {
+          name: {
+            terms: {
+              field: HOST_NAME_FIELD,
+              size: 1,
+              order: {
+                _key: 'asc',
+              },
+            },
+          },
+        },
+      },


Q and nit: Do we need lodash for this?

We could do this directly on the metricQuery

Suggested change

set(metricQuery, 'body.aggs', {

monitoredHost: {

filter: getFilterByIntegration(SYSTEM_INTEGRATION),

aggs: {

name: {

terms: {

field: HOST_NAME_FIELD,

size: 1,

order: {

_key: 'asc',

},

},

},

},

},

...(nodeType === 'host'

? {

monitoredHost: {

filter: getFilterByIntegration(SYSTEM_INTEGRATION),

aggs: {

name: {

terms: {

field: HOST_NAME_FIELD,

size: 1,

order: {

_key: 'asc',

},

},

},

},

},

}

: undefined),

I replaced it with a getHasDataFromSystemIntegration as discussed

…tion-on-the-host-details-page

…-host-details-page' of https://github.com/jennypavlova/kibana into 190523-infra-provide-troubleshooting-information-on-the-host-details-page

crespocarlos

LGTM 👏 ! Thanks for the changes!

kibana-ci · 2024-08-23T16:33:09Z

💚 Build Succeeded

Buildkite Build
Commit: ad40529
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-191104-ad4052963450

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`infra`	1575	1576	+1

Async chunks

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

id	before	after	diff
`infra`	1.5MB	1.5MB	+2.3KB

History

💔 Build #229455 failed 30ee7a1
💛 Build #229432 was flaky 5ae2fa6
💔 Build #229219 failed cdfb4f6

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @jennypavlova

…1908) Closes #191579 ### Summary When working on finding the root cause of the bug, another bug related was discovered on the host detected by APM tooltip, it was introduced by this [PR](#191104) when we check for `metadataLoading` to finish, as we don’t do it for the asset details page the loading spinner wasn’t shown there when refreshing the page, but the tooltip shows because is still waiting for the metadata request to finish in order to retrieve the integration. To fix this, we don't apply loading spinner to the asset name, but we do it for the tooltip BEFORE https://github.com/user-attachments/assets/3a946e84-1256-440c-bb65-56df30d8d3a5 AFTER https://github.com/user-attachments/assets/689a6583-c66d-4e96-8605-9cce6c9aff24

jennypavlova added 2 commits August 22, 2024 13:50

Add troubleshooting link to apm services empty message

b533b77

Add troubleshooting message and link for hosts with/without system me…

7613e09

…trics

jennypavlova self-assigned this Aug 22, 2024

jennypavlova added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team labels Aug 22, 2024

Merge branch 'main' into 190523-infra-provide-troubleshooting-informa…

611d6b3

…tion-on-the-host-details-page

Extract the documentation link to a constant

cdfb4f6

jennypavlova marked this pull request as ready for review August 22, 2024 16:16

jennypavlova requested a review from a team as a code owner August 22, 2024 16:16

crespocarlos reviewed Aug 23, 2024

View reviewed changes

botelastic bot added the ci:project-deploy-observability Create an Observability project label Aug 23, 2024

jennypavlova added 4 commits August 23, 2024 12:59

Fix the test type

f37b2c1

Add missing title popover

a56bc7f

Add hasSystemIntegration only for hosts

e7b829e

Merge branch 'main' into 190523-infra-provide-troubleshooting-informa…

5ae2fa6

…tion-on-the-host-details-page

jennypavlova requested a review from crespocarlos August 23, 2024 11:51

Merge branch 'main' into 190523-infra-provide-troubleshooting-informa…

30ee7a1

…tion-on-the-host-details-page

crespocarlos reviewed Aug 23, 2024

View reviewed changes

jennypavlova added 5 commits August 23, 2024 16:44

CR changes

429f136

Fix unit test

ab69314

Merge branch 'main' into 190523-infra-provide-troubleshooting-informa…

bac9b25

…tion-on-the-host-details-page

Add check in the integration test

5a7ac87

Merge branch '190523-infra-provide-troubleshooting-information-on-the…

ad40529

…-host-details-page' of https://github.com/jennypavlova/kibana into 190523-infra-provide-troubleshooting-information-on-the-host-details-page

jennypavlova requested a review from crespocarlos August 23, 2024 15:40

crespocarlos approved these changes Aug 23, 2024

View reviewed changes

jennypavlova enabled auto-merge (squash) August 23, 2024 16:39

jennypavlova merged commit 3628fda into elastic:main Aug 23, 2024
23 checks passed

kibanamachine added the v8.16.0 label Aug 23, 2024

MiriamAparicio mentioned this pull request Sep 2, 2024

[ObsUX][Infra] Fix loading spinner and tooltip for host from APM #191908

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Infra] Provide troubleshooting information on the host details page #191104

[Infra] Provide troubleshooting information on the host details page #191104

jennypavlova commented Aug 22, 2024 •

edited

Loading

obltmachine commented Aug 22, 2024

jennypavlova commented Aug 22, 2024

elasticmachine commented Aug 22, 2024

crespocarlos left a comment

crespocarlos Aug 23, 2024 •

edited

Loading

jennypavlova Aug 23, 2024

crespocarlos Aug 23, 2024 •

edited

Loading

jennypavlova Aug 23, 2024

crespocarlos Aug 23, 2024

jennypavlova Aug 23, 2024

crespocarlos Aug 23, 2024 •

edited

Loading

jennypavlova Aug 23, 2024

crespocarlos left a comment

crespocarlos Aug 23, 2024

jennypavlova Aug 23, 2024

crespocarlos Aug 23, 2024

crespocarlos Aug 23, 2024

jennypavlova Aug 23, 2024

crespocarlos left a comment

kibana-ci commented Aug 23, 2024 •

edited

Loading

[Infra] Provide troubleshooting information on the host details page #191104

[Infra] Provide troubleshooting information on the host details page #191104

Conversation

jennypavlova commented Aug 22, 2024 • edited Loading

Summary

Testing

obltmachine commented Aug 22, 2024

🤖 GitHub comments

jennypavlova commented Aug 22, 2024

elasticmachine commented Aug 22, 2024

crespocarlos left a comment

Choose a reason for hiding this comment

crespocarlos Aug 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crespocarlos Aug 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crespocarlos Aug 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crespocarlos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crespocarlos left a comment

Choose a reason for hiding this comment

kibana-ci commented Aug 23, 2024 • edited Loading

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

History

jennypavlova commented Aug 22, 2024 •

edited

Loading

crespocarlos Aug 23, 2024 •

edited

Loading

crespocarlos Aug 23, 2024 •

edited

Loading

crespocarlos Aug 23, 2024 •

edited

Loading

kibana-ci commented Aug 23, 2024 •

edited

Loading