Coalesce Quality: Observability as Code


Configuration file format for synqcli, the Coalesce Quality observability-as-code tool for defining data quality monitors and tests.

root anyOf item 0
Type: object
No Additional Properties

root anyOf item 0 version
Type: const
Specific value: "v1beta1"

root anyOf item 0 namespace
Type: string

root anyOf item 0 defaults
Type: object
No Additional Properties

root anyOf item 0 defaults severity
Type: string

root anyOf item 0 defaults daily
Type: object
No Additional Properties

root anyOf item 0 defaults daily time_partitioning_shift

Duration

Type: string

An amount of time.

 Must match regular expression: ^([0-9]+([.][0-9]+)?h)?([0-9]+([.][0-9]+)?m)?([0-9]+([.][0-9]+)?s)?([0-9]+([.][0-9]+)?ms)?([0-9]+([.][0-9]+)?us|µs)?([0-9]+([.][0-9]+)?ns)?$
Examples:

"2h"

"30m"

"600s"

"2h30m"

root anyOf item 0 defaults daily ignore_last
Type: integer

root anyOf item 0 defaults mode
Type: object
No Additional Properties

root anyOf item 0 defaults mode anomaly_engine
Type: object
No Additional Properties

root anyOf item 0 defaults mode fixed_thresholds
Type: object
No Additional Properties

root anyOf item 0 defaults timezone
Type: string

root anyOf item 0 monitors
Type: array
No Additional Items

Each item of this array must be:

root anyOf item 0 monitors YAMLMonitor
Type: object
No Additional Properties

root anyOf item 0 monitors monitors items monitored_ids
Type: array of string
No Additional Items

Each item of this array must be:

root anyOf item 0 monitors monitors items monitored_ids monitored_ids items
Type: string

root anyOf item 0 monitors monitors items fields
Type: array of string
No Additional Items

Each item of this array must be:

root anyOf item 0 monitors monitors items fields fields items
Type: string

root anyOf item 0 monitors monitors items segmentation
Type: object
No Additional Properties

root anyOf item 0 monitors monitors items segmentation include_values
Type: array of string
No Additional Items

Each item of this array must be:

root anyOf item 0 monitors monitors items segmentation include_values include_values items
Type: string

root anyOf item 0 monitors monitors items segmentation exclude_values
Type: array of string
No Additional Items

Each item of this array must be:

root anyOf item 0 monitors monitors items segmentation exclude_values exclude_values items
Type: string

root anyOf item 1
Type: object
No Additional Properties

root anyOf item 1 version
Type: const
Specific value: "v1beta2"

root anyOf item 1 namespace
Type: string

root anyOf item 1 defaults
Type: object
No Additional Properties

root anyOf item 1 defaults severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 defaults schedule
Type: object

root anyOf item 1 defaults schedule anyOf item 0
Type: enum (of string)

Must be one of:

  • "daily"
  • "hourly"
  • "ondemand"
root anyOf item 1 defaults schedule anyOf item 1
Type: object
No Additional Properties

root anyOf item 1 defaults schedule anyOf item 1 type
Type: enum (of string)

Must be one of:

  • "daily"
  • "hourly"

root anyOf item 1 defaults schedule anyOf item 2
Type: object
No Additional Properties

root anyOf item 1 defaults schedule anyOf item 2 type
Type: enum (of string)

Must be one of:

  • "ondemand"

root anyOf item 1 defaults schedule anyOf item 2 time_partitioning_interval
Type: enum (of string)

Must be one of:

  • "1h"
  • "24h"

root anyOf item 1 defaults mode
Type: object
No Additional Properties

root anyOf item 1 defaults mode anomaly_engine
Type: object
No Additional Properties

root anyOf item 1 defaults mode anomaly_engine sensitivity
Type: enum (of string)

Must be one of:

  • "PRECISE"
  • "BALANCED"
  • "RELAXED"

root anyOf item 1 defaults mode fixed_thresholds
Type: object
No Additional Properties

root anyOf item 1 defaults timezone
Type: string

