Skip to main content

Sentinels

Sentinels are automated monitoring agents that continuously check your data sources for quality issues. This guide explains how to view, create, and update sentinels in DeepDQ.

Viewing Sentinels​

  1. Navigate to the Sentinels section from the main sidebar.
  2. The Sentinels page displays a table of all existing sentinels, including their name, source, schedule, next run, status, and actions.
  3. Use the search bar to filter sentinels by name.
  4. You can enable/disable sentinels or perform actions using the menu in the Action column.

Creating a Sentinel​

  1. Click the Add Sentinel button on the Sentinels page.
  2. Fill in the required fields:
    • Sentinel Name: Enter a descriptive name.
    • Sentinel Source: Select the data source (e.g., MySQL, Oracle, BigQuery, etc.).
    • Vault: Choose the vault where results/configurations are stored.
    • Sentinel Query: Write or generate the SQL query to monitor your data. You can use the Manual or Use AI tab to help generate queries.
    • Schedule (Cron): Set how often the sentinel should run (e.g., using cron syntax). Use Manual or Use AI to help create the schedule.
    • Timezone: Select the timezone for scheduling.
    • Alert Gateway: Choose one or more alert channels (e.g., Slack, Email).
    • Alert Condition: Define the condition that triggers an alert. You can use natural language and validate it with AI.
  3. Use the Validate Query button to check your SQL query and preview sample results.
  4. Use the Validate Alert Condition button to test your alert logic on sample data.
  5. Click Save Changes to create the sentinel.

Updating a Sentinel​

  1. In the Sentinels table, find the sentinel you want to update and click the action menu (three dots).
  2. Select Edit (or similar option).
  3. Update any of the fields as needed (name, source, query, schedule, alert condition, etc.).
  4. Validate your changes using the Validate Query and Validate Alert Condition buttons.
  5. Click Save Changes to apply updates.

Deleting Sentinels​

  1. Select one or more sentinels using the checkboxes in the table.
  2. Click Delete Selected to remove them.

Tips​

  • Use descriptive names for easy identification.
  • Regularly review and update sentinel queries and alert conditions to match evolving data quality needs.
  • Use the search and filter options to quickly find sentinels.
  • Validate queries and alert conditions before saving to ensure correct monitoring and alerting.