Skip to main content

HeatMap Dashboard

The HeatMap Dashboard provides a comprehensive view of your application's performance metrics across different components and methods. It helps you visualize and analyze the performance characteristics of your system in real-time.

HeatMap Dashboard showing performance metrics across different components

Overview​

The HeatMap Dashboard displays performance metrics in a hierarchical structure:

MODULE
└── SERVICE
    └── CLASS
        └── METHOD

Each level shows detailed metrics including call counts, response times, success rates, and more.

Dashboard Components​

1. Metric Categories​

The dashboard tracks four main types of metrics:

  • Incoming HTTP Requests: External API calls to your application
  • Internal REST Calls: Service-to-service communication
  • SQL Requests: Database operations
  • Scheduler Calls: Background task execution

2. Metric Columns​

For each component, the dashboard displays:

ColumnDescription
Call CountNumber of invocations
Avg TimeAverage response time
Success RatePercentage of successful calls
Error CountNumber of failures
Query CountNumber of SQL queries (for database operations)
Exec CountNumber of executions

3. Performance Indicators​

The dashboard uses color coding to highlight performance characteristics:

  • Red: Indicates high response times or potential issues
  • Green: Indicates healthy performance
  • Yellow: Indicates moderate performance or warning states

Using the Dashboard​

Filtering and Controls​

The dashboard provides several control options:

  1. Hide Empty Rows

    • Toggles visibility of inactive components
    • Useful for focusing on active endpoints
    • Setting persists between sessions

  2. Auto Refresh

    • Enables/disables automatic data updates
    • Default: Enabled
    • Useful for real-time monitoring

  3. Time Range Selection

    • Controls the monitoring window
    • Default: 10 minutes
    • Adjustable based on monitoring needs

Best Practices​

For Regular Monitoring​

  1. Keep auto-refresh enabled
  2. Use a 10-minute time range
  3. Monitor:
    • Success rates (should stay near 100%)
    • Response times for consistency
    • Expected call volumes

For Problem Investigation​

  1. When issues occur:
    • Disable auto-refresh
    • Adjust time range to include the incident
    • Look for:
      • Increased error rates
      • Unusual response times
      • Unexpected call patterns

For Performance Optimization​

  1. Use longer time ranges (30+ minutes)
  2. Look for:
    • Consistently slow endpoints
    • High-volume SQL queries
    • Frequent error patterns

Troubleshooting​

Common Issues​

  1. High Response Times

    • Check the specific method/endpoint
    • Review SQL query performance
    • Investigate external service calls

  2. Error Spikes

    • Identify affected components
    • Check error messages
    • Review related system logs

  3. Missing Data

    • Verify monitoring configuration
    • Check network connectivity
    • Ensure service is running

Tips and Tricks​

  1. Efficient Monitoring

    • Use "Hide Empty" during high-traffic periods
    • Set appropriate time ranges for your use case
    • Focus on critical endpoints first

  2. Performance Analysis

    • Compare similar endpoints
    • Track trends over time
    • Document baseline performance

  3. Team Collaboration

    • Share findings using time range links
    • Document recurring patterns
    • Maintain performance baselines