Rebits commented 3 months ago

Description

Develop a monitoring class to collect process data within the Wazuh environment. This class should track various aspects of process performance, such as CPU usage, memory consumption, etc. The data collected will be used to analyze and optimize the performance of the Wazuh agent.

Overview

We are considering using existing tools for this task, specifically the QA Monitor class. This issue involves checking the current status of the monitor class, fixing any pending bugs, and adding any new capabilities needed to fulfill the requirements.

Functional requirements

The Python module should monitor all Wazuh component processes, generating a CSV with the collected values for each timestamp.
The Python module should track the disk usage of the Wazuh installation over time.
A Python script should be capable of launching process monitoring.
A Python script should be capable of launching disk partition monitoring.

Tasks

[x] Research the current issues of the monitoring class in the Wazuh-qa repository and fix them if necessary to meet the requirements.
[x] Research which metrics should be included in the desired monitoring modules.
[x] Create a new module capable of tracking disk usage.
[x] Create a Python script to use these modules on an endpoint easily

Validation

[ ] Proof of concept (PoC) of monitoring capabilities in a real environment for the agent, server, indexer, and dashboard.

jseg380 commented 3 months ago

In a meeting with @Rebits some questions about the issue were clarified. These inquiries were the following:

Add the missing key metrics seems to not specify which are the key metrics that already exist
Research metrics to monitor the mentioned resources (such as CPU usage, memory consumption, and runtime duration). There are numerous metrics for tracking the aforementioned resources, therefore I find highly difficult to make a good choice all by myself on what metrics should be chosen.
It is mentioned that bugs of the current QA Monitor class should be fixed, but no links to those bugs are provided and after searching the issues in the repo nothing was found but I am unsure if I was using the wrong keywords.
When talking about the disk usage of the installation over time it wasn't specified whether logs should be taken into account but as @Rebits said it makes sense to exclude them.
Also one task includes creating a new module for monitoring disk usage and it is alluded several times about having multiple modules instead of one. It has been decided that it will be up to the assignee.

jseg380 commented 3 months ago

Refactored current script to make use of "advanced" type hinting (making use of the typing module). Started modularization of Monitor and different logging classes. Researched references made to the Monitor class, only found wazuh_metrics.py. Extensive research about PEP 8 – Style Guide for Python Code.