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.

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

Add Kibana Reporting diagnostics #676

Closed
tsullivan opened this issue Nov 6, 2023 · 8 comments · Fixed by #746
Closed

Add Kibana Reporting diagnostics #676

tsullivan opened this issue Nov 6, 2023 · 8 comments · Fixed by #746

Comments

@tsullivan
Copy link
Member

Reporting has a self-service diagnostic tool in Stack Management > Reporting.

From the docs:

[In the] the Report Listing page, and click Run reporting diagnostics. This will open up a diagnostic tool that checks various parts of the Kibana deployment and come up with any relevant recommendations

We should have this Reporting Diagnostic get pulled as part of the general Kibana diagnostic. It would help speed up discovery and timelines for the Support team.

@tsullivan
Copy link
Member Author

Replaces: elastic/kibana#151033

@tsullivan
Copy link
Member Author

tsullivan commented Nov 6, 2023

The diagnostic tool is under Stack Management > Alerts and Insights > Reporting > Run reporting diagnostics.

image

The client request to the Reporting Diagnostic API ("Check browser" functionality):

curl 'http://localhost:5601/api/reporting/diagnose/browser' \
  -X 'POST' \
  -H 'Content-Type: application/json' \
  -H 'kbn-version: 8.8.2' \' 

@stefnestor
Copy link
Contributor

@tsullivan quick mentioning I believe historically this repo attempted to avoid POST requests ( right, @pickypg ?); is there a way to poll this endpoint as GET?

@pickypg
Copy link
Member

pickypg commented Nov 9, 2023

Correct, we don't support any POST endpoints.

@tsullivan
Copy link
Member Author

I believe this endpoint doesn't need to be a POST. I have filed elastic/kibana#171698 to have the endpoint changed to GET.

@tsullivan
Copy link
Member Author

@pickypg the endpoint has been changed to GET, for 8.16.0+.

What would our next steps be on this issue?

cc @elastic/appex-sharedux

@pickypg
Copy link
Member

pickypg commented Sep 19, 2024

It seems like the only thing necessary to make the request work is to call it with the kbn-version specified?

@tsullivan
Copy link
Member Author

tsullivan commented Sep 21, 2024

It seems like the only thing necessary to make the request work is to call it with the kbn-version specified?

You could add that, if it is consistent with other calls from the diagnostic tool However, I was able to get the response with that header and without it from an 8.16.0-SNAPSHOT deployment running in Docker using this command

Both of these work:

# with the header
curl 'https://localhost:15601/internal/reporting/diagnose/browser' \
  -k -u elastic:changeme \
  -H 'kbn-version: 8.16.0-SNAPSHOT'

# without the header
curl 'https://localhost:15601/internal/reporting/diagnose/browser' \
  -k -u elastic:changeme

Response:

{"success":true,"help":[],"logs":"\nDevTools listening on ws://127.0.0.1:33695/devtools/browser/bc1bd0a3-fed1-4f90-8d99-e46d0fdbae98\n[0921/184802.861275:WARNING:sandbox_linux.cc(430)] InitializeSandbox() called with multiple threads in process gpu-process.\n"}%

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants