Monitoring and Logging Handbook for Alliance Business Suite

Overview

Monitoring and logging are crucial for maintaining high performance and reliability in our systems. This handbook outlines the Alliance Business Suite's standard practices and technologies for monitoring system health and application performance, as well as logging critical information for debugging and analytics.

Table of Contents

  1. Why Monitoring and Logging?
  2. Technology Stack
  3. Monitoring
  4. Logging
  5. Best Practices
  6. Getting Started

Why Monitoring and Logging?

Both monitoring and logging serve critical functions in a production environment:

  • Early Detection of Issues: Real-time monitoring helps detect system inefficiencies and issues before they affect users.
  • Debugging: Logs provide the data needed to diagnose and troubleshoot issues.
  • Performance Tuning: Monitoring and logs help us understand how systems are performing and where bottlenecks occur.
  • Audit and Compliance: Logs can be critical for audit trails and compliance with legal and business policies.

Technology Stack

We employ the following technology stack for our monitoring and logging needs:

  • Monitoring Tools: NewRelic, Grafana
  • Logging Tools: Stackify, Azure DevOps
  • Official Resources

Monitoring

  • Why: For real-time application and infrastructure monitoring.
  • Tools: NewRelic for application monitoring, Grafana for custom dashboards.
  • How-To Guide: Monitoring tools are integrated into our system. For application performance metrics, log in to the New Relic Dashboard.
  • Learn More: New Relic Official Docs, Grafana Official Docs

Logging

  • Why: To capture and store event and error data for debugging, analytics, and audits.
  • Tools: Stackify for application-level logging, Azure DevOps for pipeline logging.
  • How-To Guide: Logging is automatically configured in our development environment. To access logs, visit Azure DevOps Project.
  • Learn More: Stackify Documentation, Azure DevOps Official Docs

Best Practices

  • Continuous Monitoring: Always keep an eye on system health.
  • Regular Log Reviews: Schedule regular reviews of logs to detect anomalies.
  • Alerts: Set up alerts for critical events and performance metrics.
  • Documentation: Document any special logging or monitoring requirements for new features or services.

Getting Started

  1. Check out the Engineering Handbook.
  2. Clone the Source Code.

For any queries or clarifications, please connect with the Engineering Team via Microsoft Teams.

Whether you are a junior or a senior developer, this handbook aims to provide you with all the necessary information to seamlessly integrate with Alliance Business Suite's monitoring and logging ecosystem. For further support, don't hesitate to reach out to the engineering team.