New slo plugin by mgiota · Pull Request #177937 · elastic/kibana

mgiota · 2024-03-04T14:14:11Z

🍒 Summary

This PR copies the SLO code that was inside the Observability app into its own app under observability-solution/slo folder.

Screen.Recording.2024-03-09.at.00.45.40.mov

✔️ Acceptance criteria

URL of new app: app/slos
Design and functionality are not changed.
Git history has been retained for all files in x-pack/plugins/observability_solution/slo.
SLO should appear on server less
SLO code inside observability_solution/observability code has been removed. A new clean up round might be needed though for possible leftovers.
Burn rate rule is registered within the new slo app
SLO embeddables are moved inside the new slo app
- overview
- alerts embeddable
- error budget burn down
Alerts table configuration registration for slo details page and alerts table embeddable is still done in the observability app. Response Ops team is working on removing the need to register the alert table anyway
Slo app is wrapped into ApplicationUsageTrackingProvider which will send slo Application usage information tracked by the slo appId
Redirect old app/observability/slos route to app/slos
Rename old xpack.observability.slo keys to xpack.slo in the translation files

🌮 How to test

Design and functionality didn't change, so simply navigate to existing slo pages and try to break it

Slo list page
- group by
- unified search
- toggle buttons
- actions
Slo creation
- try group by as well
Slo detail page
- Actions on top
- navigate to overview and alerts tabs
Create SLO flyout in Logs Explorer
Create burn rate rules and verify they appear on rules page
Verify SLO alerts appear on Alerts page and slo details page
Embeddables
- Through the dashboard app
- Using the attach to dashboard action on the slo card item on slo list page and the error budget burn down chart on the slo detail page
SLOs only for platinum users
Permissions
Spaces

TODO

ghost · 2024-03-04T14:14:26Z

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

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

github-actions · 2024-03-04T14:14:29Z

A documentation preview will be available soon.

🔨 Buildkite builds
📚 HTML diff
📙 Preview page

Request a new doc build by commenting

Rebuild this PR: run docs-build
Rebuild this PR and all Elastic docs: run docs-build rebuild

_{run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.}

_{If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.}

mgiota · 2024-03-14T13:55:35Z

@simianhacker I enabled slo on serverless and made it appear in the navigation as well. Let me know if it looks fine

mgiota · 2024-03-14T14:03:34Z

@CoenWarmer Thanks for fixing the redirect issue. How about redirecting to old slo detail page?

This will not work

<SimpleRedirect to="/:sloId" redirectToApp="slo" />;

Update: I can update the SimpleRedirect function to read the url and extract the slo id. Then I can use the extracted id to construct the path in the navigateToApp method call. I was just wondering if there is something out of the box.

simianhacker

LGTM! Good Job!

I filed an issue for the search bar, I noticed it while reviewing your change but then check it was broken on main: #178771

mgiota · 2024-03-14T21:28:39Z

@simianhacker I already have a fix for the issue you created. #178582.

Dosant

x-pack/plugins/serverless_observability/public/navigation_tree.ts lgtm

sebelga

Changes to observability navigation_tree.ts LGTM 👍

mgiota · 2024-03-18T12:29:29Z

@elasticmachine merge upstream

mgiota · 2024-03-18T12:35:29Z

@CoenWarmer regarding handling redirection of the old slo detail and edit pages, here's what I've done and works fine. If you know any other better out of the box solution, just let me know

Screen.Recording.2024-03-18.at.13.30.38.mov

CoenWarmer · 2024-03-18T12:40:46Z

x-pack/plugins/observability_solution/observability/public/routes/routes.tsx

  },
