Status Dashboard

The Ethos API Health Monitor Dashboard provides a structured overview of the performance, reliability, and recent behavior of your monitored Ethos API endpoints. This section explains how to interpret each component of the dashboard for effective API monitoring and troubleshooting.

Summary Statistics

These metrics summarize overall performance over a selected time range:

Metric	Meaning	How to Use It
AVG Error Rate	Percentage of API checks that failed.	A high error rate indicates systemic issues. Monitor trends over time.
Successful Rate	Percentage of successful API responses.	This should remain high for healthy integrations.
Active Services	Number of unique API endpoints being monitored.	Helps track the scope of monitoring coverage.
Max Latency	Longest recorded response time (in milliseconds).	Useful for identifying extreme outliers or slowdowns.
Total Runs	Total number of API checks conducted in the time range.	Reflects monitoring activity volume.
Successful Runs	Count of successful API checks.	Should align closely with the successful rate percentage.
Failed Runs	Count of API checks that failed (timeouts, errors, etc.).	Frequent failures may indicate API instability or misconfiguration.

Tip: Pay close attention to spikes in max latency and an increasing error rate, especially during peak usage periods.

---

Health History

The dashboard also displays historical API heath check statictics. The available charts show the following information:

Latency Percentiles Chart

This chart shows how long API requests took to respond over the last month. Hover over a data point in the chart to view more information about it.

Overall Availability Chart

This chart displays the volume of successful (blue) vs. failed (red) API checks across the selected time range.

Performance per Endpoint Table

This section lists individual API resources being monitored. Click on an API to view additional information about it.

Column	Description
Resource	The name of the API resource being monitored.
Status	Icon indicating current health of the API.
Last Checked	Timestamp of the most recent health check.

Best Practice: Prioritize reviewing endpoints critical to institutional operations (e.g., admissions, student records) if any show failed or degraded status.

---

Dashboard Usage Tips

• Correlate failures with application issues: Use the Failed Runs and Latency charts to identify whether end-user-reported issues align with API outages.

• Investigate outliers: Check endpoints with high max latency or high error rates for configuration or authentication issues.

• Review periodically: Set a routine to review dashboard health weekly or after key academic events (e.g., enrollment periods).