Custom Monitors
How to create and use Custom Monitors in Revefi
Custom monitors allow you go beyond the automatic metadata only access monitors automatically created by Revefi and create your own as necessary. In order to create a custom monitor, SELECT access must be granted to the Revefi role for the table to be monitored. Note that Revefi only stores the numeric result of the query and does not pull back or store any data from the query.
Revefi supports Pre-built and Custom SQL custom monitors at the Data Table level and Catalog Table level. Catalog Table options are specific to the Data Source. Data table is a table you use for your business or operational purposes. E.g. Revenue, Orders, Customers. Catalog table is a table with metadata about your database, its structure, and usage statistics E.g. Query_History, Warehouse_Credits. Revefi provides zero-touch monitoring out of the box for these, but you are welcome to create custom monitors here for your specialized needs!
There are two ways to create a Custom Monitor:
- From the Table Dashboard page, click the Create Monitor button in the upper right hand corner to create a custom monitor for that table. The table is preselected in the form. (Catalog Table is not available at this level)
- From the Monitors tab, click the Create Monitor button in the upper right hand corner to create a custom monitor for a table. You will need to select the table
For SQL monitors, a name and description should be specified.
![](https://files.readme.io/b21d136-Screenshot_2024-06-10_at_1.42.55_PM.png)
You will need to enter the SQL you wish to run and ensure it is correct. A numeric return value is required.
![](https://files.readme.io/2546006-Screenshot_2024-06-10_at_1.41.33_PM.png)
For either monitor type, you can select the anomaly detection type:
Automatic anomaly discovery - Based on selections made we’ll apply an autoregressive moving average model to detect anomalies.
Specify thresholds for expected range - Define expected ranges for your data. We will alert you when we detect values outside these ranges. Multiple thresholds are allowed.
![](https://files.readme.io/940bf4b-Screenshot_2024-06-10_at_1.42.24_PM.png)
Thresholds can be:
- Numeric
- % Last Value
- % Avg
- Times Standard Deviation
Conditions can be:
- Less than
- Less than or equal to
- Equal to
- Greater than
- Greater than or equal to
- Between
And the run frequency of Daily or Hourly. (Daily Monitors run at 4AM UTC)
![](https://files.readme.io/5030dec-Screenshot_2024-06-10_at_1.44.02_PM.png)
To test your monitor access and correctness, click the Preview Results button to run the monitor and receive query results. To create the monitor, click Create Monitor. The monitor will appear in the monitors tab and on the appropriate Table Dashboard page and will start collecting data and generating alerts as appropriate.
![](https://files.readme.io/52f3372-Screenshot_2024-06-10_at_1.44.45_PM.png)
Updated 3 months ago