Skip to content

Commit cac7606

Browse files
authored
Docs: add description for new fields in databricks_lakehouse_monitor (#3472)
New fields came from Go SDK update
1 parent 160f38e commit cac7606

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/resources/lakehouse_monitor.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ The following arguments are supported:
8888
* `baseline_table_name` - Name of the baseline table from which drift metrics are computed from.Columns in the monitored table should also be present in the baseline
8989
table.
9090
* `custom_metrics` - Custom metrics to compute on the monitored table. These can be aggregate metrics, derived metrics (from already computed aggregate metrics), or drift metrics (comparing metrics across time windows).
91-
* `definition` - [create metric definition]: https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition
91+
* `definition` - [create metric definition](https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition)
9292
* `input_columns` - Columns on the monitored table to apply the custom metrics to.
9393
* `name` - Name of the custom metric.
9494
* `output_data_type` - The output type of the custom metric.
@@ -106,8 +106,13 @@ table.
106106
* `time_series` - Configuration for monitoring timeseries tables.
107107
* `granularities` - List of granularities to use when aggregating data into time windows based on their timestamp.
108108
* `timestamp_col` - Column of the timestamp of predictions
109-
* `notifications` - The notification settings for the monitor
110-
* `schedule` - The schedule for automatically updating and refreshing metric tables.
109+
* `notifications` - The notification settings for the monitor. The following optional blocks are supported, each consisting of the single string array field with name `email_addresses` containing a list of emails to notify:
110+
* `on_failure` - who to send notifications to on monitor failure.
111+
* `on_new_classification_tag_detected` - Who to send notifications to when new data classification tags are detected.
112+
* `schedule` - The schedule for automatically updating and refreshing metric tables. This block consists of following fields:
113+
* `quartz_cron_expression` - string expression that determines when to run the monitor. See [Quartz documentation](https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) for examples.
114+
* `timezone_id` - string with timezone id (e.g., `PST`) in which to evaluate the Quartz expression.
115+
* `pause_status` - optional string field that indicates whether a schedule is paused (`PAUSED`) or not (`UNPAUSED`).
111116
* `skip_builtin_dashboard` - Whether to skip creating a default dashboard summarizing data quality metrics.
112117
* `slicing_exprs` - List of column expressions to slice data with for targeted analysis. The data is grouped by each expression independently, resulting in a separate slice for each predicate and its complements. For high-cardinality columns, only the top 100 unique values by frequency will generate slices.
113118
* `warehouse_id` - Optional argument to specify the warehouse for dashboard creation. If not specified, the first running warehouse will be used.

0 commit comments

Comments
 (0)