Create a table monitor.
create_lakehouse_monitor.Rd
Creates a new monitor for the specified table.
Usage
create_lakehouse_monitor(
client,
full_name,
assets_dir,
output_schema_name,
baseline_table_name = NULL,
custom_metrics = NULL,
data_classification_config = NULL,
inference_log = NULL,
notifications = NULL,
schedule = NULL,
skip_builtin_dashboard = NULL,
slicing_exprs = NULL,
snapshot = NULL,
time_series = NULL,
warehouse_id = NULL
)
lakehouseMonitorsCreate(
client,
full_name,
assets_dir,
output_schema_name,
baseline_table_name = NULL,
custom_metrics = NULL,
data_classification_config = NULL,
inference_log = NULL,
notifications = NULL,
schedule = NULL,
skip_builtin_dashboard = NULL,
slicing_exprs = NULL,
snapshot = NULL,
time_series = NULL,
warehouse_id = NULL
)
Arguments
- client
Required. Instance of DatabricksClient()
- full_name
Required. Full name of the table.
- assets_dir
Required. The directory to store monitoring assets (e.g.
- output_schema_name
Required. Schema where output metric tables are created.
- baseline_table_name
Name of the baseline table from which drift metrics are computed from.
- custom_metrics
Custom metrics to compute on the monitored table.
- data_classification_config
The data classification config for the monitor.
- inference_log
Configuration for monitoring inference logs.
- notifications
The notification settings for the monitor.
- schedule
The schedule for automatically updating and refreshing metric tables.
- skip_builtin_dashboard
Whether to skip creating a default dashboard summarizing data quality metrics.
- slicing_exprs
List of column expressions to slice data with for targeted analysis.
- snapshot
Configuration for monitoring snapshot tables.
- time_series
Configuration for monitoring time series tables.
- warehouse_id
Optional argument to specify the warehouse for dashboard creation.
Details
The caller must either: 1. be an owner of the table's parent catalog, have USE_SCHEMA on the table's parent schema, and have SELECT access on the table 2. have USE_CATALOG on the table's parent catalog, be an owner of the table's parent schema, and have SELECT access on the table. 3. have the following permissions: - USE_CATALOG on the table's parent catalog - USE_SCHEMA on the table's parent schema - be an owner of the table.
Workspace assets, such as the dashboard, will be created in the workspace where this call was made.