+  [OLD_SLO_DETAIL_PATH]: {
+    handler: () => {
+      return <SimpleRedirect to="/:sloId" redirectToApp="slo" />;


Don't you need something before /:sloId? How does the <SimpleRedirect /> component distinguish between the edit and detail route? The to prop is the same in both cases?

@CoenWarmer I handle both edit and detail routes in this condition, which takes out the /slos part from the url and keeps /edit/1234 or /1234 accordingly:

if (to === '/:sloId') { to = pathname.split('/slos')[1]; }

Initially I added this condition just for the detail path, but then it worked out well for the edit as well. What do you think? I agree not the most elegant way. I am wondering if React router has something out of the box, that you are aware of.

mgiota · 2024-03-18T13:44:46Z

@elasticmachine merge upstream

mgiota · 2024-03-18T15:39:10Z

@elasticmachine merge upstream

mgiota · 2024-03-18T16:08:34Z

@elasticmachine merge upstream

dominiqueclarke

Smoke tests LGTM

mgiota · 2024-03-18T22:28:37Z

@elasticmachine merge upstream

kibana-ci · 2024-03-19T10:17:35Z

💛 Build succeeded, but was flaky

Failed CI Steps

Serverless Entity Analytics - Security Cypress Tests #1

Test Failures

[job] [logs] Serverless Entity Analytics - Security Cypress Tests #1 / Entity Analytics Dashboard legacy risk score With user risk data With alerts data filters the alerts count with time range filters the alerts count with time range

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`observability`	890	474	-416
`observabilityShared`	181	193	+12
`slo`	-	610	+610
total			+206

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
`observability`	642	652	+10
`observabilityShared`	325	328	+3
`slo`	-	61	+61
total			+74

Async chunks

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

id	before	after	diff
`observability`	902.1KB	258.7KB	-643.4KB
`observabilityLogsExplorer`	153.1KB	153.0KB	-20.0B
`slo`	-	614.4KB	⚠️ +614.4KB
total			-29.0KB

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
`alerting`	51	53	+2
`observability`	17	14	-3
`slo`	-	1	+1
total			-0

Page load bundle

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

id	before	after	diff
`observability`	108.7KB	150.0KB	+41.3KB
`observabilityLogsExplorer`	15.6KB	15.5KB	-143.0B
`observabilityShared`	61.1KB	61.5KB	+360.0B
`serverlessObservability`	26.6KB	26.7KB	+64.0B
`slo`	-	20.7KB	+20.7KB
total			+62.3KB

Unknown metric groups

API count

id	before	after	diff
`observability`	651	661	+10
`observabilityShared`	330	333	+3
`slo`	-	61	+61
total			+74

async chunk count

id	before	after	diff
`observability`	35	12	-23
`slo`	-	24	+24
total			+1

ESLint disabled in files

id	before	after	diff
`observability`	5	4	-1
`slo`	-	2	+2
total			+1

ESLint disabled line counts

id	before	after	diff
`observability`	40	33	-7
`slo`	-	12	+12
total			+5

miscellaneous assets size

id	before	after	diff
`observability`	695.2KB	161.8KB	-533.4KB
`slo`	-	695.2KB	⚠️ +695.2KB
total			+161.8KB

References to deprecated APIs

id	before	after	diff
`observability`	6	2	-4
`slo`	-	4	+4
total			-0

Total ESLint disabled count

id	before	after	diff
`observability`	45	37	-8
`slo`	-	14	+14
total			+6

History

💔 Build #198166 failed a561a6f
💔 Build #198159 failed 1223227403176ba1f2130b84f83efc102ec53233
💔 Build #198051 failed 49d838b
💔 Build #197999 failed 4f5638c
💔 Build #197966 failed 0f02d22

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

cc @mgiota

mgiota added 6 commits February 22, 2024 20:47

create new slos plugin

220d7f6

include new slos plugin in more places

af1dea4

add SLOs to the sidebar

199bc18

rename plugin to slo

821e629

Merge branch 'main' of github.com:elastic/kibana into new_slo_plugin

6d16bca

move slo stuff from observability to slo plugin

905cf5a

mgiota mentioned this pull request Mar 4, 2024

Create new slos plugin #177266

Closed

mgiota force-pushed the new_slo_plugin branch from fcb7b6d to 0999f9d Compare March 4, 2024 22:33

update references

dc12fda

mgiota force-pushed the new_slo_plugin branch from 0999f9d to dc12fda Compare March 4, 2024 22:34

update more references mainly on public folder

da7435d

mgiota force-pushed the new_slo_plugin branch 2 times, most recently from 997721d to 0ab9dda Compare March 5, 2024 16:58

more updates

41fc81c

mgiota force-pushed the new_slo_plugin branch from 0ab9dda to 41fc81c Compare March 5, 2024 17:31

successfully render first slo pages

634b68d

mgiota force-pushed the new_slo_plugin branch from 99ee042 to 634b68d Compare March 6, 2024 07:58

use typed kibana and fix translations

925f9fd

mgiota force-pushed the new_slo_plugin branch 10 times, most recently from 8368ce0 to 513ab04 Compare March 6, 2024 20:32

mgiota added 2 commits March 14, 2024 15:17

Merge branch 'main' of github.com:elastic/kibana into new_slo_plugin

50c94c5

fix deep link id for slos

9f7aaff

simianhacker approved these changes Mar 14, 2024

View reviewed changes

Dosant approved these changes Mar 18, 2024

View reviewed changes

sebelga approved these changes Mar 18, 2024

View reviewed changes

mgiota added 2 commits March 18, 2024 12:09

Merge branch 'main' of github.com:elastic/kibana into new_slo_plugin

6688ad5

keep same order for alerts slos cases in the navigation

70118a8

kibanamachine and others added 2 commits March 18, 2024 08:29

Merge branch 'main' into new_slo_plugin

6ddf511

handle redirects for slo detail and edit pages

0f02d22

CoenWarmer reviewed Mar 18, 2024

View reviewed changes

Merge branch 'main' into new_slo_plugin

4f5638c

Merge branch 'main' into new_slo_plugin

2e57cfa

Merge branch 'main' into new_slo_plugin

49d838b

dominiqueclarke approved these changes Mar 18, 2024

View reviewed changes

mgiota added 2 commits March 18, 2024 22:20

fix failing tests

5425dbd

update global nav

b6bfce4

kibanamachine and others added 4 commits March 18, 2024 18:28

Merge branch 'main' into new_slo_plugin

b992500

show slo link when right capabilities

a561a6f

slos is not a deep link anymore, remove from these tests

cbabcd5

Merge branch 'main' of github.com:elastic/kibana into new_slo_plugin

c401dff

Conversation

mgiota commented Mar 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🍒 Summary

✔️ Acceptance criteria

🌮 How to test

TODO

Uh oh!

ghost commented Mar 4, 2024

🤖 GitHub comments

Uh oh!

github-actions bot commented Mar 4, 2024

Uh oh!

mgiota commented Mar 14, 2024

Uh oh!

mgiota commented Mar 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

simianhacker left a comment

Choose a reason for hiding this comment

Uh oh!

mgiota commented Mar 14, 2024

Uh oh!

Dosant left a comment

Choose a reason for hiding this comment

Uh oh!

sebelga left a comment

Choose a reason for hiding this comment

Uh oh!

mgiota commented Mar 18, 2024

Uh oh!

mgiota commented Mar 18, 2024

Uh oh!

CoenWarmer Mar 18, 2024 • 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!

mgiota Mar 18, 2024 • 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!

mgiota commented Mar 18, 2024

Uh oh!

mgiota commented Mar 18, 2024

Uh oh!

mgiota commented Mar 18, 2024

Uh oh!

dominiqueclarke left a comment

Choose a reason for hiding this comment

Uh oh!

mgiota commented Mar 18, 2024

Uh oh!

kibana-ci commented Mar 19, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

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

miscellaneous assets size

References to deprecated APIs

Total ESLint disabled count

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

16 participants

mgiota commented Mar 4, 2024 •

edited

Loading

mgiota commented Mar 14, 2024 •

edited

Loading

CoenWarmer Mar 18, 2024 •

edited

Loading

mgiota Mar 18, 2024 •

edited

Loading