[Console] Add Kibana APIs Support #128562

mibragimov · 2022-03-25T16:20:12Z

This PR continues the work from #99102.

Completed tasks

Send requests to Kibana APIs from the client instead of the server.
Prettify formatting of JSON responses.
Fix "Copy as cURL" functionality

Testing

To test this out, enter a request against a Kibana API, but prefix the path with kbn:, to help the Console API differentiate between ES API and Kibana API requests. For example:

GET kbn:api/index_lifecycle_management/policies

_Originally posted by @cjcenizal in #99102

Release Note

Dev Tools Console now supports sending requests to Kibana APIs: prepend any Kibana API endpoint with kbn: and send the request via Console, for example, GET kbn:/api/index_management/indices.

Screenshots

mibragimov · 2022-03-26T06:56:13Z

@jen-huang @legrego @kobelb @jfsiii @wylieconlon I made some changes as per the comments on #99102. Could you please review this functionality again and provide your feedback? Thank you in advance!

mibragimov · 2022-03-26T07:37:08Z

@elasticmachine merge upstream

mibragimov · 2022-03-26T07:57:33Z

@elasticmachine merge upstream

legrego

I did a quick pass (test only, no code review), and my initial concerns all look resolved - nice work! I tested in a couple of different spaces, and it appears that this is respecting the current space, which is perfect.

I briefly tested "Copy as cURL", and that doesn't seem to copy anything to my clipboard.

One nit: It would be nice if we could support both GET kbn:api/... and GET kbn:/api/.... Adding the leading / results in a 404 response.

mibragimov · 2022-03-29T12:41:15Z

I did a quick pass (test only, no code review), and my initial concerns all look resolved - nice work! I tested in a couple of different spaces, and it appears that this is respecting the current space, which is perfect.

I briefly tested "Copy as cURL", and that doesn't seem to copy anything to my clipboard.

One nit: It would be nice if we could support both GET kbn:api/... and GET kbn:/api/.... Adding the leading / results in a 404 response.

@legrego thank you for testing this out! I updated the PR with your suggestion for supporting leading /. Also, I tested "Copy as cURL" on Linux and it seems to be working for me. I wonder if it is related to the platform

elasticmachine · 2022-04-13T09:24:25Z

Pinging @elastic/platform-deployment-management (Team:Deployment Management)

src/plugins/console/public/application/models/sense_editor/sense_editor.ts

…-fix'

sabarasaba

Latest changes lgtm, tested locally. Thanks a ton for working on this @mibragimov! Left a tiny nit, but feel free to ignore it 🚀

src/plugins/console/common/constants/api.ts

mibragimov · 2022-04-21T13:01:28Z

Thanks for the review @yuliacech @sabarasaba !

kibana-ci · 2022-04-21T14:12:33Z

💛 Build succeeded, but was flaky

Test Failures

[job] [logs] Default CI Group #4 / lens app lens drag and drop tests basic drag and drop should combine breakdown dimension with the horizontal one
[job] [logs] Default CI Group #4 / lens app "after all" hook in "lens app"

Metrics [docs]

Async chunks

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

id	before	after	diff
`console`	399.5KB	399.8KB	+277.0B

History

💚 Build #39749 succeeded e8c74f7
💚 Build #39421 succeeded 0d9576f
💚 Build #38785 succeeded 4aaab42
💔 Build #38768 failed 3bf5dad
💚 Build #38399 succeeded 4cb75a8
💔 Build #38396 failed 402e42b

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

cc @mibragimov

This reverts commit 502a00b.

jbudz · 2022-04-21T15:28:59Z

This was reverted with f41dc1f.

on-merge CI stated failing at https://buildkite.com/elastic/kibana-on-merge/builds/15267

This reverts commit f41dc1f.

