Replace the plugin logging system by the provided by the platform #6161

Desvelao · 2023-11-28T09:54:57Z

Description

This pull request replaces the custom logging service with the one provided by the platform.

Changes:

Add the wazuhCore plugin as dependency of main
Remove the logs.level setting
Replace the custom logging service with the one provided by the platform
- Remove BaseLogger, log and uiLogger services
- Create scoped server platform loggers with tags
- Remove unused winston dependency used by the custom logger
  - yarn.lock files were updated
Move some services from the main to the core plugin, adapt its usage, and replace the logging service
- CacheAPIUserAllowRunAs
- ManageHosts
- ServerAPIClient (aka api-interceptor)
- ServerAPIHostEntries (aka manage-hosts)
- UpdateConfigurationFile
- UpdateRegistry
- dashboardSecurity (aka SecurityObj)
Added some logs to server side
Remove constants that define the path to log files
Remove App logs application
Remove API endpoint
- GET /utils/logs/ui (unused by the frontend side)
- GET /utils/logs
Remove unused code
Replace the usage of endpoint controllers to get data in the statistics and monitoring by core services

Issues Resolved

#6137

Evidence

Logs starting the platform:

server    log   [10:16:58.708] [info][initialize][plugins][wazuh] Wazuh dashboard index: .kibana
server    log   [10:16:58.708] [info][initialize][plugins][wazuh] App revision: 00
server    log   [10:16:58.714] [info][initialize][plugins][wazuh] Total RAM: 15922MB
server    log   [10:17:00.310] [info][initialize][plugins][wazuh] Configuration registry saved.
server    log   [10:17:00.358] [error][data][opensearch] [ResponseError]: Response Error
server    log   [10:17:00.360] [error][data][opensearch] [ResponseError]: Response Error
server    log   [10:17:00.469] [info][monitoring][plugins][wazuh] Updated the wazuh-agent template
server    log   [10:17:00.594] [info][listening] Server running at https://0.0.0.0:5601
server    log   [10:17:00.745] [info][cron-scheduler][plugins][wazuh] Updated the wazuh-statistics template
server    log   [10:17:00.763] [info][server][OpenSearchDashboards][http] http server running at https://0.0.0.0:5601
server    log   [10:17:00.777] [error][monitoring][plugins][wazuh] getaddrinfo ENOTFOUND wazuh.manager
server    log   [10:17:06.430] [info][monitoring][plugins][wazuh] wazuh-monitoring-2023.48w index created
server    log   [10:17:06.441] [info][monitoring][plugins][wazuh] Settings added to wazuh-monitoring-2023.48w index
server    log   [10:17:06.751] [info][monitoring][plugins][wazuh] Bulk data to index wazuh-monitoring-2023.48w for 7 agents completed
server    log   [10:17:06.753] [error][monitoring][plugins][wazuh] Invalid URL

Test

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

UI

Test	Chrome	Firefox	Safari
The logs.level setting should not appear in the App settings application	⚫	⚫	⚫
The App logs application should not appear in the side bar menu	⚫	⚫	⚫

Details

⚫ The logs.level setting should not appear in the App settings application

Chrome - ⚫

Firefox - ⚫

Safari - ⚫

⚫ The App logs application should not appear in the side bar menu

Chrome - ⚫

Firefox - ⚫

Safari - ⚫

Backend

Test	Result
The default wazuh.yml should not contain the logs.level setting	⚫
Logs of monitoring task should use the platform logging	⚫
Logs of statistics task should use the platform logging	⚫
Logs of initialize task should use the platform logging	⚫
Logs of queue task should use the platform logging	⚫
Logs of migration task should use the platform logging	⚫
Logs of check updates plugin should use the platform logging	⚫
Logs of core plugin should use the platform logging	⚫

Details

⚫ The default wazuh.yml should not contain the logs.level setting

⚫ Logs of monitoring task should use the platform logging

⚫ Logs of statistics task should use the platform logging

⚫ Logs of initialize task should use the platform logging

⚫ Logs of queue task should use the platform logging

⚫ Logs of migration task should use the platform logging

⚫ Logs of check updates plugin should use the platform logging

⚫ Logs of core plugin should use the platform logging

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

- Enhance the logging messages - Minor enhancements

