[Health check] Add logs with the details about the check #3258

Desvelao · 2021-05-18T14:24:26Z

Description

This PR adds logs with the details about the checks.

Added button to open/close the check details
Added a new section in Settings: Miscellaneous:
- Health check: run in debug mode
Refactorized how the check validator function is managed
Refactorized another function
Some adjustments in Settings section related to spaces

Checks

Health check:
- Open/close the check details with the button added after the check result
- When a check does an action, the button to open the details should have a notification icon
Settings > Miscellaneous:
- The new section should be visible and accessible in the Settings section
  - Try the link in the main menu
  - Try the tab in Settings
- Run the Health check in debug mode:
  - Should redirect to health check
  - A Continue button should appear when all checks are ready
Considers reviewing the messages displayed in the logs
Try with index patterns not created

Suggested improvements

Remove the notification after the check logs are opened

Closes: #3208

- Add logs to checks - Add button to open/close the check logs - Add new section to Settings: Miscellaneous - Add control when the health chekc is run in `debug` mode (no redirection after cheks are ready) - Refactor some functions - Some ajustments to Settins secions related to spaces

- Fix health check redirection when all checks are ready - Update health check tests

CPAlejandro

When stopping the manager service and executing the health-check, an error of an uncontrolled undefined appears.
As a suggestion, maybe when a red dot appears and you open the logs, it could disappear?

Desvelao · 2021-05-20T12:54:33Z

I like the suggestion to remove the notification after opening the check log. I will wait until somebody reviews the code and tests it.

Desvelao · 2021-05-21T11:24:19Z

When stopping the manager service and executing the health-check, an error of an uncontrolled undefined appears.

I tried to replicate the problem and I can't get the same error displayed in the screenshot. Could someone try to replicate?

I tried:

Stop the wazuh-manager service
service wazuh-manager stop
Turn off the machine with the manager (in my environment using Docker container, I stoped the container)

…nd there is some check action

CPAlejandro

Could we control the use of toast to not be able to display the same one twice, which can be annoying?
When moving from branch 4.2-7.10 to this branch and executing the health-check from / settings / Miscellaneous I get the following error
x-special/nautilus-clipboard
copy

…cations - Fix unknown error after restart the cluster and try to pass the health check - Remove the notification dot of check details when open for first time - Display the check details button when there are logs - Updated the tests (snapshot and tests)

Desvelao · 2021-05-24T11:18:26Z

Changes

Fix unknown error after restarting the cluster
Removed the notification dot when opening for the first time the check details
The button that opens the check details is only displayed when there are logs
Updated tests

CPAlejandro

Testing: LGTM!

pablomarga

CR: ✔️
Testing: ✔️

Desvelao · 2021-05-25T10:54:37Z

Someone to review the log messages @wazuh/frontend .

asteriscos · 2021-05-25T17:35:16Z

Team,
made some small improvements to the UI:

Fixed some verbose log texts
Removed redundant status texts
Improved the styling

A quick review is needed please!

asteriscos · 2021-05-26T10:15:41Z

public/components/health-check/components/check-result.tsx

+      content={tooltipVerboseButton}
+      >
+      <EuiButtonEmpty size='xs' onClick={switchVerboseDetails} isDisabled={!haveLogs} textProps={{ style:{overflow: 'visible' , position: 'relative'}}}>
+        <EuiButtonIcon


This button inception could be avoided?

frankeros

Test: ✔️
CR: changes requestd

I tested and it looks good. But I think that is a little confusing that the user gets the chance to open the logs then the health-check redirects automatically,
I would like that the button and logs to be displayed only when there is an error in normal mode.
In verbose mode it's ok.

frankeros · 2021-05-27T18:38:04Z

public/components/health-check/components/check-result.tsx

+    setVerboseIsOpen(state => !state);
+  },[checkDidSomeAction]);
+
+  const inspectLogsButton = isCheckStarted && haveLogs ? 


pls move the button and logs component to separate child components in order to keep a short class

Great idea, already split the components. Please review them!

