DESCRIBE MODEL MONITOR¶

Displays information about a specific model monitor. This command displays all the information shown by the SHOW MODEL MONITORS command, plus additional information.

DESCRIBE can be abbreviated to DESC.

See also:: CREATE MODEL MONITOR, ALTER MODEL MONITOR, SHOW MODEL MONITORS, DROP MODEL MONITOR

Syntax¶

{ DESCRIBE | DESC } MODEL MONITOR <monitor_name>

Copy

Parameters¶

monitor_name

Specifies the identifier for the model monitor to describe.

If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.

For more information, see Identifier requirements.

Output¶

The command output provides model monitor properties and metadata in the following columns:

Column	Description
`created_on`	Date and time when the model monitor was created.
`name`	Name of the model monitor.
`database_name`	Database in which the model monitor is stored.
`schema_name`	Schema in which the model monitor is stored.
`warehouse_name`	Warehouse used to monitor the model.
`refresh_interval`	The refresh interval (target lag) for triggering refresh of the model monitor.
`aggregation_window`	The aggregation window for calculating metrics.
`model_task`	The task of the model being monitored, either TABULAR_BINARY_CLASSIFICATION or TABULAR_REGRESSION.
`monitor_state`	The state of the model monitor: ACTIVE: The model monitor is active and operating correctly. SUSPENDED: Model monitoring is paused. PARTIALLY_SUSPENDED: An error condition in which one of the underlying tables has stopped refressing at the expected enterval. See DESCRIBE for more details. UNKNOWN: An error condition in which the state of the underlying tables cannot be identified.
`source`	String representation of a JSON object detailing the source table or view on which aggregations are based. If the table does not exist or is not accessible, the value is an empty string. See Table JSON object specification.
`baseline`	String representation of a JSON object detailing baseline table being used for monitoring, of which a clone is embedded in the model monitor object. See Table JSON object specification.
`model`	String representation of a JSON object containing information specifically about the model being monitored. See Model JSON object specification.
`comment`	Comment about the model monitor.
The following columns are the additional columns displayed by DESCRIBE compared to SHOW
`aggregation_status`	A string representation of a JSON object that contains the aggregation status of each type of nested dynamic table. The key can be either SOURCE_AGGREGATED or ACCURACY_AGGREGATED. The value con be ACTIVE or SUSPENDED.
`aggregation_last_error`	A string representation of a JSON object that contains the last error of each type of nested dynamic table. The key can be either SOURCE_AGGREGATED or ACCURACY_AGGREGATED. The value is an error message, or an empty string if the last run completed successfully.
`aggregation_last_data_timestamp`	A string representation of a JSON object that contains the last time type of nested dynamic table was updated. The key can be either SOURCE_AGGREGATED or ACCURACY_AGGREGATED. The value is a timestamp.
`columns`	A string representation of a JSON object that contains names of columns being used in the source table. See Column JSON object specification.

Table JSON object specification¶

The following is the format of the JSON representation of a table, as used by the source and baseline columns in the command output:

`name`	Name of the source or baseline table or view.
`database_name`	Database in which the table or view is stored.
`schema_name`	Schema in which the table or view is stored.
`status`	The status of the table: ACTIVE: The table or view is accessible by the user. MASKED: The current user does not have access to the table or view. Values of other fields appear masked (that is, as a series of asterisks). DELETED: The table or view has been deleted. NOT_SET: The status has not been set.

name

Name of the source or baseline table or view.

database_name

Database in which the table or view is stored.

schema_name

Schema in which the table or view is stored.

status

The status of the table:

ACTIVE: The table or view is accessible by the user.
MASKED: The current user does not have access to the table or view. Values of other fields appear masked (that is, as a series of asterisks).
DELETED: The table or view has been deleted.
NOT_SET: The status has not been set.

Model JSON object specification¶

The following is the format of the JSON representation of a model, as used by the model column in the command output:

Field	Description
`model_name`	Name of the model being monitored.
`version_name`	Version name of the model version being monitored.
`function_name`	Name of the specific function being monitored in the specified model version.
`database_name`	Database in which the model is stored.
`schema_name`	Schema in which the model is stored.
`model_status`	The status of the model. Can be ACTIVE, MASKED, or DELETED. MASKED indicates that the user does not have access to the model; other fields show as a series of asterisks.
`version_status`	The status of the model version. Can be ACTIVE or DELETED. (MASKED is not a valid status for a model version, because they do not have access control.)

Column JSON object specification¶

The following is the format of the JSON representation of columns, as used by the columns column in the command output:

Field	Description
`timestamp_column`	Name of the timestamp column in the data source.
`id_columns`	An array of string column names that, together, uniquely identify each row in the source data.
`prediction_class_columns`	An array of strings naming all prediction class columns in the data source.
`prediction_score_columns`	An array of strings naming all prediction score columns in the data source.
`actual_class_columns`	An array of strings naming all actual class columns in the data source.
`numerical_columns`	An array of strings naming all numerical feature columns that the model monitor uses from the source table.
`string_columns`	An array of strings naming all string (categorical) feature columns that the model monitor uses from the source table.
`boolean_columns`	An array of strings naming all Boolean (categorical) feature columns that the model monitor uses from the source table.

Access control requirements¶

A role used to execute this SQL command must have the following privileges at a minimum:

Privilege	Object	Notes
Any	Model monitor

The USAGE privilege on the parent database and schema are required to perform operations on any object in a schema.

For instructions on creating a custom role with a specified set of privileges, see Creating custom roles.

For general information about roles and privilege grants for performing SQL actions on securable objects, see Overview of Access Control.