Set Up Field Health Monitors

Follow these steps to configure monitors for specific field tests, available as On-Demand and Scheduled modes.

On-Demand Monitors are not applicable for the "Cardinality" test type.

Enabling Field Health Monitoring

To enable field health monitoring:

1. Navigate to the Config landing page.

2. Select the “Field Health” card.

Selecting Field Health Card

You can also activate field health monitoring within the "Asset Details" section of the Data Catalog Module. This can be done via the "Monitors" tab.

For more detailed information you can refer to below link

Catalog: Add/Modify Monitor

Once selected, you’ll be redirected to the “Create a New Monitor” form.

• The “Create a New Monitor” form consists of two steps:

  Setup

  Configure

The form fields will become available as you select the mandatory options.

Step 1: Set-up

• Choose the test type from the dropdown. The available test types are:

  1. Null — Monitors null values. Supports Absolute (row count), Percentage, and Auto threshold modes.

  2. Unique — Monitors duplicate values. Supports Absolute, Percentage, and Auto threshold modes.

  3. Average — Computes the column average and compares it against a Range threshold or Auto mode. Numeric columns only.

  4. Min — Identifies the minimum value in a column. Supports Range and Auto threshold modes. Numeric columns only.

  5. Max — Identifies the maximum value in a column. Supports Range and Auto threshold modes. Numeric columns only.

  6. Cardinality — Tracks the number of distinct values in a column using a 5-period rolling window. See How Cardinality detection works below. Scheduled mode only.

  7. String Length — Validates string lengths. Supports Range and Auto threshold modes.

  8. Email — Monitors invalid email addresses. Supports Absolute, Percentage, and Auto threshold modes.

  9. UUID — Monitors invalid UUIDs. Supports Absolute, Percentage, and Auto threshold modes.

  10. Regex Match — Validates values against a user-defined pattern. Specify the pattern separately from the threshold. Supports Absolute, Percentage, and Auto threshold modes.

• Important Note for Synapse/SQL Server Users:

When setting up the Match REGEX threshold for data quality monitoring:

• Synapse/SQL Server requires string matching patterns instead of standard REGEX syntax.

• Ensure that the value entered in the “Set Threshold” field aligns with the string pattern supported by Synapse/SQL Server.

If the current preset field tests is not sufficient to run the specific test you require, you can also create a test via custom SQL script.

Custom SQL Monitor

• Select the data source & Filter by Schema is optional.

• Select the dataset and Column you want to monitor.

• Choose Monitor mode: Scheduled or On-Demand

For a detailed understanding of monitor modes, check out Available Monitor Modes

• Enable “Grouped By” (if applicable) by toggling the switch.

• Select the column for grouping and click Validate.

• A success message (“Column is valid to be grouped by”) confirms validation.

Grouped-By Disabled

Grouped-by enabled

• Click “Proceed to Monitor Setup” to move to the next step.

Choose Monitor Mode

Step 2: Configure: Scheduled Monitor

• Once you proceed to setup, you’ll reach the ”Configure” page, where you can review your previous selections.

Complete the required fields in the Configure form:

• Can create multiple tests for each test type per column/table

• Able to add a test name to differentiate monitors created

• Monitor Name

• Monitor Description is Optional.

• Row Creation: Select the Row creation from given options:

  • Timestamp (Select Timestamp from the dropdown column)

  • Validation for SQL Expression (when SQL Expression is chosen)

  • All Records

  • Enable Smart Training(Optional): Train your monitor on historical data to reduce the training period

• Frequency (Learn more about Custom Scheduling For Monitors)

• Threshold Mode: Select the appropriate threshold type based on your test:

  • Absolute (Row Count): Set thresholds based on number of rows (e.g., "fail when > 100 invalid rows")

    • Available for: Null, Unique, Email, UUID, Regex Match

    • Input: Non-negative integer values for min/max bounds

  • Percentage: Set thresholds based on percentage (e.g., "fail when > 5% nulls")

    • Available for: Null, Unique, Email, UUID, Regex Match

    • Input: Integer values between 0-100 for min/max bounds

  • Auto (Machine Learning): Let the system learn acceptable patterns from historical data

    • Only available for scheduled monitors

    • Available for: Null, Unique, Email, UUID, Regex Match, Average, Min, Max, String Length

    • No manual threshold input required

  • Range: Set numeric range thresholds for statistical tests

    • Available for: Average, Min, Max, String Length

    • Input: Min/max bounds (at least one required)

