feat(logging): implement logging strategy and framework

[finxo]

Summary

Establish a comprehensive logging strategy and implement a logging framework for the application to ensure consistent, structured, and maintainable logging practices across the codebase.

Description

Currently, the application lacks a defined logging proposal and strategy. This issue tracks the research, design, and implementation of an appropriate logging solution that meets our application's needs.

Objectives

• Research and evaluate logging frameworks/libraries suitable for our tech stack
• Define logging levels and their appropriate use cases (DEBUG, INFO, WARN, ERROR, FATAL)
• Establish logging format standards (structured logging, log rotation, etc.)
• Determine log storage and retention policies
• Design logging strategy for different environments (development, staging, production)
• Implement the chosen logging solution
• Create documentation and guidelines for developers

Considerations

• Performance: Minimal impact on application performance
• Structured Logging: Support for structured/JSON logging for easier parsing and analysis
• Context: Ability to include contextual information (request IDs, user IDs, etc.)
• Log Levels: Configurable log levels per environment
• Integration: Compatibility with log aggregation tools (e.g., ELK Stack, Splunk, CloudWatch)
• Security: Ensure sensitive data is not logged (PII, credentials, etc.)
• Rotation: Log rotation and retention policies

Tasks

• Research available logging frameworks and compare their features
• Define logging standards and best practices document
• Create proof of concept with recommended solution
• Implement logging infrastructure
• Add logging to critical application paths
• Set up log aggregation/monitoring (if applicable)
• Document usage guidelines for the team
• Conduct team review and training

Acceptance Criteria

• Logging framework is integrated and operational
• Documentation is available for developers
• Logging standards are defined and approved
• Critical application flows include appropriate logging
• Logs are accessible and searchable in configured environment(s)