Events and Thresholds¶
This documentation covers eventing and thresholds for your device.
Note
Note: The Event Notifier is only available to PiCockpit Pro users.
Using the Event Notifier¶
The event pulldown menu is activated by clicking on the bell icon in the navigation bar at the top of the page.
A red dot appears on the bell icon when there are new or unresolved events. Please note that a notification will only appear once per threshold.
To delete an event, click the trash icon next to the event entry.
Thresholds¶
A threshold is a set limit on a system metric that triggers an even when crossed. For example, an SoC temperature threshold will alert you when the SoC gets too hot.
There are two threshold types: frequency thresholds and value thresholds.
Frequency Thresholds¶
Frequency thresholds are triggered based on the number of occurrences of a specific action within a given timeframe.
Value Thresholds¶
Value thresholds are triggered when a metric exceeds a specific value.
How to use Thresholds¶
The available metrics can be viewed via the Event Manager. Metrics are filtered so that only those not yet set are displayed in the list.
When the Event Manager appears, choose either 'frequency' or 'value' in the threshold options.
If you choose a frequency threshold, you can specify the number of occurrences and the timeframe in minutes.
If you choose a value threshold, you can specify the limit value and the timeframe in minutes.
Stored thresholds are immutable. So once you create a threshold you cannot modify it. You will have to delete the threshold in order to make a new one.
Additionally, each metric can only have one threshold at a time.
Example
If you want to get notifications regarding your device, you can click on the bell icon on the top right. Then click on the settings icon.
Click on the + icon to add an event. Set the "Metric" to "system/cpu_temp". Then add an e-mail address if you want alerts by e-mail.
You will quickly notice that there are three important fields: Minutes, Quantity, and Threshold.
Let's imagine that I want an e-mail alert if my Raspberry Pi 4 goes above 70 degrees (Celsius) 3 times in an hour.
I would set Minutes to 60, Quantity to 3, and Threshold to 70.