asteriscos · 2021-05-28T11:58:37Z

Test:
CR: changes requestd

I tested and it looks good. But I think that is a little confusing that the user gets the chance to open the logs then the health-check redirects automatically,
I would like that the button and logs to be displayed only when there is an error in normal mode.
In verbose mode it's ok.

Sounds good. Now the log buttons will show when there's an error or in verbose mode. Please review it!

CPAlejandro

Testing: LGTM!

pablomarga

Testing: ✔️

frankeros

Test: ✔️
CR: ✔️
Amazing job guys!! 🎉

…and-special-mode

* Feature/remove module titles (#3160) * Remove module titles * Add popover to breadcrumb * Update changelog * Fix errors * Fix the broken links when using server.basePath Kibana setting (#3161) * fix(frontend): Fix broken link when use 'server.basePath` Kibana setting - Fix links in Wazuh breadcrumb - Fix some redirection links * feat(prettier): Added prettierrc config file. (#3168) * [Feature]: Add Wazuh help links as extension in Kibana help menu (#3170) * feat(frontend): Add Wazuh help links as an extension in Kibana help menu * fix(changelog): Add PR to changelog * fix(changelog): Fix PR number and link * fix(help-links): Replace component and removed color styles from Wazuh lunk in the Kibana help button * Fixing filter in reports (#3173) * Removed sha1 data and correct date format (#3189) * [FEATURE] Add redirect to group details using the URL (#3184) * feat(groups): Add redirect to group details using the URL - Redirect to group details when the URL contains group query param * doc(changelog): add missing changelog for #3189 * Fixed screen flickers in Cluster Visualization (#3159) * Modify the default settings related to monitoring indices creation (#3174) * fix(configuration): Changed WAZUH_MONITORING_DEFAULT_CREATION app setting from 'd' to 'w' (weekly) * fix(configuration): Replace wazuh.monitorin.creation from d to w (weekly) - Fixed cron.prefix setting * fix(monitoring): Set monitoring default indices shards to 1. Another fixes in configurations * fix(monitoring): fix wazuh.monitoring.shards value in the initail app configuration * doc(changelog): add missing changelogs * doc(changelog): remove duplicated changelogs * Bugfix default index patterns [Health-check] - 4.2 (#3232) * bugfix(health-check): Fixed creation of default index and added all section create and refresh index in heath-check. * fix: some bad behaviors * doc(changelog): add fix to changelog * fix: reject promise on error and refactor * fix: refactor required fields * feat: refactor const * Update CHANGELOG.md Co-authored-by: Franco Charriol <francocharriol@gmail.com> Co-authored-by: Franco Charriol <franco.charriol@wazuh.com> * Fix validation of list of valid index patterns for alerts (#3236) * Last changes from Tag 4.2.0 4201 (#3246) * Fixed fields overlap in the agent summary screen (#3217) * [Refactor] Health check (#3197) * refactor(healthcheck): Adapt the refactorized health check component to last changes - Added monitoring and statistics index patterns checks - Added logic to retry the checks with a refresh button - Apply the retry to API connection check - Export react services in index file - Create appConfig in the Redux store * feat(healtcheck): Replace health check initial state to waiting * fet(healthcheck): Add can retry to healthcheck checks * fix(menu): Fix error in toast from WzMenu and revome unnecessary return in PatternHandler * fix(health-check): Fix create index pattern when change the setting in Settings > Configuration and loop in health check * fix(health-check): renamed files from appConfig Redux actions and reducer * fix(frontend): Replace config singleton saving to Redux * fix(health-check): Fix infinite loop rendering component when a check is disabled in the configuration * fix(health-check): Rename health checks titles * fix(health-check): Fix the tests for Health check * refactor(health-check): Request changes, add max buckets check and some improvements - Request changes - Added the max buckets check when the component is mounted - Created the `useRootScope` hook - Improved the export in the HOCs and hooks index files - Removed the `lib` folder - Removed the `health-check` old component * Add modal to different sections (#3221) * Roles Mapping * Investigating problem with lifecylce * Created new mask and fix role mapping * Create and edit user * Create and edit roles * Edit policy * Polices edit and create * Management * Update Changelog * Change copyright * Fix errors * Feature Disable Wazuh by roles (#3222) * fix package name in add new agent (#3233) * fix index typo settings (#3234) * [Fix] Visualize button on Events (Discover component) (#3237) * fix(discover) Ser UiActions of the Discover plugin - This fixes the Visualize button was missing in the Discover sidebar when expanding a index field * add error when add sample data fails (#3241) * fix(navbar): Hide navbar wazuh label. (#3240) * Vulnerabilities inventory cleanup 3242 (#3243) * Removed check for active agent Now a list of vulnerabilities will be shown regardless of agent activity * Removed name from the top of the flyout Now only the CVE remains * added missing modules in agent menu (#3244) * Removed tooltip in last breadcrumb in header breadcrumb (#3250) * Improve api selector (#3175) * error adding selectors * added select api and select index pattern on menu * remove unused variables * error adding selectors * added select api and select index pattern on menu * remove unused variables * bugfix(apiSelector): Fixed index pattern selection, bad behavior when switching from navbar. * Added Popover when screen width is small * Changed popover icon * Resolved requested changes * Removed selectors in wazuh menu, removed margin in breadcrumb * Removed margins style in breadcrumb * Added tooltip in popover selectors button * fixed marginLeft syntax in breadcrumb * Fixed conditions to show selectors in popover * Fixed change API selector * Fixed selectors sizes * Update CHANGELOG.md Co-authored-by: gabiwassan <gabriel.wassan@wazuh.com> Co-authored-by: Ibarra Maximiliano <maximiliano.ibarra@wazuh.com> Co-authored-by: Franco Charriol <francocharriol@gmail.com> Co-authored-by: Franco Charriol <franco.charriol@wazuh.com> * Bugfix/3273 error check wazuh no security (#3292) * Fixed error in check-wazuh * updated CHANGELOG * fix(changelog): Moved PR number to a existent change Co-authored-by: Ibarra Maximiliano <maximiliano.ibarra@wazuh.com> Co-authored-by: Antonio <34042064+Desvelao@users.noreply.github.com> * Add validation form creating new rule/decoder (#3274) * Add modal when creating new rule * Update changelog * Change if/else * Change rest of if/else * Change flyout title * Fix error when saving a rule * Fix errors in PDF reports (#3272) * Remove dupicate subsection * Fix duplicate Who data * fix date format pdf * Fix width columns * Add changelog * Remove unused variable * Translate comments * Use camelCase * Removed unnecessary tabs * Transalate comments * fix(reporting): Replace array constructor * fix(changelog): Removed spaces in markdown links Co-authored-by: Antonio <34042064+Desvelao@users.noreply.github.com> * Fix typerror deploy new agent Safari 12 (#3289) * Fix unsupported function in Safari 12 * Update changelog Co-authored-by: Antonio <34042064+Desvelao@users.noreply.github.com> * Fix 3209/improving and removing WUI error logs (#3260) * Improving and removing WUI error logs * Fix * Added Changelog * Comment upgrades * Adding contant to tryCatchForIndexPermissionError * Fixes * More fixes and upgrades * fix(server): Moved a server log in /api/check-stored endpoint - Moved a server log in endpoint - Renamed variable in monitoring job * fix(monitoring): Replaced multiple try/catch block by one. Co-authored-by: Desvelao <iamdesvelao@gmail.com> Co-authored-by: Antonio <34042064+Desvelao@users.noreply.github.com> * Fix/graph single api 3239 (#3256) * Added filter for current api in kibana-vis The Evolution graph in agents/ should display only the status of agents that belong to the selected API * Fixed partial matches Fixed issue where a manager whose name is a substring of another's would show data from both * Added a getManagers method to agents preview This method requests the managers from the current API and extracts the unique occurence of each of the managers, returning a list of the names of all the managers the agents in the current API have. Also modified the filter in kibana-vis so it makes use of an array of managers instead of a single one. * Updated CHANGELOG * Changed the filter parameters from manager to cluster name Seeing how the only way to find the complete list of managers is getting the complete list of agents, and this being possibly taxing on the API, the filter dependency has been switched to `cluster.name` Now the graph will conflict if 2 clusters share the same name instead of 2 managers. * Applied formating and adjusted filter metadata * Added logic to pick a filter for manager or cluster when appropriate * fix(monitoring): Moved the filter of agents evolution visualization to KibanaVis Co-authored-by: Desvelao <iamdesvelao@gmail.com> * changelog: Fix changes in revision 4202 * [SCA] Fix the render of the checks in a SCA check (#3297) * fix(sca): Fix the render of the checks in a SCA check - Now display each check.rule * changelog: Add PR to changelog * add session token to rulest (#3257) * add session token to rulest * add changelog * fix code * fix packge json * bufix(logtest): Replaced request to get token. We have a token for this session on the return of the PUT logtest. * docs(changelog): Fixed format and messages * bugfix(logtest): Replaced promise.all, we need take token for the next request. * fix(logtest): Use the same token generated in the first request to another logs * fix(logtest): Add control when the token was gotten * fix(logtest): Fix variable when got the token * Added buttom to clear session in logtest and add control of logtest token to Redux * Update logtest.tsx * [Health check] Add logs with the details about the check (#3258) * feat(health-check): Add logs to the check of Health check - Add logs to checks - Add button to open/close the check logs - Add new section to Settings: Miscellaneous - Add control when the health chekc is run in `debug` mode (no redirection after cheks are ready) - Refactor some functions - Some ajustments to Settins secions related to spaces * fix(health-check): Fix health check redirection and update tests - Fix health check redirection when all checks are ready - Update health check tests * feat(health-check): Remove notification when opening the check logs and there is some check action * fix(health-check): Fix unknown error and added improvements to notifications - Fix unknown error after restart the cluster and try to pass the health check - Remove the notification dot of check details when open for first time - Display the check details button when there are logs - Updated the tests (snapshot and tests) * Remove status text. Improve styles. Small log text fix * Added animated codeblock transition * Fixed react warnings * Fixed animation style * Fixed unit test * Only show log button when error or debug mode * updated unit test snapshots * Fix typo * Update CHANGELOG.md * Adapt kibana integrations to public interfaces of saved objects for 7.11/7.12 (#3309) * fix: update kibana-discover and kibana-vis to 7.11 public interfaces * update[changelog]: add to changelog * fix: remove comment code * Fix alerts summary reports (#3303) * Fix some alerts summary reports * Fix date CIS CAT module * Disabled index pattern checks in Healthcheck (#3311) * feat(health-check): Add logs to the check of Health check - Add logs to checks - Add button to open/close the check logs - Add new section to Settings: Miscellaneous - Add control when the health chekc is run in `debug` mode (no redirection after cheks are ready) - Refactor some functions - Some ajustments to Settins secions related to spaces * fix(health-check): Fix health check redirection and update tests - Fix health check redirection when all checks are ready - Update health check tests * feat(health-check): Remove notification when opening the check logs and there is some check action * fix(health-check): Fix unknown error and added improvements to notifications - Fix unknown error after restart the cluster and try to pass the health check - Remove the notification dot of check details when open for first time - Display the check details button when there are logs - Updated the tests (snapshot and tests) * Remove status text. Improve styles. Small log text fix * Added animated codeblock transition * Fixed react warnings * Fixed animation style * Fixed unit test * Only show log button when error or debug mode * updated unit test snapshots * Fix typo * Disabled index pattern checks * Updated CHANGELOG * Removed awaitFor, fixed title, and label * Changed some services names * fix: refactor architecture and remove unnecessary checks * fix error agent view does not render correctly (#3306) * fix error agent view does not render correctly * update CHANGELOG.md * add new file .scss and functions declarations * prettier * Fix visualizations with dark mode background in PDF report (#3315) * Normalize visData table property for 7.12 retro-compatibility (#3323) * Use the longest value in column to get column width in PDF report tables (#3326) * Use the longest value in column to get column width * Added changelog * Improved code readability * New attributes added for integration testing (#3331) * New attributes added for integration testing * New constants added for integration testing * Added new constants files for cypress * updated selectors and atributes * Hide Wazuh breadcrumb label and Wazuh api selector css fix (#3347) * Change css breadcrumb selector + Wazuh api selector css fix * Fix/elastic UI upgrade breaking changes in 7.11 and 7.12 3318 (#3345) * Added required legend to EuiButtonGroup component * Removed deprecated withTitle on EuiPopover component * Added changelog * Improved code readability * Fix error due short graphs (#3349) * Changed the way of hiding unloaded charts by setting them to display: none instead of height * Updated changelog * Applied prettier and moved logical operations outside render return to improve legibility * Fixed a typo in changelog * Fix/3320 visualization label overlap (#3355) * Refactor of visualization definitions For each visualization, for each attribute that was a string of a JSON object, they were converted to an object inside a `JSON.stringify()` and applied the formatter in order to make them easier to read and maintain. * Added a filter true to all the line, area and histogram visualizations This should prevent any labels from ever overlapping at low widths * Fix export to csv table button 7.11 & 7.12 (#3358) * Refactor of visualization definitions For each visualization, for each attribute that was a string of a JSON object, they were converted to an object inside a `JSON.stringify()` and applied the formatter in order to make them easier to read and maintain. * Added a filter true to all the line, area and histogram visualizations This should prevent any labels from ever overlapping at low widths * Updated changelog * Added toolbar buttons to tables * Added changelog * Added changelog * Fixed changelog Co-authored-by: Manuel Gómez Castro <manuel.gomez@wazuh.com> * doc: add missing changelog for revision 4108 * doc: change 4.2.1 for revision 4202 * fix: move createGetter to common-services.ts * fix: update import for getErrorOrchestrator * fix: add Copyright comment in the new file Co-authored-by: Pablo Martínez <pablomarga@hotmail.com> Co-authored-by: Toni <34042064+Desvelao@users.noreply.github.com> Co-authored-by: Gabriel Wassan <gabriel.wassan@wazuh.com> Co-authored-by: Alejandro Cuéllar Peinado <alejandro.cuellar@wazuh.com> Co-authored-by: sortizowlh <47242022+sortizowlh@users.noreply.github.com> Co-authored-by: Federico Rodriguez <federico.rodriguez@wazuh.com> Co-authored-by: Ezequiel Airaudo <36004787+eze9252@users.noreply.github.com> Co-authored-by: mpRegalado <80431234+mpRegalado@users.noreply.github.com> Co-authored-by: Maximiliano Ibarra <maximilianoaibarra@gmail.com> Co-authored-by: Ibarra Maximiliano <maximiliano.ibarra@wazuh.com> Co-authored-by: Pablo Martínez <pablo.martinez@wazuh.com> Co-authored-by: Desvelao <iamdesvelao@gmail.com> Co-authored-by: Matias Ezequiel Moreno <49887871+matiasmoreno876@users.noreply.github.com> Co-authored-by: Manuel Gómez Castro <manuel.gomez@wazuh.com>

Desvelao added the type/enhancement Enhancement issue label May 18, 2021

Desvelao requested a review from a team May 18, 2021 14:24

Desvelao self-assigned this May 18, 2021

Desvelao marked this pull request as draft May 18, 2021 15:03

Desvelao linked an issue May 18, 2021 that may be closed by this pull request

Remove WUI index pattern messages #3208

Closed

fix(health-check): Fix health check redirection and update tests

23732f4

- Fix health check redirection when all checks are ready - Update health check tests

Desvelao marked this pull request as ready for review May 19, 2021 09:28

CPAlejandro suggested changes May 19, 2021

View reviewed changes

Desvelao mentioned this pull request May 19, 2021

Fix broke format in discover after manual refresh of the index pattern #3245

Closed

feat(health-check): Remove notification when opening the check logs a…

21b9579

…nd there is some check action

CPAlejandro reviewed May 24, 2021

View reviewed changes

Desvelao requested review from CPAlejandro and a team May 24, 2021 11:17

CPAlejandro reviewed May 24, 2021

View reviewed changes

pablomarga approved these changes May 24, 2021

View reviewed changes

CPAlejandro approved these changes May 25, 2021

View reviewed changes

Desvelao requested a review from a team May 25, 2021 10:54

asteriscos added 2 commits May 25, 2021 18:37

Remove status text. Improve styles. Small log text fix

70a6158

Added animated codeblock transition

9bc8b4b

asteriscos reviewed May 26, 2021

View reviewed changes

asteriscos added 3 commits May 26, 2021 13:08

Fixed react warnings

05a79ae

Fixed animation style

31194b8

Fixed unit test

c2af4ef

frankeros suggested changes May 27, 2021

View reviewed changes

Only show log button when error or debug mode

2558b02

asteriscos requested review from frankeros, pablomarga and CPAlejandro May 28, 2021 11:59

updated unit test snapshots

e5b77ec

CPAlejandro approved these changes May 28, 2021

View reviewed changes

asteriscos self-assigned this May 28, 2021

pablomarga approved these changes May 28, 2021

View reviewed changes

asteriscos and others added 2 commits May 28, 2021 18:38

Fix typo

b6b1722

Update CHANGELOG.md

8a04a44

frankeros approved these changes May 31, 2021

View reviewed changes

Merge branch '4.2-7.10' into healthcheck/3208-add-verbose-check-logs-…

e4fc094

…and-special-mode

frankeros merged commit 90540d4 into 4.2-7.10 May 31, 2021

frankeros deleted the healthcheck/3208-add-verbose-check-logs-and-special-mode branch May 31, 2021 17:30

MauGaP mentioned this pull request Sep 1, 2021

Regression Wazuh app 4.2.2 r4202 #3537

Closed

46 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Health check] Add logs with the details about the check #3258

