📄️ Overview
Telemetry is the automated process of collecting, transmitting, and analyzing data from a system to monitor its performance, diagnose issues, and optimize operations. In the context of Stalwart, telemetry is crucial for gaining insights into system behavior, tracking performance metrics, and ensuring the reliability and security of the mail service.
📄️ Events
Events are specific occurrences or actions within the system that are recorded for monitoring, auditing, and troubleshooting purposes. These events can range from user authentication attempts to message delivery notifications. Stalwart emits hundreds of different events, such as "auth successful," "message delivered," and many others, each capturing a particular aspect of the server's operation.
🗃️ Tracing & Logging
5 items
🗃️ Metrics
3 items
📄️ Webhooks
Webhooks are a powerful and flexible way to receive real-time notifications about various events in your system. By configuring webhooks, you can set up HTTP callbacks that are triggered when specific events occur, allowing your applications to respond immediately and automatically to important occurrences.
📄️ Alerts
The Alerts feature in the Stalwart is designed to proactively notify administrators when specific conditions are met within the server’s operations. This feature is essential for maintaining optimal server performance and ensuring that potential issues are addressed promptly. By setting up alerts, you can stay informed about critical metrics and take immediate action when necessary, minimizing downtime and enhancing the overall reliability of your mail server.
📄️ Live Telemetry
Stalwart includes a powerful Live Telemetry feature designed to provide administrators with real-time insights into all server activity. This feature operates as an HTTP endpoint utilizing Server-Sent Events (SSE), also known as Event Streams, to deliver a continuous flow of structured logs, traces and metrics directly to the client. By accessing this endpoint, administrators can observe and monitor every aspect of the mail server's operations as they happen, enabling prompt diagnostics, performance monitoring, and issue resolution.
📄️ History
The Tracing History feature provides administrators with a practical mechanism for retaining and reviewing significant server events and metrics. Unlike live telemetry, which focuses on real-time monitoring, Telemetry History is designed to store specific event spans (such as incoming or delivered messages) as well as metrics in a dedicated database. This storage capability ensures that key activities and performance indicators are preserved for future analysis, enabling a deeper understanding of the server's past operations and facilitating effective troubleshooting.