Skip to content
New issue

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

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

Already on GitHub? # to your account

Extend Audit Log Documentation #13260

Open
markusmann-vg opened this issue Feb 5, 2025 · 0 comments
Open

Extend Audit Log Documentation #13260

markusmann-vg opened this issue Feb 5, 2025 · 0 comments
Labels
task Something to be done that does not directly affect the software

Comments

@markusmann-vg
Copy link

markusmann-vg commented Feb 5, 2025

Problem Description

Create extended comprehensive documentation for the Audit Log to ensure transparency and clarity regarding its modifications, storage, encryption, and usage.

Current state of documentation: https://github.com/SORMAS-Foundation/SORMAS-Project/wiki/Auditing-&-Data-History

Use Case:
"Identify Modifications Within a Specific Time Period"

Outline how to retrieve information about:

  • What modifications have been made within a defined timeframe.
  • Who made the changes (user identification, role, etc.).
  • Include sample queries or API calls (if applicable).

Proposed Solution

Tasks:
Storage Details:
Describe how the audit log is stored (e.g., database, file system, cloud storage).
Specify data retention policies and backup strategies.

Encryption & Security:
Explain the encryption mechanisms in place (at-rest, in-transit).
Detail access control and security protocols to safeguard the audit log.

Usage Information:
Provide examples of how the audit log can be queried or accessed.
Clarify what specific data points are included in the log (e.g., timestamps, user IDs, actions).

Acceptance Criteria

  • Clear, structured documentation is available in the repository.
  • Includes technical details, use cases, and examples.
  • Reviewed and approved by the relevant technical lead or team.

Additional Information

No response

@markusmann-vg markusmann-vg added the task Something to be done that does not directly affect the software label Feb 5, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
task Something to be done that does not directly affect the software
Projects
None yet
Development

No branches or pull requests

1 participant