- Replace the logging services - Move services to core plugin - CacheAPIUserAllowRunAs - ManageHosts - ServerAPIClient (aka api-interceptor) - ServerAPIHostEntries (aka ) - UpdateConfigurationFile - UpdateRegistry - Adapt the usage of services in the main and check updates plugin from core plugin - Remove plugin logger from main and core plugins - Remove API endpoint - GET /utils/logs/ui - Remove unused code - Adapt the test suites

…to enhancement/6137-adapt-logging-method

… yarn.lock files

…to enhancement/6137-adapt-logging-method

- Remove GET /utils/logs endpoint - Remove related tests - Remove App logs application

JuanGarriuz · 2023-12-18T09:16:24Z

Logs starting app

Test

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

UI

Test	Chrome	Firefox	Safari
The logs.level setting should not appear in the App settings application	🟢	⚫	⚫
The App logs application should not appear in the side bar menu	🟢	⚫	⚫

Details

🟢 The logs.level setting should not appear in the App settings application

Chrome - 🟢

Firefox - ⚫

Safari - ⚫

🟢 The App logs application should not appear in the side bar menu

Chrome - 🟢

Firefox - ⚫

Safari - ⚫

Backend

Test	Result
The default wazuh.yml should not contain the logs.level setting	🟢
Logs of monitoring task should use the platform logging	🟢
Logs of statistics task should use the platform logging	🟢
Logs of initialize task should use the platform logging	🟢
Logs of queue task should use the platform logging	🟢
Logs of migration task should use the platform logging	🟢
Logs of check updates plugin should use the platform logging	🟢
Logs of core plugin should use the platform logging	🟢

Details

🟢 The default wazuh.yml should not contain the logs.level setting

🟢 Logs of monitoring task should use the platform logging

🟢Logs of statistics task should use the platform logging

🟢 Logs of initialize task should use the platform logging

🟢 Logs of queue task should use the platform logging

🟢 Logs of migration task should use the platform logging

🟢 Logs of check updates plugin should use the platform logging

🟢 Logs of core plugin should use the platform logging

JuanGarriuz

LGTM!!

github-actions · 2023-12-26T14:34:52Z

Wazuh Core plugin code coverage (Jest) test	%	values
Statements	22.02%	( 176 / 799 )
Branches	19.55%	( 79 / 404 )
Functions	14.63%	( 36 / 246 )
Lines	22.23%	( 173 / 778 )

github-actions · 2023-12-26T14:34:58Z

Wazuh Check Updates plugin code coverage (Jest) test	%	values
Statements	76.33%	( 171 / 224 )
Branches	57.57%	( 57 / 99 )
Functions	61.7%	( 29 / 47 )
Lines	76.33%	( 171 / 224 )

yenienserrano · 2023-12-26T14:35:59Z

Test

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

UI

Test	Chrome	Firefox	Safari
The logs.level setting should not appear in the App settings application	🟢	⚫	⚫
The App logs application should not appear in the side bar menu	🟢	⚫	⚫

Details

🟢 The logs.level setting should not appear in the App settings application

Chrome - 🟢

Firefox - ⚫

Safari - ⚫

🟢 The App logs application should not appear in the side bar menu

Chrome - 🟢

Firefox - ⚫

Safari - ⚫

Backend

Test	Result
The default wazuh.yml should not contain the logs.level setting	🟢
Logs of monitoring task should use the platform logging	🟢
Logs of statistics task should use the platform logging	⚫
Logs of initialize task should use the platform logging	🟢
Logs of queue task should use the platform logging	⚫
Logs of migration task should use the platform logging	⚫
Logs of check updates plugin should use the platform logging	⚫
Logs of core plugin should use the platform logging	⚫

Details

🟢 The default wazuh.yml should not contain the logs.level setting

🟢 Logs of monitoring task should use the platform logging

⚫ Logs of statistics task should use the platform logging

🟢 Logs of initialize task should use the platform logging

⚫ Logs of queue task should use the platform logging

⚫ Logs of migration task should use the platform logging

⚫ Logs of check updates plugin should use the platform logging

⚫ Logs of core plugin should use the platform logging

github-actions · 2023-12-26T14:39:05Z