root anyOf item 1 defaults save_failures
Type: boolean

root anyOf item 1 entities
Type: array
No Additional Items

Each item of this array must be:

root anyOf item 1 entities Entity
Type: object
No Additional Properties

root anyOf item 1 entities entities items id
Type: string

Path of the table or view the monitors and tests below are anchored to, either a simple name or a full path. It is part of every check's address here, and a monitor cannot be moved to another asset: editing it replaces every check under this entity.

root anyOf item 1 entities entities items tests
Type: array
No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items tests Test
Type: object

root anyOf item 1 entities entities items tests tests items anyOf item 0
Type: object
No Additional Properties

root anyOf item 1 entities entities items tests tests items anyOf item 0 id
Type: string

The test's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so the columns, the SQL and the evaluators can be edited without replacing the test. Renaming the id, moving the test to another entity or changing its type replaces it, and the check entity, its issues and its error runs are discarded. Without an id the test is identified by its content, and editing a column or the SQL replaces it.

root anyOf item 1 entities entities items tests tests items anyOf item 0 type
Type: const
Specific value: "accepted_values"

root anyOf item 1 entities entities items tests tests items anyOf item 0 schedule
Type: object

root anyOf item 1 entities entities items tests tests items anyOf item 0 schedule anyOf item 0
Type: enum (of string)

Must be one of:

  • "daily"
  • "hourly"
  • "ondemand"
root anyOf item 1 entities entities items tests tests items anyOf item 0 schedule anyOf item 1
Type: object
No Additional Properties

root anyOf item 1 entities entities items tests tests items anyOf item 0 schedule anyOf item 1 type
Type: enum (of string)

Must be one of:

  • "daily"
  • "hourly"

root anyOf item 1 entities entities items tests tests items anyOf item 0 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 entities entities items tests tests items anyOf item 0 select_columns
Type: array of string

All items must be unique

No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items tests tests items anyOf item 0 select_columns select_columns items
Type: string
root anyOf item 1 entities entities items tests tests items anyOf item 1
Type: object
No Additional Properties

root anyOf item 1 entities entities items tests tests items anyOf item 1 id
Type: string

The test's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so the columns, the SQL and the evaluators can be edited without replacing the test. Renaming the id, moving the test to another entity or changing its type replaces it, and the check entity, its issues and its error runs are discarded. Without an id the test is identified by its content, and editing a column or the SQL replaces it.

root anyOf item 1 entities entities items tests tests items anyOf item 1 type
Type: const
Specific value: "business_query"

root anyOf item 1 entities entities items tests tests items anyOf item 1 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 entities entities items tests tests items anyOf item 1 evaluators
Type: array

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items tests tests items anyOf item 1 evaluators Evaluator
Type: object
No Additional Properties

root anyOf item 1 entities entities items tests tests items anyOf item 1 evaluators evaluators items id
Type: string
Must match regular expression: ^[A-Za-z0-9_-]+$

root anyOf item 1 entities entities items tests tests items anyOf item 1 evaluators evaluators items severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"
root anyOf item 1 entities entities items tests tests items anyOf item 2
Type: object
No Additional Properties

root anyOf item 1 entities entities items tests tests items anyOf item 2 id
Type: string

The test's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so the columns, the SQL and the evaluators can be edited without replacing the test. Renaming the id, moving the test to another entity or changing its type replaces it, and the check entity, its issues and its error runs are discarded. Without an id the test is identified by its content, and editing a column or the SQL replaces it.

root anyOf item 1 entities entities items tests tests items anyOf item 2 type
Type: const
Specific value: "business_rule"

root anyOf item 1 entities entities items tests tests items anyOf item 2 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 entities entities items tests tests items anyOf item 2 select_columns
Type: array of string

All items must be unique

No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items tests tests items anyOf item 2 select_columns select_columns items
Type: string

root anyOf item 1 entities entities items tests tests items anyOf item 3
Type: object
No Additional Properties

root anyOf item 1 entities entities items tests tests items anyOf item 3 id
Type: string

The test's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so the columns, the SQL and the evaluators can be edited without replacing the test. Renaming the id, moving the test to another entity or changing its type replaces it, and the check entity, its issues and its error runs are discarded. Without an id the test is identified by its content, and editing a column or the SQL replaces it.

root anyOf item 1 entities entities items tests tests items anyOf item 3 type
Type: const
Specific value: "empty"

root anyOf item 1 entities entities items tests tests items anyOf item 3 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 entities entities items tests tests items anyOf item 3 columns
Type: array of string
No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items tests tests items anyOf item 3 columns columns items
Type: string

Must be at least 1 characters long

root anyOf item 1 entities entities items tests tests items anyOf item 3 select_columns
Type: array of string

All items must be unique

No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items tests tests items anyOf item 3 select_columns select_columns items
Type: string
root anyOf item 1 entities entities items tests tests items anyOf item 4
Type: object
No Additional Properties

root anyOf item 1 entities entities items tests tests items anyOf item 4 id
Type: string

The test's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so the columns, the SQL and the evaluators can be edited without replacing the test. Renaming the id, moving the test to another entity or changing its type replaces it, and the check entity, its issues and its error runs are discarded. Without an id the test is identified by its content, and editing a column or the SQL replaces it.

root anyOf item 1 entities entities items tests tests items anyOf item 4 type
Type: const
Specific value: "freshness"

root anyOf item 1 entities entities items tests tests items anyOf item 4 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 entities entities items tests tests items anyOf item 4 select_columns
Type: array of string

All items must be unique

No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items tests tests items anyOf item 4 select_columns select_columns items
Type: string
root anyOf item 1 entities entities items tests tests items anyOf item 5
Type: object
No Additional Properties

root anyOf item 1 entities entities items tests tests items anyOf item 5 id
Type: string

The test's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so the columns, the SQL and the evaluators can be edited without replacing the test. Renaming the id, moving the test to another entity or changing its type replaces it, and the check entity, its issues and its error runs are discarded. Without an id the test is identified by its content, and editing a column or the SQL replaces it.

root anyOf item 1 entities entities items tests tests items anyOf item 5 type
Type: const
Specific value: "max_value"

root anyOf item 1 entities entities items tests tests items anyOf item 5 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 entities entities items tests tests items anyOf item 5 select_columns
Type: array of string

All items must be unique

No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items tests tests items anyOf item 5 select_columns select_columns items
Type: string
root anyOf item 1 entities entities items tests tests items anyOf item 6
Type: object
No Additional Properties

root anyOf item 1 entities entities items tests tests items anyOf item 6 id
Type: string

The test's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so the columns, the SQL and the evaluators can be edited without replacing the test. Renaming the id, moving the test to another entity or changing its type replaces it, and the check entity, its issues and its error runs are discarded. Without an id the test is identified by its content, and editing a column or the SQL replaces it.

root anyOf item 1 entities entities items tests tests items anyOf item 6 type
Type: const
Specific value: "min_max"

root anyOf item 1 entities entities items tests tests items anyOf item 6 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 entities entities items tests tests items anyOf item 6 select_columns
Type: array of string

All items must be unique

No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items tests tests items anyOf item 6 select_columns select_columns items
Type: string
root anyOf item 1 entities entities items tests tests items anyOf item 7
Type: object
No Additional Properties

root anyOf item 1 entities entities items tests tests items anyOf item 7 id
Type: string

The test's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so the columns, the SQL and the evaluators can be edited without replacing the test. Renaming the id, moving the test to another entity or changing its type replaces it, and the check entity, its issues and its error runs are discarded. Without an id the test is identified by its content, and editing a column or the SQL replaces it.

root anyOf item 1 entities entities items tests tests items anyOf item 7 type
Type: const
Specific value: "min_value"

root anyOf item 1 entities entities items tests tests items anyOf item 7 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 entities entities items tests tests items anyOf item 7 select_columns
Type: array of string

All items must be unique

No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items tests tests items anyOf item 7 select_columns select_columns items
Type: string
root anyOf item 1 entities entities items tests tests items anyOf item 8
Type: object
No Additional Properties

root anyOf item 1 entities entities items tests tests items anyOf item 8 id
Type: string

The test's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so the columns, the SQL and the evaluators can be edited without replacing the test. Renaming the id, moving the test to another entity or changing its type replaces it, and the check entity, its issues and its error runs are discarded. Without an id the test is identified by its content, and editing a column or the SQL replaces it.

root anyOf item 1 entities entities items tests tests items anyOf item 8 type
Type: const
Specific value: "not_null"

root anyOf item 1 entities entities items tests tests items anyOf item 8 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 entities entities items tests tests items anyOf item 8 columns
Type: array of string
No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items tests tests items anyOf item 8 columns columns items
Type: string

Must be at least 1 characters long

root anyOf item 1 entities entities items tests tests items anyOf item 8 select_columns
Type: array of string

All items must be unique

No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items tests tests items anyOf item 8 select_columns select_columns items
Type: string
root anyOf item 1 entities entities items tests tests items anyOf item 9
Type: object
No Additional Properties

root anyOf item 1 entities entities items tests tests items anyOf item 9 id
Type: string

The test's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so the columns, the SQL and the evaluators can be edited without replacing the test. Renaming the id, moving the test to another entity or changing its type replaces it, and the check entity, its issues and its error runs are discarded. Without an id the test is identified by its content, and editing a column or the SQL replaces it.

root anyOf item 1 entities entities items tests tests items anyOf item 9 type
Type: const
Specific value: "rejected_values"

root anyOf item 1 entities entities items tests tests items anyOf item 9 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 entities entities items tests tests items anyOf item 9 select_columns
Type: array of string

All items must be unique

No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items tests tests items anyOf item 9 select_columns select_columns items
Type: string
root anyOf item 1 entities entities items tests tests items anyOf item 10
Type: object
No Additional Properties

root anyOf item 1 entities entities items tests tests items anyOf item 10 id
Type: string

The test's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so the columns, the SQL and the evaluators can be edited without replacing the test. Renaming the id, moving the test to another entity or changing its type replaces it, and the check entity, its issues and its error runs are discarded. Without an id the test is identified by its content, and editing a column or the SQL replaces it.

root anyOf item 1 entities entities items tests tests items anyOf item 10 type
Type: const
Specific value: "relationships"

root anyOf item 1 entities entities items tests tests items anyOf item 10 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 entities entities items tests tests items anyOf item 10 select_columns
Type: array of string

All items must be unique

No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items tests tests items anyOf item 10 select_columns select_columns items
Type: string
root anyOf item 1 entities entities items tests tests items anyOf item 11
Type: object
No Additional Properties

root anyOf item 1 entities entities items tests tests items anyOf item 11 id
Type: string

The test's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so the columns, the SQL and the evaluators can be edited without replacing the test. Renaming the id, moving the test to another entity or changing its type replaces it, and the check entity, its issues and its error runs are discarded. Without an id the test is identified by its content, and editing a column or the SQL replaces it.

root anyOf item 1 entities entities items tests tests items anyOf item 11 type
Type: const
Specific value: "relative_time"

root anyOf item 1 entities entities items tests tests items anyOf item 11 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 entities entities items tests tests items anyOf item 11 select_columns
Type: array of string

All items must be unique

No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items tests tests items anyOf item 11 select_columns select_columns items
Type: string

root anyOf item 1 entities entities items tests tests items anyOf item 12
Type: object
No Additional Properties

root anyOf item 1 entities entities items tests tests items anyOf item 12 id
Type: string

The test's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so the columns, the SQL and the evaluators can be edited without replacing the test. Renaming the id, moving the test to another entity or changing its type replaces it, and the check entity, its issues and its error runs are discarded. Without an id the test is identified by its content, and editing a column or the SQL replaces it.

root anyOf item 1 entities entities items tests tests items anyOf item 12 type
Type: const
Specific value: "unique"

root anyOf item 1 entities entities items tests tests items anyOf item 12 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 entities entities items tests tests items anyOf item 12 columns
Type: array of string
No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items tests tests items anyOf item 12 columns columns items
Type: string

Must be at least 1 characters long

The following properties are required:

  • type

root anyOf item 1 entities entities items monitors
Type: array
No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items monitors Monitor
Type: object

root anyOf item 1 entities entities items monitors monitors items anyOf item 0
Type: object
No Additional Properties

root anyOf item 1 entities entities items monitors monitors items anyOf item 0 id
Type: string

The monitor's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so every other field can be edited without replacing the monitor. Renaming the id, moving the monitor to another entity or changing its type replaces it, discarding the learned baseline, the check entity and its issue history. Without an id the monitor is identified by its content, and editing a field of that content replaces it.

root anyOf item 1 entities entities items monitors monitors items anyOf item 0 type
Type: const
Specific value: "category_distribution"

root anyOf item 1 entities entities items monitors monitors items anyOf item 0 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 entities entities items monitors monitors items anyOf item 0 top_k_limit
Type: integer

Value must be greater or equal to 0

root anyOf item 1 entities entities items monitors monitors items anyOf item 1
Type: object
No Additional Properties

root anyOf item 1 entities entities items monitors monitors items anyOf item 1 id
Type: string

The monitor's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so every other field can be edited without replacing the monitor. Renaming the id, moving the monitor to another entity or changing its type replaces it, discarding the learned baseline, the check entity and its issue history. Without an id the monitor is identified by its content, and editing a field of that content replaces it.

root anyOf item 1 entities entities items monitors monitors items anyOf item 1 type
Type: const
Specific value: "custom_numeric"

root anyOf item 1 entities entities items monitors monitors items anyOf item 1 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 entities entities items monitors monitors items anyOf item 1 never_negative
Type: boolean

Set when metric_aggregation can never return a negative value, such as a count, a sum of non-negative amounts or a duration. The anomaly engine then never forecasts below 0 and scores each value against that floored forecast, so a zero is not measured against an impossible negative baseline. Leave it unset when the value can legitimately go below 0.
root anyOf item 1 entities entities items monitors monitors items anyOf item 2
Type: object
No Additional Properties

root anyOf item 1 entities entities items monitors monitors items anyOf item 2 id
Type: string

The monitor's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so every other field can be edited without replacing the monitor. Renaming the id, moving the monitor to another entity or changing its type replaces it, discarding the learned baseline, the check entity and its issue history. Without an id the monitor is identified by its content, and editing a field of that content replaces it.

root anyOf item 1 entities entities items monitors monitors items anyOf item 2 type
Type: const
Specific value: "custom_table_stats"

root anyOf item 1 entities entities items monitors monitors items anyOf item 2 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 entities entities items monitors monitors items anyOf item 2 metrics
Type: array
No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items monitors monitors items anyOf item 2 metrics MetricOption
Type: object

root anyOf item 1 entities entities items monitors monitors items anyOf item 2 metrics metrics items anyOf item 0
Type: enum (of string)

Must be one of:

  • "ROW_COUNT"
  • "DELAY"
  • "VOLUME_CHANGE_DELAY"
root anyOf item 1 entities entities items monitors monitors items anyOf item 2 metrics metrics items anyOf item 1
Type: object
No Additional Properties

root anyOf item 1 entities entities items monitors monitors items anyOf item 2 metrics metrics items anyOf item 1 metric
Type: enum (of string)

Must be one of:

  • "ROW_COUNT"
  • "DELAY"
  • "VOLUME_CHANGE_DELAY"

root anyOf item 1 entities entities items monitors monitors items anyOf item 2 metrics metrics items anyOf item 1 sensitivity
Type: enum (of string)

Must be one of:

  • "PRECISE"
  • "BALANCED"
  • "RELAXED"

root anyOf item 1 entities entities items monitors monitors items anyOf item 2 sensitivity
Type: enum (of string)

Must be one of:

  • "PRECISE"
  • "BALANCED"
  • "RELAXED"

root anyOf item 1 entities entities items monitors monitors items anyOf item 2 delay_model
Type: enum (of string)

Must be one of:

  • "STANDARD"
  • "WEEKLY_PATTERN"
root anyOf item 1 entities entities items monitors monitors items anyOf item 3
Type: object
No Additional Properties

root anyOf item 1 entities entities items monitors monitors items anyOf item 3 id
Type: string

The monitor's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so every other field can be edited without replacing the monitor. Renaming the id, moving the monitor to another entity or changing its type replaces it, discarding the learned baseline, the check entity and its issue history. Without an id the monitor is identified by its content, and editing a field of that content replaces it.

root anyOf item 1 entities entities items monitors monitors items anyOf item 3 type
Type: const
Specific value: "field_stats"

root anyOf item 1 entities entities items monitors monitors items anyOf item 3 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 entities entities items monitors monitors items anyOf item 3 columns
Type: array

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items monitors monitors items anyOf item 3 columns ColumnOption
Type: object

root anyOf item 1 entities entities items monitors monitors items anyOf item 3 columns columns items anyOf item 0
Type: string
root anyOf item 1 entities entities items monitors monitors items anyOf item 3 columns columns items anyOf item 1
Type: object
No Additional Properties

root anyOf item 1 entities entities items monitors monitors items anyOf item 3 columns columns items anyOf item 1 metrics
Type: array

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root anyOf item 1 entities entities items monitors monitors items anyOf item 3 columns columns items anyOf item 1 metrics metrics items

root anyOf item 1 entities entities items monitors monitors items anyOf item 3 columns columns items anyOf item 1 metrics metrics items anyOf item 0
Type: enum (of string)

Must be one of:

  • "NUM_ROWS"
  • "NUM_NULL"
  • "PCT_NULL"
  • "NUM_UNIQUE"
  • "PCT_UNIQUE"
  • "NUM_EMPTY"
  • "PCT_EMPTY"
  • "MEAN"
  • "MIN"
  • "MAX"
  • "MEDIAN"
  • "STDDEV"
root anyOf item 1 entities entities items monitors monitors items anyOf item 3 columns columns items anyOf item 1 metrics metrics items anyOf item 1
Type: object
No Additional Properties

root anyOf item 1 entities entities items monitors monitors items anyOf item 3 columns columns items anyOf item 1 metrics metrics items anyOf item 1 metric
Type: enum (of string)

Must be one of:

  • "NUM_ROWS"
  • "NUM_NULL"
  • "PCT_NULL"
  • "NUM_UNIQUE"
  • "PCT_UNIQUE"
  • "NUM_EMPTY"
  • "PCT_EMPTY"
  • "MEAN"
  • "MIN"
  • "MAX"
  • "MEDIAN"
  • "STDDEV"

root anyOf item 1 entities entities items monitors monitors items anyOf item 4
Type: object
No Additional Properties

root anyOf item 1 entities entities items monitors monitors items anyOf item 4 id
Type: string

The monitor's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so every other field can be edited without replacing the monitor. Renaming the id, moving the monitor to another entity or changing its type replaces it, discarding the learned baseline, the check entity and its issue history. Without an id the monitor is identified by its content, and editing a field of that content replaces it.

root anyOf item 1 entities entities items monitors monitors items anyOf item 4 type
Type: const
Specific value: "freshness"

root anyOf item 1 entities entities items monitors monitors items anyOf item 4 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"
root anyOf item 1 entities entities items monitors monitors items anyOf item 5
Type: object
No Additional Properties

root anyOf item 1 entities entities items monitors monitors items anyOf item 5 id
Type: stringFormat: uuid

UUID of an existing table stats rule on this asset, adopted as-is. Written by export; a redeploy then updates that rule instead of creating a second one. A non-UUID is rejected — a static rule is addressed by its asset path, so there is nothing for a slug to name.

root anyOf item 1 entities entities items monitors monitors items anyOf item 5 type
Type: const
Specific value: "table_stats"

root anyOf item 1 entities entities items monitors monitors items anyOf item 5 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 entities entities items monitors monitors items anyOf item 5 sensitivity
Type: enum (of string)

Must be one of:

  • "PRECISE"
  • "BALANCED"
  • "RELAXED"

root anyOf item 1 entities entities items monitors monitors items anyOf item 5 delay_model
Type: enum (of string)

Must be one of:

  • "STANDARD"
  • "WEEKLY_PATTERN"
root anyOf item 1 entities entities items monitors monitors items anyOf item 6
Type: object
No Additional Properties

root anyOf item 1 entities entities items monitors monitors items anyOf item 6 id
Type: string

The monitor's address within its entity and namespace. A UUID is adopted as-is; any other string is a slug the id is derived from, so every other field can be edited without replacing the monitor. Renaming the id, moving the monitor to another entity or changing its type replaces it, discarding the learned baseline, the check entity and its issue history. Without an id the monitor is identified by its content, and editing a field of that content replaces it.

root anyOf item 1 entities entities items monitors monitors items anyOf item 6 type
Type: const
Specific value: "volume"

root anyOf item 1 entities entities items monitors monitors items anyOf item 6 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

The following properties are required:

  • type

root anyOf item 1 deployment_rules
Type: array
No Additional Items

Each item of this array must be:

root anyOf item 1 deployment_rules DeploymentRuleEntry
Type: object

root anyOf item 1 deployment_rules deployment_rules items anyOf item 0
Type: object
No Additional Properties

root anyOf item 1 deployment_rules deployment_rules items anyOf item 0 id
Type: string

The rule's address. A UUID is adopted as-is; any other string is a slug the id is derived from. With an id, renaming the rule or editing its query updates it, and the tests it deployed keep their history; renaming the id replaces the rule, which deletes those tests. Without an id the name is the address, so a rename does the same.

root anyOf item 1 deployment_rules deployment_rules items anyOf item 0 type
Type: const
Specific value: "sql_tests"

root anyOf item 1 deployment_rules deployment_rules items anyOf item 0 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 deployment_rules deployment_rules items anyOf item 0 tests
Type: array

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root anyOf item 1 deployment_rules deployment_rules items anyOf item 0 tests Test
Type: object
Same definition as anyOf_i1_entities_items_tests_items
root anyOf item 1 deployment_rules deployment_rules items anyOf item 1
Type: object
No Additional Properties

root anyOf item 1 deployment_rules deployment_rules items anyOf item 1 id
Type: string

The rule's address. A UUID is adopted as-is; any other string is a slug the id is derived from. With an id, renaming the rule or editing its query updates it; renaming the id replaces it. Without one the name is the address, so a rename replaces the rule.

root anyOf item 1 deployment_rules deployment_rules items anyOf item 1 type
Type: const
Specific value: "table_stats"

root anyOf item 1 deployment_rules deployment_rules items anyOf item 1 severity
Type: enum (of string)

Must be one of:

  • "INFO"
  • "WARNING"
  • "ERROR"

root anyOf item 1 deployment_rules deployment_rules items anyOf item 1 sensitivity
Type: enum (of string)

Must be one of:

  • "PRECISE"
  • "BALANCED"
  • "RELAXED"

root anyOf item 1 deployment_rules deployment_rules items anyOf item 1 delay_model
Type: enum (of string)

Must be one of:

  • "STANDARD"
  • "WEEKLY_PATTERN"

The following properties are required:

  • type

root anyOf item 1 deployment_exclusions
Type: array
No Additional Items

Each item of this array must be:

root anyOf item 1 deployment_exclusions DeploymentExclusion
Type: object
No Additional Properties

root anyOf item 1 deployment_exclusions deployment_exclusions items id
Type: string

The exclusion's address. A UUID is adopted as-is; any other string is a slug the id is derived from. With an id, renaming the exclusion or editing its query updates it; renaming the id replaces it. Without one the name is the address, so a rename replaces the exclusion.

root anyOf item 1 deployment_exclusions deployment_exclusions items type
Type: enum (of string)

Must be one of:

  • "table_stats"