[SAH-61]: Define logging levels and event targets

[Emmanuel-Melon]

Overview

We need to implement a comprehensive logging system in Sahil to capture events that are crucial for monitoring, troubleshooting, and enhancing user experience. Logging should cover various aspects, including application errors, input validation, authentication, authorization, and other higher-risk events.

Acceptance Criteria:

• [ ] Identify and define the specific events that need to be logged.
• [ ] Ensure coverage for application errors, input/output validation failures, authentication successes/failures, authorization failures, session management issues, and privilege elevation events.
• [ ] Consider additional events for troubleshooting, monitoring, testing, understanding user behavior, security, and auditing.
• [ ] Implement logging initialization to ensure logs are captured from the start of the application. Opt-ins for specific events, such as terms of service agreements.

[aatalrashid]

As we plan on running the API in a Kubernets cluster to leverage on the many advantages of K8s like Availability, Scalability etc, this provides an option of using Prometheus & Grafana as the better tools for Monitoring and Logging etc

To justify on the acceptance criteria I base my above proposal with;

• prom-client the most popular Prometheus client library for Node. js ( https://classic.yarnpkg.com/en/package/prom-client )
• Default & custom metrics all at handy by prom-client
• Prometheus is natively made to run on Kubernets which is also the best option for running high critical workloads like the API
• Custom visual high detailed dashboards by Grafana - a pair of Prometheus
• Better support of both tools, makes them reliable

Am doing more research and hope will be able to implement this to the best