Tech synopsis

1. Audit logs

Audit logs are essential for tracking key events in the application, such as user actions, system events, and access to sensitive resources, to maintain compliance, detect anomalies, and facilitate troubleshooting.

  • Apache Log4j

    • It is a versatile, industrial-grade Java logging framework composed of an API, its implementation, and components to assist the deployment for various use cases. The project is actively maintained by a team of volunteers and supported by a big community.

  • Reliability

    • Log4j is built with solid reliability in mind. It can automatically reload its configuration upon modification and will do so without losing log events while reconfiguration occurs.

  • Performance

    • When configured correctly, Log4j can deliver excelling performance without almost any burden on the Java garbage collector, and it will do so without sacrificing reliability.

For detailed information, refer Apache Log4j

2. Persistence

This section outlines our persistence strategy using MySQL.

  1. MySQL

    • MySQL is an open-source relational database management system that supports various storage engines, providing flexibility for different use cases.

    • It’s known for its fast data processing, MySQL is well-suited for applications requiring quick read and write operations, even with large datasets.

    • MySQL runs on various platforms, including Linux, Windows, and macOS, making it adaptable for diverse development environments.

    • MySQL offers strong scalability features, supporting high-volume applications and the ability to scale vertically or horizontally.

    • MySQL provides secure authentication, data encryption, and fine-grained access control to ensure data integrity and confidentiality.

    For detailed information, refer MySQL

3. Documentation

This section covers our documentation process using Asciidoc and Antora.

  • Asciidoc provides an intuitive, readable markup language for writing documentation, while Antora organizes and generates a cohesive, navigable documentation site.

Key benefits

  • Key benefits include modular documentation, version management, and consistent styling.

  • Documentation is structured with Asciidoc syntax, organized into modules and components using Antora, and built into a user-friendly site.

  • This approach ensures maintainable, scalable, and easily accessible documentation for our users.

For detailed information refer