Soracom Lagoon

Alerts

Lagoon provides built-in alerting functionality that allows you to quickly identify potential issues based on the data reported from your devices directly on a dashboard, or receive the alerts as notifications at an email address, on Slack, or through another notification channel.

Alerts are comprised of two components:

• Alert - A condition for evaluating one or more metrics and determining if an alert should be fired.
• Alert Channel - A configuration for sending alert notifications to an endpoint outside of Lagoon.

When an Alert is created, a Graph panel will be updated to include an indicator of the alert condition threshold, and the panel will automatically display the alert once the condition has been met, allowing you to quickly identify the alert status directly from the Lagoon dashboard.

Each alert will have one of the following alerting statuses:

• OK
• ALERTING
• NO DATA

When an alerting status changes, the panel appearance will change when the dashboard is refreshed.

Alerts are available for Graph panels .

If an Alert is also configured to use an Alert Channel, the new alerting status, along with an optional custom message, will be sent to the alert channel, allowing you to receive the alert even if you do not have the Lagoon dashboard open.

Available Alert Channels include email, Slack, Telegram, Discord, Microsoft Teams, standard HTTP POST webhooks, and many other services.

Creating an Alert

1. Login to the Lagoon Console for your region, and open a dashboard.

2. Find the graph panel that you want to edit.

3. Click the Panel Title, then select Edit to configure the panel.

4. Click the Alert tab, then click Create Alert.

   https://g.lagoon.soracom.io

   

Alert Config

Alert Config

• Name - The name for this alert.
• Evaluate every - The interval for how often this condition should be checked.

Conditions

• When ... of - Controls how the values with a range of values should be reduced to a single value in order to compare against a threshold. Available options:
  • avg () - Gets a simple average of all values within the range.
  • min (), max () - Gets the minimum or maximum value within the range.
  • sum () - Gets the sum of all values within the range.
  • count (), count_non_null () - Gets the number of values or non-null values within the range.
  • last () - Gets the last value within the range.
  • median () - Gets the median value within the range.
  • diff (), percent_diff () - Gets the absolute difference or percent difference between the last two values within the range.
• query (metric, from, to) - The range of values, where:
  • metric - The data series to select from, based on the data source configured in the Metric tab.
  • from - The start of the range.
  • to - The end of the range.
• Is - The type of threshold and threshold value. Available options:
  • Above - Will alert when the actual value is greater than the specified threshold value.
  • Below - Will alert when the actual value is less than the specified threshold value.
  • Outside range - Will alert when the actual value is greater than the specified maximum or less than the specified minimum threshold values.
  • Within range - Will alert when the actual value is less than or equal to the specified maximum or greater than or equal to the specified minimum threshold values.
  • Has no value - Will alert when the actual value is missing or cannot be computed.

If no data or all values are null - The alerting state to use if no data is found, or if all values are null. Available options:

• Ok - Set the status to OK
• Alerting - Set the alert status to ALERTING
• No Data - Set the status to NO DATA
• Keep Last State - Don't change the alert status.

If execution error or timeout - The alerting state to use in the event the alert status cannot be determined. Available options:

• Alerting - Set the alert status to ALERTING
• Keep Last State - Don't change the alert status.

Notifications

Notifications

• Send to - The Alert Channel where a notification should be sent when an alert status changes.
• Message - A customizable message to send in the notification.

Creating an Alert Channel

1. Login to the Lagoon Console for your region.

2. Hover over the menu, then select Notification channels.

   https://g.lagoon.soracom.io

   

3. Click the Add channel button.

   https://g.lagoon.soracom.io

   

4. Configure the notification channel.

   https://g.lagoon.soracom.io

   

New Notification Channel

• Name - The name for this notification channel.
• Type - The type of notification.
• Send on all alerts - Enable sending notifications using this channel for all Lagoon alerts.

Settings - Configuration settings for the notification channel (varies by notification channel Type).

Limitations

Lagoon dashboard data, and in turn any dashboard alerts, are updated at intervals based on your Lagoon subscription:

• Lagoon Free data is updated every 1 minute.
• Lagoon Maker data is updated every 30 seconds.
• Lagoon Pro data is updated every 5 seconds.

You can also set slower intervals for alerts, in order to limit how often you receive notifications.