Make checks inside Pattern check services #5384

asteriscos · 2023-04-18T10:04:01Z

Description

Hi team,

This PR migrates the timeFilter, metaFields, maxBuckets checks inside the pattern check.

Issues Resolved

Closes #5310

Evidence

Test

To test this pull request enable or disable health-check configuration in wazuh.yml.

Pattern enabled

wazuh.yml entries to change:

checks.pattern: true
checks.metaFields: false
checks.timeFilter: false
checks.maxBuckets: false

The pattern check log should look like this:

INFO: Index pattern id in cookie: yes [wazuh-alerts-*]
INFO: Getting list of valid index patterns...
INFO: Valid index patterns found: 1
INFO: Found default index pattern with title [wazuh-alerts-*]: yes
INFO: Checking the app default pattern exists: id [wazuh-alerts-*]...
INFO: Default pattern with id [wazuh-alerts-*] exists: yes
ACTION: Default pattern id [wazuh-alerts-*] set as default index pattern
INFO: Checking the index pattern id [wazuh-alerts-*] exists...
INFO: Index pattern id exists [wazuh-alerts-*]: yes
INFO: Index pattern id in cookie: yes [wazuh-alerts-*]
INFO: Checking if the index pattern id [wazuh-alerts-*] exists...
INFO: Index pattern id [wazuh-alerts-*] found: yes title [wazuh-alerts-*]
INFO: Checking if exists a template compatible with the index pattern title [wazuh-alerts-*]
INFO: Template found for the selected index-pattern title [wazuh-alerts-*]: yes
INFO: Index pattern id in cookie: [wazuh-alerts-*]
INFO: Getting index pattern data [wazuh-alerts-*]...
INFO: Index pattern data found: [yes]
INFO: Refreshing index pattern fields: title [wazuh-alerts-*], id [wazuh-alerts-*]...
ACTION: Refreshed index pattern fields: title [wazuh-alerts-*], id [wazuh-alerts-*]
INFO: Check [maxBuckets]: disabled. Skipped.
INFO: Check [metaFields]: disabled. Skipped.
INFO: Check [timeFilter]: disabled. Skipped.

Pattern disabled

wazuh.yml entries to change:

checks.pattern: false
checks.metaFields: true
checks.timeFilter: true
checks.maxBuckets: true

The pattern check log should look like this:

INFO: Check [pattern]: disabled. Some minimal tasks will be done.
INFO: Index pattern id in cookie: yes [wazuh-alerts-*]
INFO: Getting list of valid index patterns...
INFO: Valid index patterns found: 1
INFO: Found default index pattern with title [wazuh-alerts-*]: yes
INFO: Checking the app default pattern exists: id [wazuh-alerts-*]...
INFO: Default pattern with id [wazuh-alerts-*] exists: yes
ACTION: Default pattern id [wazuh-alerts-*] set as default index pattern
INFO: Checking the index pattern id [wazuh-alerts-*] exists...
INFO: Index pattern id exists [wazuh-alerts-*]: yes
INFO: Index pattern id in cookie: yes [wazuh-alerts-*]
INFO: Checking if the index pattern id [wazuh-alerts-*] exists...
INFO: Index pattern id [wazuh-alerts-*] found: yes title [wazuh-alerts-*]
INFO: Checking if exists a template compatible with the index pattern title [wazuh-alerts-*]
INFO: Template found for the selected index-pattern title [wazuh-alerts-*]: yes
INFO: Index pattern id in cookie: [wazuh-alerts-*]
INFO: Getting index pattern data [wazuh-alerts-*]...
INFO: Index pattern data found: [yes]
INFO: Refreshing index pattern fields: title [wazuh-alerts-*], id [wazuh-alerts-*]...
ACTION: Refreshed index pattern fields: title [wazuh-alerts-*], id [wazuh-alerts-*]
INFO: Getting settings...
INFO: Check Wazuh dashboard setting [timeline:max_buckets]: 200000
INFO: App setting [timeline:max_buckets]: 200000
INFO: Settings mismatch [timeline:max_buckets]: no
INFO: Getting settings...
INFO: Check Wazuh dashboard setting [metaFields]: ["_source","_index"]
INFO: App setting [metaFields]: ["_source","_index"]
INFO: Settings mismatch [metaFields]: no
INFO: Getting settings...
INFO: Check Wazuh dashboard setting [timepicker:timeDefaults]: {"from":"now-24h","to":"now"}
INFO: App setting [timepicker:timeDefaults]: "{\"from\":\"now-24h\",\"to\":\"now\"}"
INFO: Settings mismatch [timepicker:timeDefaults]: no

Check List

All tests pass
- yarn test:jest
New functionality includes testing.
New functionality has been documented.
Update CHANGELOG.md
Commits are signed per the DCO using --signoff

public/components/health-check/services/check-index-pattern/check-index-pattern.service.ts

Desvelao · 2023-04-18T10:17:22Z

There are some unused variables in public/components/health-check/container/health-check.container.tsx

…checks-5310

Desvelao · 2023-04-18T11:50:35Z

Wazuh dashboard

Legend:
⚫: none
🟢: pass
🟡: warning
🔴: fail
⚪: not applicable

UI

