Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[ML] Explain log rate spikes: Plugin setup #131317

Merged
merged 45 commits into from
May 12, 2022
Merged

[ML] Explain log rate spikes: Plugin setup #131317

merged 45 commits into from
May 12, 2022

Conversation

walterra
Copy link
Contributor

@walterra walterra commented May 2, 2022 •
edited
Loading

Summary

Part of #136265.
Resolves #131607.

Sets up the boilerplate code for the aiops plugin and adds a demo page within the ML app to demonstrate single API request data streaming from Kibana server to UI client.

  • General plugin code was auto-generated by the plugin generator (see Plugin tooling)
  • Code that integrates the demo page within the ML plugin is in line with the data_visualizer plugin code.

Review note for kibana-operations: This touches packages/kbn-optimizer/limits.yml for the new aiops plugin to set an initial KB limit, looking at CODEOWNERS, I think that's the only file that triggered the review request.

Plugin page is available at this Kibana URL: http://localhost:5601/app/ml/aiops/explain_log_rate_spikes

The streaming demo shows a bar chart race:

aiops-api-streaming-0002

Checklist

  • Unit or functional tests were updated or added to match the most common scenarios
  • Cross browser testing: macOS Chrome 101 / Safari 15.4 / Firefox 99 / Edge 101

For maintainers

@walterra walterra self-assigned this May 2, 2022
@walterra walterra force-pushed the ml-aiops-plugin branch 5 times, most recently from 3a59a4c to 782d13e Compare May 4, 2022 08:51
walterra added 24 commits May 5, 2022 13:02
@walterra
[ML] AIOps plugin setup.
41d413f
@walterra
[ML] Stream demo.
f19c6d4
@walterra
[ML] Break out card components.
54c7784
@walterra
[ML] Remove console.logs.
e7fb0fd
@walterra
[ML] Additional plugin boilerplate.
614d5b4
@walterra
[ML] Fix cancelling/error handling.
daa4734
@walterra
[ML] Fix linting/types.
73ce845
@walterra
[ML] Fix tsconfig.json.
da38fe3
@walterra
[ML] Fix docs.
64dcba9
@walterra
[ML] Fix tsconfig.json.
4618dfb
@walterra
[ML] Fix optimizer limits.
6d64d5b
@walterra
[ML] Fix application usage schema.
1e1a431
@walterra
[ML] Telemetry fix.
3ed87af
@walterra
[ML] Move spike analysis from top level page to a page within the ML …
8188782 
…plugin.
@walterra
[ML] Fix breadcrumb.
955093b
@walterra
[ML] Fix translations setup.
750590c
@walterra
[ML] Fix public APIs missing comments.
b3d2de3
@walterra
[ML] Remove app level schema.
3d4a608
@walterra
[ML] Fix telemetry check.
3c1407c
@walterra
[ML] Fix missing export.
c34ff6c
@walterra
[ML] Migrate GIF battle to bar chart race without 3rd party references.
21b2727
@walterra
[ML] Add hard coded feature flag.
c9e8a21
@walterra
[ML] Make AIOps menu entry a non-clickable section header.
61081f6
@walterra
[ML] API integration test.
36d4671
@walterra walterra requested a review from pheyos May 11, 2022 08:13
peteharverson
peteharverson reviewed May 11, 2022
View reviewed changes
x-pack/plugins/aiops/README.md Outdated Show resolved Hide resolved
x-pack/plugins/aiops/common/index.ts
* This is an internal hard coded feature flag so we can easily turn on/off the
* "Explain log rate spikes UI" during development until the first release.
*/
export const AIOPS_ENABLED = true;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will you set this to false before merging?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed, we'll leave it as true for now for easier internal testing and will switch to false right before feature freeze.

x-pack/plugins/aiops/public/components/explain_log_rate_spikes.tsx Show resolved Hide resolved
x-pack/plugins/aiops/public/types.ts Outdated Show resolved Hide resolved
x-pack/plugins/aiops/.i18nrc.json Outdated Show resolved Hide resolved
x-pack/test/api_integration/apis/aiops/index.ts Outdated Show resolved Hide resolved
peteharverson
peteharverson reviewed May 11, 2022
View reviewed changes
Copy link
Contributor

@peteharverson peteharverson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested and overall looks good. Just left a few comments.

pheyos
pheyos approved these changes May 11, 2022
View reviewed changes
Copy link
Member

@pheyos pheyos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Example stream API tests LGTM with just one observation.

x-pack/test/api_integration/apis/aiops/example_stream.ts Outdated Show resolved Hide resolved
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
aiops - 77 +77
ml 1581 1584 +3
total +80

Async chunks

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

id before after diff
aiops - 218.1KB ⚠️ +218.1KB
ml 3.3MB 3.3MB +2.0KB
total +220.1KB

Page load bundle

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

id before after diff
aiops - 3.8KB +3.8KB
ml 39.5KB 39.8KB +312.0B
total +4.1KB
Unknown metric groups

API count

id before after diff
aiops - 10 +10

async chunk count

id before after diff
aiops - 1 +1

ESLint disabled line counts

id before after diff
aiops - 3 +3

Total ESLint disabled count

id before after diff
aiops - 3 +3

History

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

cc @walterra

alvarezmelissa87
alvarezmelissa87 approved these changes May 11, 2022
View reviewed changes
Copy link
Contributor

@alvarezmelissa87 alvarezmelissa87 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested and LGTM ⚡ Thanks for your work on this!! 🙌

peteharverson
peteharverson approved these changes May 12, 2022
View reviewed changes
Copy link
Contributor

@peteharverson peteharverson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Latest changes LGTM

@walterra walterra merged commit 6df1b28 into elastic:main May 12, 2022
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label May 12, 2022
@walterra walterra mentioned this pull request May 12, 2022
Merged
3 tasks
@walterra walterra deleted the ml-aiops-plugin branch May 12, 2022 12:34
@walterra walterra mentioned this pull request May 20, 2022
Closed
4 tasks
@walterra walterra mentioned this pull request Jul 29, 2022
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@spalger spalger spalger approved these changes

@pheyos pheyos pheyos approved these changes

@alvarezmelissa87 alvarezmelissa87 alvarezmelissa87 approved these changes

@peteharverson peteharverson peteharverson approved these changes

Assignees

@walterra walterra

Labels
backport:skip This commit does not require backporting :ml release_note:skip Skip the PR/issue when compiling release notes v8.3.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[ML] Explain log rate spikes: Plugin setup
8 participants
@walterra @elasticmachine @kibana-ci @spalger @pheyos @alvarezmelissa87 @peteharverson @kibanamachine