[Health check] Add logs with the details about the check #3258

Desvelao commented May 18, 2021 •

edited

Loading

CPAlejandro left a comment

Desvelao commented May 20, 2021 •

edited

Loading

Desvelao commented May 21, 2021

CPAlejandro left a comment

Desvelao commented May 24, 2021 •

edited

Loading

CPAlejandro left a comment

pablomarga left a comment

Desvelao commented May 25, 2021

asteriscos commented May 25, 2021

asteriscos May 26, 2021

frankeros left a comment

frankeros May 27, 2021

asteriscos May 28, 2021

asteriscos commented May 28, 2021

CPAlejandro left a comment

pablomarga left a comment

frankeros left a comment

[Health check] Add logs with the details about the check #3258

[Health check] Add logs with the details about the check #3258

Conversation

Desvelao commented May 18, 2021 • edited Loading

Description

Checks

Suggested improvements

CPAlejandro left a comment

Choose a reason for hiding this comment

Desvelao commented May 20, 2021 • edited Loading

Desvelao commented May 21, 2021

CPAlejandro left a comment

Choose a reason for hiding this comment

Desvelao commented May 24, 2021 • edited Loading

Changes

CPAlejandro left a comment

Choose a reason for hiding this comment

pablomarga left a comment

Choose a reason for hiding this comment

Desvelao commented May 25, 2021

asteriscos commented May 25, 2021

asteriscos May 26, 2021

Choose a reason for hiding this comment

frankeros left a comment

Choose a reason for hiding this comment

frankeros May 27, 2021

Choose a reason for hiding this comment

asteriscos May 28, 2021

Choose a reason for hiding this comment

asteriscos commented May 28, 2021

CPAlejandro left a comment

Choose a reason for hiding this comment

pablomarga left a comment

Choose a reason for hiding this comment

frankeros left a comment

Choose a reason for hiding this comment

Desvelao commented May 18, 2021 •

edited

Loading

Desvelao commented May 20, 2021 •

edited

Loading

Desvelao commented May 24, 2021 •

edited

Loading