[Inventory] Inventory plugin #191798

dgieselaar · 2024-08-30T06:36:46Z

Description

This PR adds an inventory plugin, which renders an inventory UI. Currently only data streams are rendered. This is part of the LogsAI initiative - basically we need a UI for tasks like structuring data, extracting entities, listing the results etc. This is mostly POC-level stuff. Eventually some of this code might be handed over to ECO but let's cross that bridge when we get to it.

Notes for reviewers:

@elastic/appex-ai-infra @elastic/security-generative-ai: added a truncateList utility function that takes the first n elements of an array and appends a {l-n} more string value if there are more values than n. Really simple but I expect will also be very often used because we cannot send a huge amount of items to the LLM.

@elastic/kibana-core @elastic/kibana-operations: just boiler plate stuff for adding a new plugin (and thank you for enabling us to run quick_checks locally!

@elastic/obs-knowledge-team: added support for streaming using an Observable.

@elastic/obs-ux-management-team: added links to the Inventory UI in the Observability plugin

@elastic/obs-entities: I've added an entity manager client to be able to fetch entity definitions on the server. Maybe there's a better way? LMK.

@elastic/obs-ux-logs-team: added a deeplink to the Inventory UI. I've also moved CODEOWNERS for this package to @elastic/obs-ux-management-team as they own the Observability plugin where this is mostly used.

obltmachine · 2024-08-30T06:37:04Z

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

shahzad31 · 2024-08-30T08:16:12Z

.github/CODEOWNERS

@@ -362,7 +362,7 @@ packages/deeplinks/devtools @elastic/kibana-management
 packages/deeplinks/fleet @elastic/fleet
 packages/deeplinks/management @elastic/kibana-management
 packages/deeplinks/ml @elastic/ml-ui
-packages/deeplinks/observability @elastic/obs-ux-logs-team
+packages/deeplinks/observability @elastic/obs-ux-management


Suggested change

packages/deeplinks/observability @elastic/obs-ux-management

packages/deeplinks/observability @elastic/obs-ux-management-team

shahzad31 · 2024-08-30T08:18:53Z

x-pack/plugins/observability_solution/observability/public/plugin.ts

@@ -421,6 +436,7 @@ export class Plugin
                  sortKey: 100,
                  entries: [
                    ...overviewLink,
+                    ...inventoryLink,


since this is POC, should this be behind feature flag?

the plugin itself is disabled by default, I don't want this to leak to the UI anywhere to regular users so I haven't used an advanced setting or anything

packages/kbn-server-route-repository-utils/src/typings.ts

packages/kbn-server-route-repository/src/test_types.ts

x-pack/plugins/observability_solution/entity_manager/server/lib/client/index.ts

x-pack/plugins/observability_solution/inventory/public/api/index.tsx

x-pack/plugins/observability_solution/inventory/server/routes/types.ts

x-pack/plugins/observability_solution/inventory/server/routes/entities/route.ts

…inventory-plugin

…-fix'

kpatticha

LGTM 🥳

PTO

TinaHeiligers · 2024-09-11T06:11:13Z

x-pack/plugins/observability_solution/inventory/README.md

Nothing in here, not even a one-liner??

I will add a one-liner!

TinaHeiligers

Add something to the README, even if it's a one liner. Remember that our code is open, in a public repo, everyone needs to know what a plugin does.

kibana-ci · 2024-09-11T07:52:18Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 62e3ed0
Storybooks Preview
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-191798-62e3ed025e50

Failed CI Steps

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`entityManager`	15	23	+8
`inventory`	-	125	+125
`observabilityAIAssistant`	91	104	+13
total			+146

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/server-route-repository`	38	42	+4
`@kbn/server-route-repository-client`	9	15	+6
`@kbn/server-route-repository-utils`	26	30	+4
`@kbn/sse-utils`	-	19	+19
`@kbn/sse-utils-client`	-	1	+1
`@kbn/sse-utils-server`	-	2	+2
`entityManager`	17	20	+3
`inference`	39	44	+5
`inventory`	-	5	+5
`observability`	696	698	+2
total			+51

Async chunks

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

id	before	after	diff
`apm`	3.5MB	3.5MB	+90.0B
`inventory`	-	48.5KB	+48.5KB
`observability`	463.5KB	463.7KB	+225.0B
total			+48.8KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`@kbn/server-route-repository-utils`	0	2	+2
`@kbn/sse-utils`	-	3	+3
`@kbn/sse-utils-client`	-	1	+1
`apm`	118	119	+1
`entityManager`	2	3	+1
`inference`	13	12	-1
`inventory`	-	3	+3
total			+10

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`entityManager`	4.1KB	6.8KB	+2.7KB
`inference`	5.6KB	5.7KB	+68.0B
`inventory`	-	14.5KB	+14.5KB
`observability`	102.6KB	102.9KB	+242.0B
`observabilityAIAssistant`	43.4KB	46.0KB	+2.6KB
total			+20.1KB

Unknown metric groups

API count

id	before	after	diff
`@kbn/server-route-repository`	38	42	+4
`@kbn/server-route-repository-client`	9	15	+6
`@kbn/server-route-repository-utils`	26	30	+4
`@kbn/sse-utils`	-	19	+19
`@kbn/sse-utils-client`	-	1	+1
`@kbn/sse-utils-server`	-	2	+2
`entityManager`	17	20	+3
`inference`	41	49	+8
`inventory`	-	5	+5
`observability`	703	705	+2
total			+54

async chunk count

id	before	after	diff
`inventory`	-	1	+1

ESLint disabled in files

id	before	after	diff
`inventory`	-	2	+2

ESLint disabled line counts

id	before	after	diff
`entityManager`	1	2	+1

Total ESLint disabled count

id	before	after	diff
`entityManager`	1	2	+1
`inventory`	-	2	+2
total			+3

History

💛 Build #233308 was flaky 6370430
💔 Build #233237 failed 4670089
💔 Build #233220 failed 0238a8c
💔 Build #232978 failed 0b94e16
💔 Build #232721 failed ae4e035

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

cc @kpatticha

TinaHeiligers

LGTM

mykolaharmash

Onboarding change LGTM

dgieselaar added 3 commits August 29, 2024 18:52

[Inventory] Inventory plugin

eb7569e

Extract datasets

570f78d

Disable inventory plugin by default

f5727e8

dgieselaar added 3 commits August 30, 2024 09:25

Fix types

88cefe5

Disable by default

e53b3b3

Fix lint errors & CODEOWNERS

fe471af

dgieselaar marked this pull request as ready for review August 30, 2024 08:05

dgieselaar requested review from a team as code owners August 30, 2024 08:05

Update codeowners via kibana.jsonc

bc0b98c

botelastic bot added ci:project-deploy-observability Create an Observability project Team:obs-ux-management Observability Management User Experience Team labels Aug 30, 2024

Use right team

f49bdac

shahzad31 reviewed Aug 30, 2024

View reviewed changes

Add limits

4336608

dgieselaar added release_note:skip Skip the PR/issue when compiling release notes v8.16.0 labels Aug 30, 2024

miltonhultgren reviewed Aug 30, 2024

View reviewed changes

jbudz approved these changes Aug 30, 2024

View reviewed changes

Separate repository client in fetch/stream

e4bb64d

dgieselaar requested a review from a team as a code owner August 30, 2024 13:14

dgieselaar and others added 3 commits September 9, 2024 11:03

Merge branch 'inventory-plugin' of github.com:dgieselaar/kibana into …

2c39d89

…inventory-plugin

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

70b0742

…-fix'

Resolve merge conflict correctly

ae4e035

kpatticha approved these changes Sep 9, 2024

View reviewed changes

dgieselaar added 2 commits September 10, 2024 10:44

Fix tests

0b94e16

Fix type issues in routes

0238a8c

dgieselaar added 3 commits September 10, 2024 21:52

Allow primitives as return types

87b8924

Merge branch 'main' of github.com:elastic/kibana into inventory-plugin

4670089

Allow any as a value

6370430

TinaHeiligers reviewed Sep 11, 2024

View reviewed changes

dgieselaar and others added 2 commits September 11, 2024 08:50

Update README.md

a039dae

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

62e3ed0

TinaHeiligers approved these changes Sep 11, 2024

View reviewed changes

stephmilovic approved these changes Sep 11, 2024

View reviewed changes

mykolaharmash approved these changes Sep 12, 2024

View reviewed changes

dgieselaar removed the request for review from afharo September 12, 2024 10:48

dgieselaar enabled auto-merge (squash) September 12, 2024 10:48

dgieselaar requested review from miltonhultgren and shahzad31 September 12, 2024 10:49

shahzad31 approved these changes Sep 12, 2024

View reviewed changes

miltonhultgren approved these changes Sep 12, 2024

View reviewed changes

dgieselaar merged commit 98aa1ab into elastic:main Sep 12, 2024
46 checks passed

kibanamachine added the backport:skip This commit does not require backporting label Sep 12, 2024

szaffarano mentioned this pull request Sep 13, 2024

[Telemetry][Security Solution] Fix integration tests on branch 9.0 #192842

Merged

1 task

cauemarcondes mentioned this pull request Sep 20, 2024

[Inventory][ECO] Create header action menu #193398

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Inventory] Inventory plugin #191798

[Inventory] Inventory plugin #191798

dgieselaar commented Aug 30, 2024 •

edited

Loading

obltmachine commented Aug 30, 2024

shahzad31 Aug 30, 2024

dgieselaar Aug 30, 2024

shahzad31 Aug 30, 2024

dgieselaar Aug 30, 2024

kpatticha left a comment

TinaHeiligers Sep 11, 2024

dgieselaar Sep 11, 2024

TinaHeiligers left a comment

kibana-ci commented Sep 11, 2024 •

edited

Loading

API count

async chunk count

ESLint disabled in files

ESLint disabled line counts

Total ESLint disabled count

TinaHeiligers left a comment

mykolaharmash left a comment

	packages/deeplinks/observability @elastic/obs-ux-management
	packages/deeplinks/observability @elastic/obs-ux-management-team

[Inventory] Inventory plugin #191798

[Inventory] Inventory plugin #191798

Conversation

dgieselaar commented Aug 30, 2024 • edited Loading

Description

Notes for reviewers:

obltmachine commented Aug 30, 2024

🤖 GitHub comments

shahzad31 Aug 30, 2024

Choose a reason for hiding this comment

dgieselaar Aug 30, 2024

Choose a reason for hiding this comment

shahzad31 Aug 30, 2024

Choose a reason for hiding this comment

dgieselaar Aug 30, 2024

Choose a reason for hiding this comment

kpatticha left a comment

Choose a reason for hiding this comment

TinaHeiligers Sep 11, 2024

Choose a reason for hiding this comment

dgieselaar Sep 11, 2024

Choose a reason for hiding this comment

TinaHeiligers left a comment

Choose a reason for hiding this comment

kibana-ci commented Sep 11, 2024 • edited Loading

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Public APIs missing exports

Page load bundle

API count

async chunk count

ESLint disabled in files

ESLint disabled line counts

Total ESLint disabled count

History

TinaHeiligers left a comment

Choose a reason for hiding this comment

mykolaharmash left a comment

Choose a reason for hiding this comment

dgieselaar commented Aug 30, 2024 •

edited

Loading

kibana-ci commented Sep 11, 2024 •

edited

Loading