Add inventory locator #183418

jennypavlova · 2024-05-14T15:28:26Z

Relates to #176667

Summary

This PR adds an inventory locator and replaces the old redirect logic in RedirectToInventory

Testing

To simulate the usage of link-to use similar params to what alerts link is using, for example:
/app/metrics/link-to/inventory?customMetric=&metric=(type%3Acpu)&nodeType=pod&timestamp=1715703274459
Compare the pages with the edge cluster to make sure that it looks the same as before

apmmachine · 2024-05-14T15:28:41Z

🤖 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 · 2024-05-14T16:21:54Z

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

jennypavlova · 2024-05-14T16:47:28Z

/ci

crespocarlos

Thanks for this PR. I haven't tested it yet.

crespocarlos · 2024-05-15T15:58:51Z

x-pack/plugins/observability_solution/infra/public/pages/link_to/redirect_to_inventory.tsx

-import { Redirect, RouteComponentProps } from 'react-router-dom';
-
-// FIXME what would be the right way to build this query string?
-const QUERY_STRING_TEMPLATE =


crespocarlos · 2024-05-15T16:04:36Z

...ugins/observability_solution/observability_shared/public/locators/infra/inventory_locator.ts

+ return {
+ app: 'metrics',
+ path: `/inventory?waffleFilter=${paramsWithDefaults.waffleFilter}&waffleTime=${paramsWithDefaults.waffleTime}&waffleOptions=${paramsWithDefaults.waffleOptions}&customMetrics=${paramsWithDefaults.customMetrics}&customOptions=${paramsWithDefaults.customOptions}&groupBy=${paramsWithDefaults.groupBy}&legend=${paramsWithDefaults.legend}&metric=${paramsWithDefaults.metric}&nodeType=${paramsWithDefaults.nodeType}&region=${paramsWithDefaults.region}&sort=${paramsWithDefaults.sort}&timelineOpen=${paramsWithDefaults.timelineOpen}&view=${paramsWithDefaults.view}`,
+ state: params.state ? params.state : {},
+ };


would this work?

Suggested change

return {

app: 'metrics',

path: `/inventory?waffleFilter=${paramsWithDefaults.waffleFilter}&waffleTime=${paramsWithDefaults.waffleTime}&waffleOptions=${paramsWithDefaults.waffleOptions}&customMetrics=${paramsWithDefaults.customMetrics}&customOptions=${paramsWithDefaults.customOptions}&groupBy=${paramsWithDefaults.groupBy}&legend=${paramsWithDefaults.legend}&metric=${paramsWithDefaults.metric}&nodeType=${paramsWithDefaults.nodeType}&region=${paramsWithDefaults.region}&sort=${paramsWithDefaults.sort}&timelineOpen=${paramsWithDefaults.timelineOpen}&view=${paramsWithDefaults.view}`,

state: params.state ? params.state : {},

};

const queryStringParams = queryString.stringify(paramsWithDefaults);

return {

app: 'metrics',

path: `/inventory?${queryStringParams}`,

state: params.state ? params.state : {},

};

Good idea, thanks 👍 I started with just 3 params then decided to support more in case we need them 😅

crespocarlos · 2024-05-15T16:08:39Z

...k/plugins/observability_solution/observability_shared/public/locators/infra/locators.test.ts

+ const waffleFilter = rison.encodeUnknown(params.waffleFilter);
+ const waffleTime = rison.encodeUnknown(params.waffleTime);
+ const waffleOptions = rison.encodeUnknown(params.waffleOptions);
+ const customMetrics = rison.encodeUnknown(params.customMetrics);
+ const customOptions = rison.encodeUnknown(params.customOptions);
+ const groupBy = rison.encodeUnknown(params.groupBy);
+ const legend = rison.encodeUnknown(params.legend);
+ const metric = params.metric;
+ const nodeType = rison.encodeUnknown(params.nodeType);
+ const region = rison.encodeUnknown(params.region);
+ const sort = rison.encodeUnknown(params.sort);
+ const timelineOpen = rison.encodeUnknown(params.timelineOpen);
+ const view = rison.encodeUnknown(params.view);


