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

[Fleet] Debug UI is not accessible when Fleet setup is failing #143644

Closed
joshdover opened this issue Oct 19, 2022 · 1 comment · Fixed by #146594
Closed

[Fleet] Debug UI is not accessible when Fleet setup is failing #143644

joshdover opened this issue Oct 19, 2022 · 1 comment · Fixed by #146594
Assignees
Labels
bug Fixes for quality problems that affect the customer experience Team:Fleet Team label for Observability Data Collection Fleet team

Comments

@joshdover
Copy link
Contributor

One of the most common things we debug in support cases is the Fleet setup process failing. This is a prerequisite to showing any of the Fleet UI. This means we can't currently use the /app/fleet/_debug UI when setup is failing. We should opt this UI out of requiring that Fleet setup has completed so we can easily use it in support scenarios.

@joshdover joshdover added bug Fixes for quality problems that affect the customer experience Team:Fleet Team label for Observability Data Collection Fleet team labels Oct 19, 2022
@elasticmachine
Copy link
Contributor

Pinging @elastic/fleet (Team:Fleet)

@criamico criamico self-assigned this Dec 5, 2022
criamico added a commit that referenced this issue Dec 5, 2022
## Summary
Closes elastic/ingest-dev#1422
Closes #143644
Fixes #141635

### Description
Spacetime project:
- Fixing UI layout 
- Adding a new endpoint to check the connection to fleet-server. The
endpoint executes `curl -s -k <hostname>/api/status` and can be called
from dev tools as:
```
POST kbn:/api/fleet/health_check
{
  "host": $hostname
}
```
Where `$hostname` is the host configured in fleet server hosts settings
section.
- Adding a Fleet Server health check to the debug page
`app/fleet/_debug`. The host can be selected via a dropdown.
- Moving debug page outside of setup to allow debugging when fleet
couldn't initialise. I added a warning on top of the page in this
specific case - #143644
- Added some more saved objects and indices that weren't added the first
time round to allow further debugging.

### Repro steps:
To try that the page loads even when setup didn't work, I changed some
values in the code. Comment out [this
code](https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/public/applications/fleet/app.tsx#L163-L165)
and replace it with `setInitializationError({ name: 'error', message:
'unable to initialize' });`, then set `false` in
[here](https://github.com/elastic/kibana/blob/b155134d662b8011857f7763a063ce87b3b6a91d/x-pack/plugins/fleet/public/applications/fleet/app.tsx#L179)
and the fleet UI should show a setup error, however now the debug page
should be visible.

### Screenshots
<img width="2076" alt="Screenshot 2022-11-30 at 15 25 51"
src="https://user-images.githubusercontent.com/16084106/204824818-d620aabf-83b1-4acd-9f38-6f271d17a38a.png">
<img width="1403" alt="Screenshot 2022-11-30 at 15 26 36"
src="https://user-images.githubusercontent.com/16084106/204824851-04b36d5e-e466-4f0c-9eed-b8b492f128b9.png">
<img width="2063" alt="Screenshot 2022-11-30 at 15 27 09"
src="https://user-images.githubusercontent.com/16084106/204824909-a26a8df1-38ba-4553-984f-fce13a3abf8d.png">
<img width="2110" alt="Screenshot 2022-12-01 at 17 36 57"
src="https://user-images.githubusercontent.com/16084106/205110349-a682a894-767e-47f9-beb9-7f9c39bece72.png">


### Checklist

- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes for quality problems that affect the customer experience Team:Fleet Team label for Observability Data Collection Fleet team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants