Monitors as Code

INFOPlease contact support@datafold.com if you’d like to enable this feature for your organization.

This is particularly useful if any of the following are true:

You have (or plan to have) 100s or 1000s of monitors
Your team is accustomed to managing things in code
Strict governance and change management are important to you

Getting started

INFOThis section describes how to get started with GitHub Actions, but the same concepts apply to other hosted version control platforms like GitLab and Bitbucket. Contact us if you need help getting started.

Set up version control integration

To start using monitors as code, you’ll need to decide which repository will contain your YAML configuration. If you’ve already connected a repository to Datafold, you could use that. Or, follow the instructions here to connect a new repository.

Generate a Datafold API key

If you’ve already got a Datafold API key, use it. Otherwise, you can create a new one in the app by visiting Settings > Account and selecting Create API Key.

Create monitors config

In your chosen repository, create a new YAML file where you’ll define your monitors config. For this example, we’ll name the file monitors.yaml and place it in the root directory, but neither of these choices are hard requirements. Leave the file blank for now—we’ll come back to it in a moment.

Add CI workflow

If you’re using GitHub Actions, create a new YAML file under .github/workflows/ using the following template. Be sure to tailor it to your particular setup:

name: Apply monitors as code config to Datafold

on:
  push:
    branches:
      - main # or master

jobs:
  apply:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: 3.12
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install datafold-sdk
      - name: Update monitors
        run: datafold monitors provision monitors.yaml # use the correct file name/path
        env:
          DATAFOLD_HOST: https://app.datafold.com # different for dedicated deployments
          DATAFOLD_API_KEY: ${{ secrets.DATAFOLD_API_KEY }} # remember to add to secrets

Create a monitor

Now return to your YAML configuration file to add your first monitor. Reference the list of examples below and select one that makes sense for your organization.

Examples

INFOThese examples are intended to serve as inspiration and don’t demonstrate every possible configuration. Contact us if you have any questions.

Data Diff

Data Diff monitors detect differences between any two datasets, within or across databases.

monitors:
  replication_test_example:
    name: 'Example of a custom name'
    description: 'Example of a custom description'
    type: diff
    enabled: true
    datadiff:
      diff_type: 'xdb'
      dataset_a:
        connection_id: 734
        table: db.schema.table
        time_travel_point: '2020-01-01'
        materialize: false
      dataset_b:
        connection_id: 736
        table: db.schema.table1
        time_travel_point: '2020-01-01'
        materialize: true
      primary_key:
        - pk_column
      columns_to_compare:
        - col1
      materialize_results: true
      materialize_results_to: 734
      column_remapping:
        col1: col2
      sampling:
        tolerance: 0.2
        confidence: 0.95
        threshold: 5000
      ignore_string_case: true
    schedule:
      interval:
        every: hour

  replication_test_example_with_thresholds:
    type: diff
    enabled: true
    datadiff:
      diff_type: 'inmem'
      dataset_a:
        connection_id: 734
        table: db.schema.table
      dataset_b:
        connection_id: 736
        table: db.schema.table2
        session_parameters:
          k: v
      primary_key:
        - pk_column
      tolerance:
        float:
          default: 
            type: absolute
            value: 50
          column_tolerance:
            A:
              type: relative
              value: 20 # %
            B:
              type: absolute
              value: 30.0
    schedule:
      interval:
        every: hour
    alert:
      different_rows_count: 100
      different_rows_percent: 10

  replication_test_example_with_thresholds_and_notifications:
    type: diff
    enabled: true
    datadiff:
      diff_type: 'indb'
      dataset_a:
        connection_id: 734
        table: db.schema.table
      dataset_b:
        connection_id: 734
        table: db.schema.table3
      primary_key:
        - pk_column
    schedule:
      interval:
        every: hour
    sampling:
      rate: 0.1
      threshold: 100000
    materialize_results: true
    tolerance:
      float:
        default: 
          type: absolute
          value: 50
        column_tolerance:
          A:
            type: relative
            value: 20 # %
          B:
            type: absolute
            value: 30.0
    notifications:
      - type: email
        recipients:
          - valentin@datafold.com
      - type: slack
        integration: 123
        channel: datafold-alerts
        mentions:
          - "here"
          - "channel"
        features:
          - attach_csv
          - notify_first_triggered_only
      - type: pagerduty
        integration: 124
      - type: webhook
        integration: 125
    alert:
      different_rows_count: 100
      different_rows_percent: 10

Metric

Metric monitors identify anomalies in standard metrics like row count, freshness, and cardinality, or in any custom metric.

monitors:
  table_metric_example:
    type: metric
    enabled: true
    connection_id: 736
    metric:
      type: table
      table: db.schema.table
      filter: deleted is false
      metric: freshness # see full list of options below
    alert:
      type: automatic
      sensitivity: 10
    schedule:
      interval:
        every: day
        hour: 8 # 0-23 UTC

  column_metric_example:
    type: metric
    enabled: true
    connection_id: 736
    metric:
      type: column
      table: db.schema.table
      column: some_col
      filter: deleted is false
      metric: sum # see full list of options below
    alert:
      type: percentage
      increase: 30 # %
      decrease: 0
    tags:
      - oncall
      - action-required
    schedule:
      cron: 0 0 * * * # every day at midnight UTC

  custom_metric_example:
    name: custom metric example
    type: metric
    connection_id: 123
    notifications: []
    tags: []
    enabled: true
    metric:
      type: custom
      query: select * from table
      alert_on_missing_data: true
    alert:
      type: absolute
      max: 22.0
      min: 12.0
    schedule:
      interval:
        every: day
        type: daily