• Set Threshold: Configure min/max values based on selected threshold mode

  • At least one bound (min or max) is required

  • For percentage mode: values must be 0-100

  • For absolute mode: values must be non-negative integers

  • For range mode: constraints depend on test type

• Quality Dimension (Optional) for more understanding refer to supported test types

When using SQL Expression, validating your query is compulsory. Ensure that your query is written in the dialect compatible with your linked data source, as illustrated below:

Google BigQuery - CAST(your_string_column AS DATETIME)

PostgreSQL - your_timestamp_column::timestamp

When working with Google BigQuery, you can review the provided documentation for further details here.

Smart Training requires Row Creation to be selected.

To activate Smart Training in Row Creation:

• Users should initially select the timestamp.

• If SQL Expression is chosen for row creation, validate the SQL Expression before saving.

Regex Match Test: When configuring a Regex Match test, you'll specify the regex pattern in a separate field in the test configuration (not in the threshold). The threshold controls how many non-matching values will trigger an incident.

Cardinality detection

Cardinality uses a rolling-window approach rather than the ML model used by other Auto tests. Each scan compares the current distinct-value count against the average of the preceding 5 scan results. If the current count falls outside the expected range based on that window, Decube opens an incident.

Because this method derives its baseline from recent history rather than a training run, Cardinality does not have a training period and is not affected by the sparse-data threshold that applies to Smart Training monitors. The rolling window does require at least 5 prior scan results before it can produce meaningful comparisons — a newly created Cardinality monitor will not raise incidents until 5 scans have completed.

Cardinality is only supported in Scheduled mode. On-Demand mode is not available for this test type.

---

Overview for setting-up frequency

Overview of set-up monitor with supported quality dimension

Get Notified/Custom Alert

• To set custom alerts, turn on the "Notify default channel" toggle, then select your preferred alert channels (email or Slack) from the dropdown.

  • You can select the desired alert channels in the dropdown.

  • Mention the address or channel name in the field.

• At last Specify the Incident Level.

Setting-up notification/custom alert

• Click on Submit and your monitor is created successfully.

• Once monitor is created successfully you will be redirected to ALL MONITORS tab.

Step 2: Configure: On-demand Monitor

Note: Key Differences: i. The "Frequency" field is not relevant for configuring any On Demand monitors and is therefore neglected.

ii. “Enable Smart Training”"Auto Threshold" options is neglected when it comes to setting up any On Demand Monitor.

iii. Grouped By is not available for On-demand monitor mode.

• Select On-Demand as the Monitor Mode and click “Proceed to Monitor Setup”.

Choosing monitor mode

• Complete the required fields in the Configure form:

• Can create multiple tests for each test type per column/table

• Able to add a test name to differentiate monitors created

• Monitor Name

• Monitor Description is Optional.

• Row Creation: Select the Row creation from given options:

  • Timestamp (Select a timestamp column from the dropdown)

  • Validation for SQL Expression (when SQL Expression is chosen)

  • All Records

• Lookback Period

• Threshold Mode: Select the appropriate threshold type:

  • Absolute (Row Count): For Null, Unique, Email, UUID, Regex Match

  • Percentage: For Null, Unique, Email, UUID, Regex Match

  • Range: For Average, Min, Max, String Length

  • Note: Auto threshold is not available for on-demand monitors

• Set Threshold: Configure min/max values (at least one required)

• Quality Dimension (Optional) for more understanding refer to supported test types

• Incident Levels

On-demand monitor configuration

Custom Notifications: Custom alerts can be configured as in scheduled monitors.

Get Notified/Custom Alert

Finalizing On-Demand Monitor Setup

• To finish, choose one of the following:

  • Save — creates the monitor without running it immediately.

  • Save and Run — creates and runs the monitor straight away. To run it again later, navigate to All Monitors.

  • After selecting the above option you will be redirected to ALL MONITORS tab.

• Modify Monitoring

To modify an existing monitor:

1. Go to All Monitors.

2. Click the ellipsis (︙) and select View Monitor.

3. Click on Run once to run the monitor manually.

Modify Monitor from All Monitors