Suggested change

const waffleFilter = rison.encodeUnknown(params.waffleFilter);

const waffleTime = rison.encodeUnknown(params.waffleTime);

const waffleOptions = rison.encodeUnknown(params.waffleOptions);

const customMetrics = rison.encodeUnknown(params.customMetrics);

const customOptions = rison.encodeUnknown(params.customOptions);

const groupBy = rison.encodeUnknown(params.groupBy);

const legend = rison.encodeUnknown(params.legend);

const metric = params.metric;

const nodeType = rison.encodeUnknown(params.nodeType);

const region = rison.encodeUnknown(params.region);

const sort = rison.encodeUnknown(params.sort);

const timelineOpen = rison.encodeUnknown(params.timelineOpen);

const view = rison.encodeUnknown(params.view);

const expected = Object.keys(params).reduce((acc, key) => {

acc[key] = key === 'metric' ? params[key] : rison.encodeUnknown(params[key]);

return acc;

}, {});

Yeah, it makes sense, fixed! Sorry about those I was testing with different things and with/without encoding and forgot to remove and fix that.

crespocarlos · 2024-05-15T16:09:39Z

...k/plugins/observability_solution/observability_shared/public/locators/infra/locators.test.ts

+
+ expect(app).toBe('metrics');
+ expect(path).toBe(
+ `/inventory?waffleFilter=${waffleFilter}&waffleTime=${waffleTime}&waffleOptions=${waffleOptions}&customMetrics=${customMetrics}&customOptions=${customOptions}&groupBy=${groupBy}&legend=${legend}&metric=${metric}&nodeType=${nodeType}&region=${region}&sort=${sort}&timelineOpen=${timelineOpen}&view=${view}`


I think it should also work here

Suggested change

`/inventory?waffleFilter=${waffleFilter}&waffleTime=${waffleTime}&waffleOptions=${waffleOptions}&customMetrics=${customMetrics}&customOptions=${customOptions}&groupBy=${groupBy}&legend=${legend}&metric=${metric}&nodeType=${nodeType}&region=${region}&sort=${sort}&timelineOpen=${timelineOpen}&view=${view}`

`/inventory?queryString.stringify(expected);`

crespocarlos · 2024-05-15T16:09:49Z

...k/plugins/observability_solution/observability_shared/public/locators/infra/locators.test.ts

+
+ expect(app).toBe('metrics');
+ expect(path).toBe(
+ `/inventory?waffleFilter=${waffleFilter}&waffleTime=${waffleTime}&waffleOptions=${waffleOptions}&customMetrics=${customMetrics}&customOptions=${customOptions}&groupBy=${groupBy}&legend=${legend}&metric=${metric}&nodeType=${nodeType}&region=${region}&sort=${sort}&timelineOpen=${timelineOpen}&view=${view}`


crespocarlos · 2024-05-15T16:10:44Z

...ugins/observability_solution/observability_shared/public/locators/infra/inventory_locator.ts

+ customMetrics: params.customMetrics || rison.encodeUnknown(''),
+ customOptions: params.customOptions || rison.encodeUnknown(''),


Why is needed rison.encodeUnknown('') needed?

It adds '' (so &customMetrics=''&customOptions='') in the URL otherwise 🤷‍♀️ I think I can just leave the customMetrics: params.customMetrics to avoid that

jennypavlova · 2024-05-16T16:10:36Z

@crespocarlos Thank you for the review! I think I fixed the things you mentioned, thanks for the suggestions. Can you please check it again?

crespocarlos

LGTM! Thanks for the changes.

kibana-ci · 2024-05-17T10:39:59Z

💚 Build Succeeded

Buildkite Build
Commit: 21a1cf0
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-183418-21a1cf0ed7b1
Observability Deployment

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`observabilityShared`	199	203	+4

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
`observabilityShared`	349	350	+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	-348.0B
`observabilityShared`	54.9KB	54.9KB	+4.0B
total			-344.0B

Canvas Sharable Runtime

The Canvas "shareable runtime" is an bundle produced to enable running Canvas workpads outside of Kibana. This bundle is included in third-party webpages that embed canvas and therefor should be as slim as possible.

id	before	after	diff
`module count`	-	5405	+5405
`total size`	-	8.8MB	+8.8MB

Page load bundle

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

id	before	after	diff
`infra`	105.1KB	105.1KB	-2.0B
`observabilityShared`	64.6KB	67.4KB	+2.8KB
total			+2.8KB

Unknown metric groups

API count

id	before	after	diff
`observabilityShared`	354	355	+1

History

💔 Build #210551 failed 4ab66b1
💚 Build #209930 succeeded 91d6ecf

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

cc @jennypavlova

jennypavlova added 3 commits May 14, 2024 14:18

Add inventory locator

be071f0

Add inventory locator test

d8a6ef9

Update and use inventory locator in link-to redirect

647f7ed

jennypavlova self-assigned this May 14, 2024

Merge branch 'main' into 176667-add-inventory-locator

397ee00

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

Merge branch 'main' into 176667-add-inventory-locator

91d6ecf

jennypavlova marked this pull request as ready for review May 14, 2024 16:21

jennypavlova requested review from a team as code owners May 14, 2024 16:21

jennypavlova mentioned this pull request May 14, 2024

[Infra] Register Kibana locator to link to Infra's Asset Details and Inventory UIs #176667

Closed

crespocarlos reviewed May 15, 2024

View reviewed changes

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

jennypavlova added 2 commits May 16, 2024 17:51

Merge branch 'main' into 176667-add-inventory-locator

26b7c86

CR Changes

4ab66b1

jennypavlova requested a review from crespocarlos May 16, 2024 16:09

crespocarlos approved these changes May 16, 2024

View reviewed changes

jennypavlova added 2 commits May 17, 2024 11:42

Fix type issue

40cd838

Merge branch 'main' into 176667-add-inventory-locator

21a1cf0

jennypavlova enabled auto-merge (squash) May 17, 2024 10:51

jennypavlova merged commit 85639f6 into elastic:main May 17, 2024
20 checks passed

kibanamachine added the v8.15.0 label May 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add inventory locator #183418

Add inventory locator #183418

jennypavlova commented May 14, 2024 •

edited

Loading

apmmachine commented May 14, 2024

elasticmachine commented May 14, 2024

jennypavlova commented May 14, 2024

crespocarlos left a comment

crespocarlos May 15, 2024

crespocarlos May 15, 2024

jennypavlova May 16, 2024

crespocarlos May 15, 2024

jennypavlova May 16, 2024

crespocarlos May 15, 2024

crespocarlos May 15, 2024

crespocarlos May 15, 2024

jennypavlova May 16, 2024

jennypavlova commented May 16, 2024

crespocarlos left a comment

kibana-ci commented May 17, 2024 •

edited

Loading

API count

	`/inventory?waffleFilter=${waffleFilter}&waffleTime=${waffleTime}&waffleOptions=${waffleOptions}&customMetrics=${customMetrics}&customOptions=${customOptions}&groupBy=${groupBy}&legend=${legend}&metric=${metric}&nodeType=${nodeType}&region=${region}&sort=${sort}&timelineOpen=${timelineOpen}&view=${view}`
	`/inventory?queryString.stringify(expected);`

		customMetrics: params.customMetrics \|\| rison.encodeUnknown(''),
		customOptions: params.customOptions \|\| rison.encodeUnknown(''),

Add inventory locator #183418

Add inventory locator #183418

Conversation

jennypavlova commented May 14, 2024 • edited Loading

Summary

Testing

apmmachine commented May 14, 2024

🤖 GitHub comments

elasticmachine commented May 14, 2024

jennypavlova commented May 14, 2024

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

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

jennypavlova commented May 16, 2024

crespocarlos left a comment

Choose a reason for hiding this comment

kibana-ci commented May 17, 2024 • edited Loading

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Canvas Sharable Runtime

Page load bundle

API count

History

jennypavlova commented May 14, 2024 •

edited

Loading

kibana-ci commented May 17, 2024 •

edited

Loading