Telemetry Logs
The Telemetry Logs module provides real-time insights into how users and systems interact with your APIs. It automatically collects and transmits data related to application performance, usage behavior, and errors, offering a detailed view of the runtime environment. This module plays a vital role in system observability, helping teams monitor and maintain the health and reliability of their services.
Telemetry logging is built on three core pillars, Tracing, Logging, and Metrics, each contributing to effective monitoring and issue resolution.
How It Works
Telemetry data is collected passively and automatically during system operation, without requiring user intervention. When an API call is made or a system action is triggered, the following happens:
Tracing captures the journey of a request as it moves through different services or components, visualizing dependencies and timing.
Logging captures contextual details about events, errors, and activities, aiding in diagnosing issues and understanding the runtime behavior of the application.
Metrics measure the performance of the APIs.
This collected data is stored and displayed in the Telemetry Logs User Interface (UI), where you can filter, search, analyze, and export log records.
Benefits
Telemetry Logs offer several key advantages that support proactive monitoring, operational efficiency, and improved system reliability. The following are some of the primary benefits (but not limited to):
- Performance Monitoring: Gain real-time visibility into API performance by tracking critical metrics such as response times, throughput, and resource consumption.
- Usage Analysis: Understand how users interact with APIs by capturing and analyzing usage patterns, frequency of calls, and common request flows. This insight supports product improvement, scaling decisions, and user behavior analysis.
- Error Detection and Troubleshooting: Capture detailed error information, including error codes, messages, and stack traces. These logs are essential for quickly identifying, diagnosing, and resolving issues within the application or API.
Overview of the Telemetry Logs UI
The Telemetry Logs (UI) is designed to provide an intuitive experience for viewing, filtering, and exporting system-generated logs. It enables quick access to relevant log data while offering advanced filtering and export options to support detailed troubleshooting and analysis.
The primary component of the UI is the Telemetry Logs list, which presents all system-generated log entries in a structured tabular format. Each row in the list includes key attributes such as Trace ID, Time Stamp, Severity, Product, and Message. You can sort logs using the Product and Time Stamp columns in either ascending or descending order, allowing for easier categorization and analysis of log data.
When there are more than 1,000 telemetry log entries, the application displays the following message on the list screen: "Please note that the actual count of records could be higher. Export the logs to get the full list."
Clicking a Trace ID within the logs list opens the Log Console at the bottom of the screen. The Log Console provides complete visibility into the log message associated with the selected Trace ID, giving you deeper insight into the event for root-cause analysis or debugging.
To handle large volumes of log entries, the interface includes pagination controls at the bottom of the logs list. This enables you to navigate through multiple pages of logs while maintaining interface performance and usability.
The Search Bar, located at the top of the logs list, allows you to perform quick searches based on Trace ID, keywords, or phrases found in the log messages. For more targeted filtering, the interface provides Severity and Time filters in dropdown menus. These filters enable you to narrow logs by severity levels such as All, Information, Debug, Warning, and Critical, and select predefined time ranges such as Last 1 hour, 6 hours, 12 hours, 24 hours, or 1 week.
For advanced use cases, you can use the Filter button to access the Advanced Filter panel. This panel allows you to define multiple criteria across available fields, customize logical expressions using AND/OR operators, and manage conditions with options to add, delete, or remove all criteria at once. This flexibility makes it easy to refine the logs list according to specific troubleshooting scenarios or audit requirements.
The Export Logs button enables you to download the currently filtered log data for offline analysis, internal reviews, or sharing with support teams. Additionally, the Export History button helps you track past export actions, view their status, and download exported logs.
