[8.15] [Reporting] Improvements to reporting diagnostics (#191790) #195224
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## Summary Closes elastic#186434 This PR adds a search within the output log whilst attempting to start the browser (i.e chromium) bundled with Kibana to ascertain if it includes a font config error log message as signal in reporting diagnostics for potential issues with generating a report. This work is informed from couple of support tickets with customers running the diagnostics tool, getting a confirmation that the reporting system is functionality whilst missing font issues was actually preventing reports from being generated on the linux platform. Also fixes an issue that prevented visual feedback for when an error is detected during diagnosis. #### Visuals  <!-- ### Checklist Delete any items that are not applicable to this PR. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] 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)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. | | Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. | | Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. | | [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) | ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --> --------- Co-authored-by: Elastic Machine <[email protected]> (cherry picked from commit 20dcf5f)
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
💔 Build FailedFailed CI Steps
Metrics [docs]Async chunks
HistoryTo update your PR or re-run it, just comment with: cc @eokoneyo |
|
@eokoneyo looks like there are some failures in this backport. LMK when it is ready and I can approve it, if needed. |
|
@elasticmachine merge upstream |
@tsullivan thanks for the ping! I resolved the failing issues, I'd say it's ready for review again. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backport
This will backport the following commits from
mainto8.15:Questions ?
Please refer to the Backport tool documentation
\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine ","sha":"20dcf5f7211c6e8ed166fc7bb9a61a733384a529","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:SharedUX","backport:prev-major","Feature:Reporting:Screenshot"],"title":"[Reporting] Improvements to reporting diagnostics","number":191790,"url":"https://github.com//pull/191790","mergeCommit":{"message":"[Reporting] Improvements to reporting diagnostics (#191790)\n\n## Summary\r\n\r\nCloses https://github.com//issues/186434\r\n\r\nThis PR adds a search within the output log whilst attempting to start\r\nthe browser (i.e chromium) bundled with Kibana to ascertain if it\r\nincludes a font config error log message as signal in reporting\r\ndiagnostics for potential issues with generating a report. This work is\r\ninformed from couple of support tickets with customers running the\r\ndiagnostics tool, getting a confirmation that the reporting system is\r\nfunctionality whilst missing font issues was actually preventing reports\r\nfrom being generated on the linux platform.\r\n\r\nAlso fixes an issue that prevented visual feedback for when an error is\r\ndetected during diagnosis.\r\n\r\n#### Visuals\r\n\r\n\r\n\r\n\r\n\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine ","sha":"20dcf5f7211c6e8ed166fc7bb9a61a733384a529"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com//pull/191790","number":191790,"mergeCommit":{"message":"[Reporting] Improvements to reporting diagnostics (#191790)\n\n## Summary\r\n\r\nCloses https://github.com//issues/186434\r\n\r\nThis PR adds a search within the output log whilst attempting to start\r\nthe browser (i.e chromium) bundled with Kibana to ascertain if it\r\nincludes a font config error log message as signal in reporting\r\ndiagnostics for potential issues with generating a report. This work is\r\ninformed from couple of support tickets with customers running the\r\ndiagnostics tool, getting a confirmation that the reporting system is\r\nfunctionality whilst missing font issues was actually preventing reports\r\nfrom being generated on the linux platform.\r\n\r\nAlso fixes an issue that prevented visual feedback for when an error is\r\ndetected during diagnosis.\r\n\r\n#### Visuals\r\n\r\n\r\n\r\n\r\n\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic Machine ","sha":"20dcf5f7211c6e8ed166fc7bb9a61a733384a529"}}]}] BACKPORT-->