* Revert "Revert "[Console] Add Kibana APIs Support (#128562)"" This reverts commit f41dc1f. * fix functional test

cjcenizal · 2022-04-21T21:31:00Z

Fixed and reinstated in #130816

getkub · 2022-04-26T07:59:12Z

I did a quick pass (test only, no code review), and my initial concerns all look resolved - nice work! I tested in a couple of different spaces, and it appears that this is respecting the current space, which is perfect.
I briefly tested "Copy as cURL", and that doesn't seem to copy anything to my clipboard.
One nit: It would be nice if we could support both GET kbn:api/... and GET kbn:/api/.... Adding the leading / results in a 404 response.

Liked the idea, but what about large "clustered" systems and Cross cluster search? how would you define "kbn" for another instance of Elastic/Kibana? Should it have provision to define by IP/endpoint URL/port too?
something like..

GET  cluster1:5601/api/spaces

cjcenizal · 2022-05-03T12:42:20Z

Thanks for the suggestion @getkub! In the past we've discussed and decided against enabling Console to send requests to different clusters. Relevant issues:

* Add support for Kibana API requests * Fix failing tests * Support leading / and minor refactor * Resolve conflicts * Update send_request.test file * Refactor * Add functional test * Address comments * Fix typo * Resolve conflicts and refactor error handling * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * Address comments * Resolve merge conflicts * Rename KIBANA_API_KEYWORD Co-authored-by: Muhammad Ibragimov <muhammad.ibragimov@elastic.co> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

This reverts commit 502a00b.

* Revert "Revert "[Console] Add Kibana APIs Support (elastic#128562)"" This reverts commit f41dc1f. * fix functional test

* Add support for Kibana API requests * Fix failing tests * Support leading / and minor refactor * Resolve conflicts * Update send_request.test file * Refactor * Add functional test * Address comments * Fix typo * Resolve conflicts and refactor error handling * [CI] Auto-commit changed files from 'node scripts/eslint --no-cache --fix' * Address comments * Resolve merge conflicts * Rename KIBANA_API_KEYWORD Co-authored-by: Muhammad Ibragimov <muhammad.ibragimov@elastic.co> Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

This reverts commit 502a00b.

* Revert "Revert "[Console] Add Kibana APIs Support (elastic#128562)"" This reverts commit f41dc1f. * fix functional test

mibragimov added release_note:enhancement Feature:Console Dev Tools Console Feature Feature:Dev Tools Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more v8.2.0 labels Mar 25, 2022

mibragimov requested review from maksimkovalev and alexwizp March 25, 2022 16:20

mibragimov self-assigned this Mar 25, 2022

cjcenizal requested a review from sabarasaba March 25, 2022 17:20

mibragimov requested review from legrego, kobelb and jen-huang March 26, 2022 06:43

mibragimov force-pushed the kibana-api branch from 9d03f02 to 7f10c7b Compare March 26, 2022 09:36

legrego reviewed Mar 28, 2022

View reviewed changes

mibragimov force-pushed the kibana-api branch from 7f10c7b to 7fca49b Compare March 29, 2022 12:30

mibragimov force-pushed the kibana-api branch from 7fca49b to c98b694 Compare April 8, 2022 07:42

mibragimov added v8.3.0 and removed v8.2.0 labels Apr 8, 2022

mibragimov force-pushed the kibana-api branch from 7d942fb to aac8f8e Compare April 12, 2022 09:26

mibragimov marked this pull request as ready for review April 13, 2022 09:24

mibragimov requested a review from a team as a code owner April 13, 2022 09:24

mibragimov force-pushed the kibana-api branch 2 times, most recently from 0a1ba2d to 72581f5 Compare April 14, 2022 06:34

yuliacech reviewed Apr 14, 2022

View reviewed changes

src/plugins/console/public/application/models/sense_editor/sense_editor.ts Outdated Show resolved Hide resolved

yuliacech reviewed Apr 14, 2022

View reviewed changes

src/plugins/console/public/application/models/sense_editor/sense_editor.ts Outdated Show resolved Hide resolved

kibanamachine and others added 3 commits April 21, 2022 03:15

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

4b0e4e6

…-fix'

Address comments

c5e1bb4

Resolve merge conflicts

e8c74f7

mibragimov force-pushed the kibana-api branch from 88473f5 to e8c74f7 Compare April 21, 2022 10:31

mibragimov added the backport:skip This commit does not require backporting label Apr 21, 2022

sabarasaba approved these changes Apr 21, 2022

View reviewed changes

src/plugins/console/common/constants/api.ts Outdated Show resolved Hide resolved

Rename KIBANA_API_KEYWORD

58348e1

mibragimov enabled auto-merge (squash) April 21, 2022 12:59

mibragimov merged commit 502a00b into elastic:main Apr 21, 2022

jbudz added a commit that referenced this pull request Apr 21, 2022

Revert "[Console] Add Kibana APIs Support (#128562)"

f41dc1f

This reverts commit 502a00b.

jbudz added the reverted label Apr 21, 2022

alisonelizabeth added a commit to alisonelizabeth/kibana that referenced this pull request Apr 21, 2022

Revert "Revert "[Console] Add Kibana APIs Support (elastic#128562)""

6816965

This reverts commit f41dc1f.

alisonelizabeth mentioned this pull request Apr 21, 2022

[Console] Add Kibana APIs Support #130816

Merged

cjcenizal pushed a commit that referenced this pull request Apr 21, 2022

[Console] Add Kibana APIs Support (#130816)

47918ae

* Revert "Revert "[Console] Add Kibana APIs Support (#128562)"" This reverts commit f41dc1f. * fix functional test

mibragimov deleted the kibana-api branch April 25, 2022 07:23

spong mentioned this pull request May 5, 2022

[DOCS] Remove note that Console only supports ES API's as it will now support Kibana API's in 8.3 elastic/security-docs#1970

Closed

dmlemeshko pushed a commit to dmlemeshko/kibana that referenced this pull request May 5, 2022

Revert "[Console] Add Kibana APIs Support (elastic#128562)"

34aed24

This reverts commit 502a00b.

dmlemeshko pushed a commit to dmlemeshko/kibana that referenced this pull request May 5, 2022

[Console] Add Kibana APIs Support (elastic#130816)

84d1538

* Revert "Revert "[Console] Add Kibana APIs Support (elastic#128562)"" This reverts commit f41dc1f. * fix functional test

kertal pushed a commit to kertal/kibana that referenced this pull request May 24, 2022

Revert "[Console] Add Kibana APIs Support (elastic#128562)"

342e9a3

This reverts commit 502a00b.

kertal pushed a commit to kertal/kibana that referenced this pull request May 24, 2022

[Console] Add Kibana APIs Support (elastic#130816)

50fc387

* Revert "Revert "[Console] Add Kibana APIs Support (elastic#128562)"" This reverts commit f41dc1f. * fix functional test

joepeeples mentioned this pull request Jun 1, 2022

[DOCS][8.3] Update note on API page elastic/security-docs#2033

Merged

yuliacech mentioned this pull request Mar 6, 2023

Dev Tools should integrate Kibana Apis #152464

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Console] Add Kibana APIs Support #128562

[Console] Add Kibana APIs Support #128562

mibragimov commented Mar 25, 2022 •

edited

mibragimov commented Mar 26, 2022

mibragimov commented Mar 26, 2022

mibragimov commented Mar 26, 2022

legrego left a comment

mibragimov commented Mar 29, 2022 •

edited

elasticmachine commented Apr 13, 2022

sabarasaba left a comment

mibragimov commented Apr 21, 2022

kibana-ci commented Apr 21, 2022

jbudz commented Apr 21, 2022

cjcenizal commented Apr 21, 2022

getkub commented Apr 26, 2022 •

edited

cjcenizal commented May 3, 2022

[Console] Add Kibana APIs Support #128562

[Console] Add Kibana APIs Support #128562

Conversation

mibragimov commented Mar 25, 2022 • edited

Completed tasks

Testing

Release Note

mibragimov commented Mar 26, 2022

mibragimov commented Mar 26, 2022

mibragimov commented Mar 26, 2022

legrego left a comment

Choose a reason for hiding this comment

mibragimov commented Mar 29, 2022 • edited

elasticmachine commented Apr 13, 2022

sabarasaba left a comment

Choose a reason for hiding this comment

mibragimov commented Apr 21, 2022

kibana-ci commented Apr 21, 2022

💛 Build succeeded, but was flaky

Test Failures

Metrics [docs]

Async chunks

History

jbudz commented Apr 21, 2022

cjcenizal commented Apr 21, 2022

getkub commented Apr 26, 2022 • edited

cjcenizal commented May 3, 2022

mibragimov commented Mar 25, 2022 •

edited

mibragimov commented Mar 29, 2022 •

edited

getkub commented Apr 26, 2022 •

edited