Supported metrics

For more details on supported metrics, see the docs for Metric monitors. Table metrics:

Freshness: freshness
Row Count: row_count

Column metrics:

Cardinality: cardinality
Uniqueness: uniqueness
Minimum: minimum
Maximum: maximum
Average: average
Median: median
Sum: sum
Standard Deviation: std_dev
Fill Rate: fill_rate

Data Test

Data Test monitors validate your data with business rules and surface specific records that fail your tests.

monitors:
  custom_data_test_example:
    type: test
    enabled: true
    connection_id: 736
    query: select 1 from db.schema.table
    schedule:
      interval:
        every: hour
    tags:
      - team_1

  accepted_values_test_example:
    type: test
    enabled: true
    connection_id: 736
    test:
      type: accepted_values
      tables:
        - path: db.schema.table
          columns:
            - column_name
      variables:
          accepted_values:
            value:
              - 12
              - 15
            quote: false
    schedule:
      interval:
        every: hour

  numeric_range_test_example:
    type: test
    enabled: true
    connection_id: 736
    test:
      type: numeric_range
      tables:
        - path: db.schema.table
          columns:
            - column_name
      variables:
        maximum:
          value: 15
          quote: false
    schedule:
      interval:
        every: hour

Supported variables by Standard Data Test (SDT) type

SDT Type	Monitor-as-Code Type	Supported Variables	Variable Type
Unique	`unique`	-	-
Not Null	`not_null`	-	-
Accepted Values	`accepted_values`	`accepted_values`	Collection with values
Referential Integrity	`referential_integrity`	-	-
Numeric Range	`numeric_range`	`minimum`	Single value
		`maximum`	Single value

Schema Change

Schema Change monitors detect when changes occur to a table’s schema.

monitors:
  schema_change_example:
    type: schema
    enabled: true
    connection_id: 736
    table: db.schema.table
    schedule:
      interval:
        every: day
        hour: 22 # 0-23 UTC
    tags:
      - team_2

Bulk Manage with Wildcards

For certain monitor types—Freshness, Row Count, and Schema Change—it’s possible to create/manage many monitors at once using the following wildcard syntax:

row_count_monitors:
  type: metric
  connection_id: 123
  metric:
    type: table
    metric: row_count
    # include all tables in the WAREHOUSE database
    include_tables: WAREHOUSE.*
    # exclude all tables in the INFORMATION_SCHEMA schema
    exclude_tables: WAREHOUSE.INFORMATION_SCHEMA.*
  schedule:
    interval:
      every: day
      hour: 10 # 0-23 UTC

This is particularly useful if you want to create the same monitor type for many tables in a particular database or schema. Note in the example above that you can specify both include_tables and exclude_tables to fine-tune your selection.

FAQ

Can I still create/manage monitors in the app if I'm using monitors as code?

What happens to a monitor in the app if it's removed from the code?

By default, nothing—it remains in the app. However, you can add the --dangling-monitors-strategy [delete|pause] flag to your run command to either delete or pause notifications if they’re removed from your code. For example:

datafold monitors provision monitors.yaml --dangling-monitors-strategy delete

Note: this only applies to monitors that were created from code, not those created in the UI.

How do I delete or pause all of my monitors?

Add the --dangling-monitors-strategy [delete|pause] flag to your run command and replace the contents of your YAML file with the following:

monitors: {}

Note that providing an empty YAML file will likely produce an error and not have the same effect.

Can I use the app to modify monitors managed in code?

Can I export monitors I've created in the app so I can manage them in code?

Need help?

If you have any questions about how to use monitors as code, please reach out to our team via Slack, in-app chat, or email us at support@datafold.com.

INTRODUCTION

DATA DIFFS

CI/CD TESTING

DATA MONITORS

DATA EXPLORER

DATA MIGRATION AUTOMATION

INTEGRATIONS

DEPLOYMENT

SECURITY

SUPPORT

Getting started

Set up version control integration

Generate a Datafold API key

Create monitors config

Add CI workflow

Create a monitor

Examples

Data Diff

Metric

Supported metrics

Data Test

Schema Change

Bulk Manage with Wildcards

FAQ

Need help?

INTRODUCTION

DATA DIFFS

CI/CD TESTING

DATA MONITORS

DATA EXPLORER

DATA MIGRATION AUTOMATION

INTEGRATIONS

DEPLOYMENT

SECURITY

SUPPORT

​Getting started

​Set up version control integration

​Generate a Datafold API key

​Create monitors config

​Add CI workflow

​Create a monitor

​Examples

​Data Diff

​Metric

​Supported metrics

​Data Test

​Schema Change

​Bulk Manage with Wildcards

​FAQ

​Need help?

Getting started

Set up version control integration

Generate a Datafold API key

Create monitors config

Add CI workflow

Create a monitor

Examples

Data Diff

Metric

Supported metrics

Data Test

Schema Change

Bulk Manage with Wildcards

FAQ

Need help?