Test	Chrome
With the `checks.pattern` enabled, enable the `checks.maxBuckets`, `checks.metaFields` and `checks.timeFilter`, the platform setting checks should run and update the change if needed	🟢
With the `checks.pattern` disabled, enable the `checks.maxBuckets`, `checks.metaFields` and `checks.timeFilter`, the platform setting checks should run and update the change if needed	🟢
With the `checks.pattern` disabled, disable the `checks.maxBuckets`, `checks.metaFields` and `checks.timeFilter`, the platform setting checks should not run	🟢

Details

🟢 With the `checks.pattern` enabled, enable the `checks.maxBuckets`, `checks.metaFields` and `checks.timeFilter`, the platform setting checks should run and update the change if needed

Chrome - 🟢

🟢 With the `checks.pattern` disabled, enable the `checks.maxBuckets`, `checks.metaFields` and `checks.timeFilter`, the platform setting checks should run and update the change if needed

Chrome - 🟢

🟢 With the `checks.pattern` disabled, disable the `checks.maxBuckets`, `checks.metaFields` and `checks.timeFilter`, the platform setting checks should not run

Chrome - 🟢

Desvelao

review

🟢 code
🟢 tests #5384 (comment)

yenienserrano · 2023-04-18T12:39:56Z

Wazuh dashboard

Legend:
⚫: none
🟢: pass
🟡: warning
🔴: fail
⚪: not applicable

UI

Test	Chrome
With the `checks.pattern` enabled, enable the `checks.maxBuckets`, `checks.metaFields` and `checks.timeFilter`, the platform setting checks should run and update the change if needed	🟢
With the `checks.pattern` disabled, enable the `checks.maxBuckets`, `checks.metaFields` and `checks.timeFilter`, the platform setting checks should run and update the change if needed	🟢
With the `checks.pattern` disabled, disable the `checks.maxBuckets`, `checks.metaFields` and `checks.timeFilter`, the platform setting checks should not run	🟢

Details

🟢 With the `checks.pattern` enabled, enable the `checks.maxBuckets`, `checks.metaFields` and `checks.timeFilter`, the platform setting checks should run and update the change if needed

Chrome - 🟢

🟢 With the `checks.pattern` disabled, enable the `checks.maxBuckets`, `checks.metaFields` and `checks.timeFilter`, the platform setting checks should run and update the change if needed

Chrome - 🟢

🟢 With the `checks.pattern` disabled, disable the `checks.maxBuckets`, `checks.metaFields` and `checks.timeFilter`, the platform setting checks should not run

Chrome - 🟢

* Make checks inside Pattern check services * Add changelog * refactor checkPluginPlatformSettings and code cleaning (cherry picked from commit 41d9a3f)

Make checks inside Pattern check services (#5384) * Make checks inside Pattern check services * Add changelog * refactor checkPluginPlatformSettings and code cleaning (cherry picked from commit 41d9a3f) Co-authored-by: Federico Rodriguez <federico.rodriguez@wazuh.com>

Make checks inside Pattern check services

0804342

asteriscos requested a review from a team as a code owner April 18, 2023 10:04

asteriscos self-assigned this Apr 18, 2023

asteriscos linked an issue Apr 18, 2023 that may be closed by this pull request

Move settings checks to alerts index check on health check page #5310

Closed

2 tasks

Add changelog

6aca32c

Desvelao reviewed Apr 18, 2023

View reviewed changes

public/components/health-check/services/check-index-pattern/check-index-pattern.service.ts Outdated Show resolved Hide resolved

asteriscos added 2 commits April 18, 2023 12:41

refactor checkPluginPlatformSettings and code cleaning

a86db55

Merge branch '4.5' into enhance/move-settings-checks-to-alerts-index-…

5011ef2

…checks-5310

Desvelao approved these changes Apr 18, 2023

View reviewed changes

asteriscos added backport 4.5-7.10 backport 4.5-7.16 labels Apr 18, 2023

yenienserrano approved these changes Apr 18, 2023

View reviewed changes

asteriscos merged commit 41d9a3f into 4.5 Apr 18, 2023
4 of 5 checks passed

asteriscos deleted the enhance/move-settings-checks-to-alerts-index-checks-5310 branch April 18, 2023 14:51

github-actions bot mentioned this pull request Apr 18, 2023

[Backport 4.5-7.10] Make checks inside Pattern check services #5386

Merged

github-actions bot mentioned this pull request Apr 18, 2023

[Backport 4.5-7.16] Make checks inside Pattern check services #5387

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make checks inside Pattern check services #5384

Make checks inside Pattern check services #5384

asteriscos commented Apr 18, 2023

Desvelao commented Apr 18, 2023 •

edited

Desvelao commented Apr 18, 2023 •

edited

Desvelao left a comment •

edited

yenienserrano commented Apr 18, 2023 •

edited by Desvelao

Make checks inside Pattern check services #5384

Make checks inside Pattern check services #5384

Conversation

asteriscos commented Apr 18, 2023

Description

Issues Resolved

Evidence

Test

Pattern enabled

Pattern disabled

Check List

Desvelao commented Apr 18, 2023 • edited

Desvelao commented Apr 18, 2023 • edited

Wazuh dashboard

UI

Desvelao left a comment • edited

Choose a reason for hiding this comment

yenienserrano commented Apr 18, 2023 • edited by Desvelao

Wazuh dashboard

UI

Desvelao commented Apr 18, 2023 •

edited

Desvelao commented Apr 18, 2023 •

edited

Desvelao left a comment •

edited

yenienserrano commented Apr 18, 2023 •

edited by Desvelao