Main plugin code coverage (Jest) test	%	values
Statements	11.3%	( 3897 / 34473 )
Branches	7.51%	( 1714 / 22815 )
Functions	10.9%	( 898 / 8232 )
Lines	11.48%	( 3788 / 32993 )

yenienserrano

LGTM

Desvelao added 6 commits November 21, 2023 09:32

feat(logging): remove plugin logger from start tasks of main plugin

701b9aa

- Enhance the logging messages - Minor enhancements

feat(logging): minor fixes to logging messages in the main plugin

70f02f4

feat(logging): remove custom logger from endpoints of main plugin

c3ba9d1

fix(logging): remove parameter of addJobToQueue

7c34345

Merge branch 'master' of https://github.com/wazuh/wazuh-kibana-app in…

283788e

…to enhancement/6137-adapt-logging-method

Desvelao self-assigned this Nov 28, 2023

Desvelao linked an issue Nov 28, 2023 that may be closed by this pull request

Adapt the logging method of the plugins to the provided by the platform #6137

Closed

19 tasks

Desvelao and others added 13 commits November 28, 2023 12:27

feat(logging): removed constants related to log files path

842b4a3

fix(dependency): removed winston dependency of plugins and update the…

dad9274

… yarn.lock files

fix(logging): removed logs.level plugin setting

3914913

fix(logging): fixed monitoring and statistics backend tasks

20ed9bc

Merge branch 'master' of https://github.com/wazuh/wazuh-kibana-app in…

dba3e2f

…to enhancement/6137-adapt-logging-method

fix(monitoring): manage API host entries

2d0053b

feat(core): add description to core services classes

a9de346

feat(docs): add docs to core plugin

20b0f90

feat(docs): add description to core services

9ca647e

test: fix of check updates plugin

54187b5

test: fix of check updates plugin

efc99e2

feat(logging): remove the App logs application

d726682

- Remove GET /utils/logs endpoint - Remove related tests - Remove App logs application

Merge branch 'master' into enhancement/6137-adapt-logging-method

ab731fc

Desvelao marked this pull request as ready for review December 11, 2023 12:58

Desvelao requested a review from a team as a code owner December 11, 2023 12:58

JuanGarriuz approved these changes Dec 20, 2023

View reviewed changes

yenienserrano and others added 2 commits December 26, 2023 13:20

Merge branch 'master' into enhancement/6137-adapt-logging-method

f11c6ef

Fix test

fb180fb

yenienserrano approved these changes Dec 26, 2023

View reviewed changes

asteriscos merged commit ff561c5 into master Dec 27, 2023
4 checks passed

asteriscos deleted the enhancement/6137-adapt-logging-method branch December 27, 2023 09:46

tsarquis88 mentioned this pull request Sep 17, 2024

Deprecated file wazuhapp.log mentions present in 4.9 documentation #6997

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace the plugin logging system by the provided by the platform #6161

Replace the plugin logging system by the provided by the platform #6161

Desvelao commented Nov 28, 2023 •

edited

Loading

JuanGarriuz commented Dec 18, 2023 •

edited

Loading

JuanGarriuz left a comment

github-actions bot commented Dec 26, 2023

github-actions bot commented Dec 26, 2023

yenienserrano commented Dec 26, 2023 •

edited

Loading

github-actions bot commented Dec 26, 2023

yenienserrano left a comment

Replace the plugin logging system by the provided by the platform #6161

Replace the plugin logging system by the provided by the platform #6161

Conversation

Desvelao commented Nov 28, 2023 • edited Loading

Description

Issues Resolved

Evidence

Test

UI

Backend

Check List

JuanGarriuz commented Dec 18, 2023 • edited Loading

Logs starting app

Test

UI

Backend

JuanGarriuz left a comment

Choose a reason for hiding this comment

github-actions bot commented Dec 26, 2023

github-actions bot commented Dec 26, 2023

yenienserrano commented Dec 26, 2023 • edited Loading

Test

UI

Backend

github-actions bot commented Dec 26, 2023

yenienserrano left a comment

Choose a reason for hiding this comment

Desvelao commented Nov 28, 2023 •

edited

Loading

JuanGarriuz commented Dec 18, 2023 •

edited

Loading

yenienserrano commented Dec 26, 2023 •

edited

Loading