Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Exploratory debug symbols & core dump analysis Agent (DEB) #23454

Closed
9 tasks done
Tracked by #21739
ncvicchi opened this issue May 15, 2024 · 4 comments
Closed
9 tasks done
Tracked by #21739

Exploratory debug symbols & core dump analysis Agent (DEB) #23454

ncvicchi opened this issue May 15, 2024 · 4 comments
Assignees
Labels
level/subtask type/enhancement New feature or request

Comments

@ncvicchi
Copy link
Member

ncvicchi commented May 15, 2024

Related issue
#21736
#21739

Description

This issue aims to make a exploratory session of current #9913 phase 1 development for the Agent instance of the DEB package.

Verifications should be performed on the following issues to check end to end the process from generation of symbols to core/crash dump analysis with them.

These verifications must be performed by a different collaborator than the originally assigned to the issue, and a full detail of procedures, logs and results must be provided.
Evidence of success must be provided as well.

Goals

  • Verify that binary and debug symbols packages are correctly generated by following the current documentation
  • Verify that binary & debug symbols packages are automatically uploaded to their designated locations.
  • Verify that packages perform a successful installation by following the current documentation.
  • Verify that the installed agent instance runs successfully.
  • Verify that a core dump is generated on simulated failure.
  • Verify that debug symbols are suitable to debug/analyze the core dumps.
  • Verify that the documentation used during all the exploratory is adequate, correct and complete.
  • Verify that core dump generation can be enabled and disabled just by following the proper documentation.

DoD

  • Packages for binaries and debug symbols are generated by following documentation. @ncvicchi
  • Packages are confirmed to be uploaded to their designated location. @jotacarma90
  • Installation is tested and validated.
  • Installed agent behaves as expected.
  • A simulation of failure is performed and as a result a core dump is generated.
  • Core dump is successfully analyzed by using the corresponding debug symbols.
  • No documentation errors are found or left uncorrected. @ncvicchi
  • Core dump generation is validated to be enabled or disabled just by following the proper documentation.
  • Extensive evidence and documentation of the exploratory is provided

Approval
DRI Name: @ncvicchi
Objective: Generate debug symbols

@aritosteles
Copy link
Contributor

aritosteles commented May 20, 2024

Test completed

1. Cloned wazuh/wazuh repository:

- git clone https://github.com/wazuh/wazuh.git
- checkout enhancement/9913-generate-debug-symbols-epic

2. Installed dependencies:

- Docker: https://documentation.wazuh.com/current/deployment-options/docker/docker-installation.html
- Gcc, Cmake, etc: https://documentation.wazuh.com/current/deployment-options/wazuh-from-sources/wazuh-server/index.html

3. Generated rpm packages:

./generate_package.sh -t agent --system deb

1-package-build

4. Installed the manager and debug symbols:

2-package-installation

5. Restarted Wazuh:

3-wazuh-restart

6. Configured coredump:

4-coredump-conf

7. Restarted systemd-coredump and requested status:

5-coredump-restart-and-status

8. Got list of Wazuh processes, generated crash and checked for core dump generation:

6-kill-process-check-coredump

9. Unzipped core dump file.

10. Gdb output:

7-gdb-output

@ncvicchi ncvicchi self-assigned this May 20, 2024
@ncvicchi
Copy link
Member Author

Blocked until access to wazuh internal repositories is provided

@Dwordcito
Copy link
Member

@jotacarma90 will check if the debug symbols are uploaded to s3

@Dwordcito Dwordcito changed the title Exploratory extensive testing to ensure reliability and performance of debug symbols & core dump analysis Agent (DEB) Exploratory debug symbols & core dump analysis Agent (DEB) May 31, 2024
@aritosteles
Copy link
Contributor

aritosteles commented May 31, 2024

Fixed some issues in the workflow and ran successfully:
Workflow run

Pull request

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
level/subtask type/enhancement New feature or request
Projects
Status: Done
Development

No branches or pull requests

5 participants