This tutorial walks through the use of Console to monitor your stream and configure alerts.
In this article, we are going to cover:
- Select resources
- Configure alerts
- Outcomes of having multiple resources selected
- Enter maintenance mode
- Logs
- Email alerts
Select resources
Once the account is set up by our deployments team, you will first select the Publishers tab from the dashboard menu on the left side of the screen.
Next, you'll want to select the resources that you would like to be monitored. Click on the Monitoring tab and then the Select resources button.
Select which ingest servers and which egress servers you want to monitor from the drop-down list. The ingest server will first receive the audio feed and will then send it to the egress servers. Be sure to click Save to commit your selection.
These servers are distributed for load-balancing purposes and will be located in different geographic areas. In case one of the egress servers goes down, the other one will take over. Normally you’d want to monitor all of them, but we do provide the option to exclude some egress servers based on your preference.
Configure alerts
The next step is to access the Configure Alerts tab. Here, you can set the tolerance before an alert should be sent to a list of desired email addresses
Our monitoring tool checks the station every minute. When it detects that a station is down or that the metadata has not changed, the station will be flagged, and (depending on the interval) it will notify the alert recipients. Uptime alerts can be set from one minute to one hour and metadata alerts can be set from one minute to six hours.
In the example screenshot above, we've configured a different interval for monitoring stream uptime and metadata. The metadata monitoring is set to six hours. In this example, the system will check the stream every minute leading up to six hours. If the metadata has still not been updated when six hours is reached, then it will fire an email notification.
Additionally, you can have two (or more) egress servers configured for the same stream. If a stream is down on one egress server, no email notification will fire. You will get notified only if the stream is down on all egress servers.
The Do Not Disturb feature will disable the notification for a specific time frame. The most common use case for this feature is when the station is being put offline deliberately.
Outcomes of having multiple resources selected
In the example below, we have 3 ingest servers and 2 egress servers selected for monitoring.
Enter maintenance mode
The last feature of the Monitoring tool is using Enter maintenance mode. Clicking on this button prompts you to confirm disabling your configured alerts until the maintenance mode is manually lifted.
Logs
Click on the Monitoring tab and scroll down to the Log area.
With this feature, you can export event logs for uptime and metadata in CSV format, allowing you to focus on a specific time frame. Data is available going back 7 days from the current date.
Email alerts
Here is what an email alert regarding streams being down might look like :
Here is an email alert regarding metadata not updating within the set tolerance point:
If you have any further questions or concerns please do not hesitate to contact our Support Team through the ticket submission form or by emailing us at support@soundstack.com.