[ECO][Inventory] Redirect ECS k8s entities to dashboards #197222

crespocarlos · 2024-10-22T12:06:20Z

closes #196142

Summary

Links kubernetes ECS entities to their corresponding dashboards

Important

ECS replicaset doesn't have a dedicated dashboard. container will be handled in a separate ticket
Semconv won't link to any dashboard/page

How to test

While [EEM] Add built in definitions for core Kubernetes entities #196916 is not merged, change ENTITIES_LATEST_ALIAS constant to '.entities.v1.latest*'
Start a local kibana and es instances
Run node scripts/synthtrace k8s_entities.ts --live --clean
Run PUT kbn:/internal/entities/managed/enablement on the devtools
Install the kubernetes integration package to have the dashboards installed.
Navigate to Inventory and click through the k8s entities

crespocarlos · 2024-10-25T16:23:02Z

x-pack/plugins/observability_solution/inventory/common/utils/unflatten_entity.ts

+import { unflattenObject } from '@kbn/observability-utils/object/unflatten_object';
+import type { Entity, InventoryEntityLatest } from '../entities';
+
+export function unflattenEntity(entity: Entity) {


Temp util Entity is not replaced by InventoryEntityLatest

crespocarlos · 2024-10-28T08:21:05Z

/ci

elasticmachine · 2024-10-28T10:39:25Z

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

crespocarlos · 2024-10-28T11:26:45Z

@elasticmachine merge upstream

crespocarlos · 2024-10-30T13:12:03Z

@elasticmachine merge upstream

…-ecs-k8s-entities

kpatticha

will continue the review

x-pack/packages/observability/observability_utils/es/utils/esql_result_to_plain_objects.ts

x-pack/plugins/observability_solution/inventory/common/entities.ts

x-pack/plugins/observability_solution/inventory/public/components/alerts_badge/alerts_badge.tsx

kpatticha · 2024-10-31T11:47:10Z

x-pack/plugins/observability_solution/inventory/public/hooks/use_detail_view_redirect.ts

+import { unflattenEntity } from '../../common/utils/unflatten_entity';
+import { useKibana } from './use_kibana';
+
+const KUBERNETES_DASHBOARDS_IDS: Record<string, string> = {


This approach won't work for other spaces. As the integration package installs the dashboards for the default one (if I'm not mistaken).

Good point. It won't indeed. I think users will have to do this . @roshan-elastic , since we're delegating to the dashboards page the responsibility for checking the existence of a dashboard, should we check with them if they can create better messaging for troubleshooting?

Hey @crespocarlos @kpatticha good thought.

We can go ahead with our part and I'll mention to @teresaalvarezsoler (Dashboards) and @daniela-elastic (Integrations) about whether there might be a more helpful empty state.

To confirm, the problem is:

We'll send a user to a dashboard by ID (e.g. https://edge-oblt.kb.us-west2.gcp.elastic-cloud.com/app/dashboards#/view/adsad)

The dashboard may or may not exist depending on which space a user is in (because integrations install in the default space - not all spaces)

If a user clicks through from a link in our UI to a dashboard and it doesn't exist - they'll hit this page:

We'd like to propose the dashboard empty state should handle 'missing dashboards' potentially a bit more gracefully (e.g. a link to common reasons why it may not show) or maybe there's something better we could do (e.g. pass through a query-string explaining we're expecting the dashboard to exist and have a toast pop up to suggest a more helpful call to action to fix it).

Is that right @crespocarlos?

cc @teresaalvarezsoler @daniela-elastic - we want to send users through to dashboards for some entities within Inventory (we'd start with K8s entities - for which we have dashboards which are packaged in the K8s integration). The problem we believe is that the dashboards only exist for the space you installed the integration in:

FYI - All of this is 'tech preview' so we're not too worried right now

We'd like to propose the dashboard empty state should handle 'missing dashboards' potentially a bit more gracefully (e.g. a link to common reasons why it may not show) or maybe there's something better we could do (e.g. pass through a query-string explaining we're expecting the dashboard to exist and have a toast pop up to suggest a more helpful call to action to fix it).

@roshan-elastic yeah, something like that. If a dashboard id is found on any space, the empty state message could point users to a possible solution to the problem.

cc: @kpatticha

Cool - @teresaalvarezsoler @daniela-elastic - I can mention in our next 1-2-1...more of an FYI for now

crespocarlos · 2024-11-01T13:33:48Z

@elasticmachine merge upstream

kpatticha · 2024-11-01T16:31:32Z

x-pack/plugins/observability_solution/inventory/public/hooks/use_detail_view_redirect.ts

+          return serviceOverviewLocator?.getRedirectUrl({
+            serviceName: identityValue,
+            // service.environemnt is not part of entity.identityFields
+            // we need to manually get its value


IMO, we don't have to pass the environment if it's not part of the identityFields.

The Service Overview expects it though. It's used there to filter the data by environment. If not passed I'm not sure if there will be consequences.

environment is optional it will probably select "ALL" environments.

yes. and if we don't pass it at all, it will always select ALL. Would that be correct?

Yes. We do the same for the service inventory. If a service has more than one environments and the top right selector has All we don't pass the environment

right. just for context, we were already passing the service.environment before this PR. @kpatticha , is the suggestion here to change that and not pass it anymore?

Yes. I suspect we were passing the service.environment cause initially it was part of the identityFields. When we removed it from the entity defintion we didn't update the ui.

kpatticha

LGTM

crespocarlos · 2024-11-04T08:31:01Z

@elasticmachine merge upstream

cauemarcondes

LGTM, some nits.

cauemarcondes · 2024-10-29T10:44:54Z

x-pack/plugins/entity_manager/public/lib/entity_client.test.ts

+    id: '1',
+    display_name: 'entity_name',
+    definition_id: 'entity_definition_id',
+  } as EntityLatest['entity'],


Do you need this typing?

Suggested change

} as EntityLatest['entity'],

},

it is if I omit some properties. This object is there to provide a basic mock for the tests

cauemarcondes · 2024-11-04T09:40:32Z

...ugins/observability_solution/inventory/public/components/entities_grid/entity_name/index.tsx

+      </EuiFlexItem>
+      <EuiFlexItem className="eui-textTruncate">
+        <span className="eui-textTruncate" data-test-subj="entityNameDisplayName">
+          {entity[ENTITY_DISPLAY_NAME]}


Can you do?

Suggested change

{entity[ENTITY_DISPLAY_NAME]}

{entity.display_name}

Currently, no.

I'm finalizing this #198758 and will open a PR as soon as this one is merged.

Ah you created the new type but haven't replaced the old one, right?

https://github.com/elastic/kibana/pull/197222/files#diff-b0d4049f68110aa54f26b9a5eae6026ab496059109de95a1ef27b686651ac1ccR122

Not yet. I created that type to facilitate the call to Entity Client's helper functions. I'll replace the old type on the other PR.

cauemarcondes · 2024-11-04T09:43:47Z

x-pack/plugins/observability_solution/inventory/public/hooks/use_detail_view_redirect.ts

+          return serviceOverviewLocator?.getRedirectUrl({
+            serviceName: identityValue,
+            // service.environemnt is not part of entity.identityFields
+            // we need to manually get its value


environment is optional it will probably select "ALL" environments.

cauemarcondes · 2024-11-04T09:53:56Z

x-pack/plugins/observability_solution/observability_shared/common/entity/entity_types.ts

+  KUBERNETES: {
+    CLUSTER: createKubernetesEntity('cluster'),
+    CONTAINER: createKubernetesEntity('container'),
+    CRONJOB: createKubernetesEntity('cron_job'),
+    DAEMONSET: createKubernetesEntity('daemon_set'),
+    DEPLOYMENT: createKubernetesEntity('deployment'),
+    JOB: createKubernetesEntity('job'),
+    NAMESPACE: createKubernetesEntity('namespace'),
+    NODE: createKubernetesEntity('node'),
+    POD: createKubernetesEntity('pod'),
+    STATEFULSET: createKubernetesEntity('stateful_set'),
+  },


IMHO we should not type these.

This is mostly needed to properly map an entity type with its detail view.

crespocarlos · 2024-11-04T11:08:59Z

@elasticmachine merge upstream

crespocarlos · 2024-11-04T13:46:49Z

@elasticmachine merge upstream

elasticmachine · 2024-11-04T14:48:03Z

⏳ Build in-progress

Buildkite Build
Commit: 201816c
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-197222-201816caf1c3

History

💔 Build #247980 failed fb035c0
💔 Build #247915 failed 64ec351
💚 Build #247767 succeeded c1f63c7
💔 Build #247696 failed 7a5b222
💚 Build #247167 succeeded 5fc933c

kibanamachine · 2024-11-04T16:01:25Z

Starting backport for target branches: 8.x

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

) closes [elastic#196142](elastic#196142) ## Summary Links kubernetes ECS entities to their corresponding dashboards > [!IMPORTANT] > ECS `replicaset` doesn't have a dedicated dashboard. `container` will be handled in a separate ticket > Semconv won't link to any dashboard/page <img width="800" alt="image" src="https://github.com/user-attachments/assets/711dbd28-f0ef-4af0-a658-afe7f1595697"> ![redirect](https://github.com/user-attachments/assets/77d5d2e1-7ec4-40cd-b7d8-419e07e6b760) ### How to test - While elastic#196916 is not merged, change `ENTITIES_LATEST_ALIAS` constant to `'.entities.v1.latest*'` - Start a local kibana and es instances - Run ` node scripts/synthtrace k8s_entities.ts --live --clean ` - Run `PUT kbn:/internal/entities/managed/enablement` on the devtools - Install the kubernetes integration package to have the dashboards installed. - Navigate to `Inventory` and click through the k8s entities --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> (cherry picked from commit 8145cb7)

kibanamachine · 2024-11-04T16:06:25Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

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

Questions ?

Please refer to the Backport tool documentation

…) (#198815) # Backport This will backport the following commits from `main` to `8.x`: - [[ECO][Inventory] Redirect ECS k8s entities to dashboards (#197222)](#197222)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Carlos Crespo <crespocarlos@users.noreply.github.com>

crespocarlos force-pushed the 196142-redirect-ecs-k8s-entities branch 2 times, most recently from f18d706 to 6cb0fe8 Compare October 25, 2024 08:30

crespocarlos added 10 commits October 25, 2024 17:44

Redirect ECS k8s entities to dashboards

31f79b3

Create entity_client functions

e50ed57

Create entity_client functions

023b531

Fix entityLatest flatten object

f7c2dfc

Fix redirection to service overview

d3bf958

Fix redirection to service overview

592039b

Add tests

07a0050

Add tests

9b19596

Refactoring and tests

584a3b2

Clean up

e5929db

crespocarlos force-pushed the 196142-redirect-ecs-k8s-entities branch from 0a09527 to e5929db Compare October 25, 2024 15:45

kibanamachine and others added 2 commits October 25, 2024 15:58

[CI] Auto-commit changed files from 'node scripts/yarn_deduplicate'

6ed10af

fix after rebase

43dcb69

crespocarlos changed the title ~~Redirect ECS k8s entities to dashboards~~ [ECO][Inventory] Redirect ECS k8s entities to dashboards Oct 25, 2024

crespocarlos commented Oct 25, 2024

View reviewed changes

Fix build

72a8c0e

crespocarlos marked this pull request as ready for review October 28, 2024 10:38

crespocarlos requested review from a team as code owners October 28, 2024 10:38

crespocarlos added release_note:skip Skip the PR/issue when compiling release notes backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team labels Oct 28, 2024

Merge branch 'main' into 196142-redirect-ecs-k8s-entities

750eeee

Merge branch 'main' into 196142-redirect-ecs-k8s-entities

fdccc6c

miltonhultgren approved these changes Oct 30, 2024

View reviewed changes

Merge branch 'main' of github.com:elastic/kibana into 196142-redirect…

5fc933c

…-ecs-k8s-entities

kpatticha reviewed Oct 31, 2024

View reviewed changes

Include k8s cluster dashboard redirection

7a5b222

Merge branch 'main' into 196142-redirect-ecs-k8s-entities

c1f63c7

kpatticha reviewed Nov 1, 2024

View reviewed changes

elasticmachine and others added 2 commits November 4, 2024 09:31

Merge branch 'main' into 196142-redirect-ecs-k8s-entities

3875f9b

Clean up

64ec351

cauemarcondes approved these changes Nov 4, 2024

View reviewed changes

Merge branch 'main' into 196142-redirect-ecs-k8s-entities

fb035c0

crespocarlos enabled auto-merge (squash) November 4, 2024 11:09

crespocarlos disabled auto-merge November 4, 2024 12:10

Merge branch 'main' into 196142-redirect-ecs-k8s-entities

201816c

crespocarlos merged commit 8145cb7 into elastic:main Nov 4, 2024
26 checks passed

crespocarlos deleted the 196142-redirect-ecs-k8s-entities branch November 4, 2024 16:01

kibanamachine added the v9.0.0 label Nov 4, 2024

kibanamachine mentioned this pull request Nov 4, 2024

[8.x] [ECO][Inventory] Redirect ECS k8s entities to dashboards (#197222) #198815

Merged

kibanamachine added the v8.17.0 label Nov 4, 2024

[ECO][Inventory] Redirect ECS k8s entities to dashboards #197222

[ECO][Inventory] Redirect ECS k8s entities to dashboards #197222

Conversation

crespocarlos commented Oct 22, 2024 • edited by kibanamachine Loading

Summary

How to test

crespocarlos Oct 25, 2024 • edited Loading

Choose a reason for hiding this comment

crespocarlos commented Oct 28, 2024

elasticmachine commented Oct 28, 2024

crespocarlos commented Oct 28, 2024

crespocarlos commented Oct 30, 2024

kpatticha left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crespocarlos Oct 31, 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 commented Nov 1, 2024

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

Choose a reason for hiding this comment

kpatticha left a comment

Choose a reason for hiding this comment

crespocarlos commented Nov 4, 2024

cauemarcondes 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

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 commented Nov 4, 2024

crespocarlos commented Nov 4, 2024

elasticmachine commented Nov 4, 2024

⏳ Build in-progress

History

kibanamachine commented Nov 4, 2024

kibanamachine commented Nov 4, 2024

💚 All backports created successfully

Questions ?

crespocarlos commented Oct 22, 2024 •

edited by kibanamachine

Loading

crespocarlos Oct 25, 2024 •

edited

Loading

crespocarlos Oct 31, 2024 •

edited

Loading