Add and manage monitored objects - Dataphin - Alibaba Cloud Documentation Center

This topic describes how to add monitored objects and manage their quality rules.

Limitations

If a project or database contains tables with the same name but in different cases, you can add only one as a monitored object.
You can select a maximum of 200 monitored objects in a single batch operation.
Only Dataphin data tables and global data tables support the configuration of quality score weights.

Note

The quality score weight of a monitored object is used to calculate the overall quality score from the project, data source, and personal perspectives.

Permissions

Super administrators and quality administrators can add monitored objects.
You can export quality rules only for monitored objects that you have permission to view.
The permissions for operations vary depending on the object type. For more information, see Quality rule operation permissions.

View Quality Rules From Different Perspectives

Dataphin allows you to view quality rules for data tables from three perspectives: Global, Project, and Personal.

Global: Super administrators, quality administrators, and custom global roles with Quality Rule - Manage permission can view all data table quality rules.
Project: Super administrators and quality administrators can switch between all projects to view their data table quality rules. Project members can only select projects they belong to and view the quality rules within them.
Personal: Super administrators and quality administrators can switch to any member's view to see their data table quality rules. Regular members can only view quality rules for data tables for which they are the quality owner and cannot switch to other views.

Note

If permission restrictions are enabled for a quality rule, those restrictions take precedence.
The Project perspective displays only the monitored objects and quality rules within the selected project.
The Personal perspective displays only the monitored objects and quality rules for which you or your user group are the quality owner.

Add Monitored Object

On the Dataphin homepage, choose Governance > Data Quality from the top menu bar.
From the left-side navigation pane, choose Quality Monitoring > Quality Rules. On the Quality Rules page, click Add Monitored Object in the upper-right corner.
In the Add Monitored Object dialog box, filter for objects based on the following criteria:
- Dataphin Table: Filter data tables by project (for physical tables) or business category (for logical tables).
- Global Data Table: Filter data tables by data source type, data source, and database/schema. For a list of supported data sources, see Dataphin supported data sources. If a data source cannot connect to the Dataphin cluster, you must first perform metadata collection before you can configure quality rules. For more information, see Create and manage metadata collection tasks.
- Metric: Filter metrics by data sector and summary logical table.
- Data Source: Filter by data source type. You can create quality monitoring rules for any data source in Dataphin. Connectivity tests are available for all supported data sources, but only some data sources support quality rules for monitoring table structure changes. For more information, see Dataphin supported data sources.
- Real-time metatable: Filter data tables by environment and project.
Click Configure Quality Rule to go to the rule configuration page.

Manage The List Of Monitored Objects

On the Quality Rules page, you can view information about your configured quality rules, such as table name, project/business category, and the number of active/total rules. You can also perform actions like viewing details, running checks, managing quality owners, and deleting objects. The interface is the same for all monitored object types. The following example uses a Dataphin Table.

Actions	Description
Individual operations
View quality rule details	View the configuration details of the quality rules for the data table.
Run	Run a check on the data table based on its schedule configuration or a custom partition.
View quality report	View the quality report for the data table.
Manage quality owner	Assign a user or user group to manage the quality rules. Personal Account: Select a user with an active account in the current tenant. User Group: Select an active and enabled user group. Membership is automatically updated based on changes to the user group. To create a user group, see Create and manage user groups.
Edit quality score weight	Modify the quality score weight. Important This is only supported for Dataphin tables and global data tables. The quality score weight of a quality rule is used to calculate the quality score of the monitored object. Modifying the weight affects the quality scoring results. Proceed with caution.
Delete	Deleting a monitored object also deletes all its quality rules. This action cannot be undone.
Batch operations
Run	Run checks on multiple data tables at once, based on their schedule configurations or a custom partition. You can choose to scan the full table for non-partitioned tables. Note By default, the scan scope applies to both partitioned and non-partitioned tables. When running a batch job, you can choose to scan the full table for non-partitioned tables, while partitioned tables still adhere to their configured scan scope. When running a batch job, select tables that share the same partition structure. The partition information is passed directly to the execution engine, and mismatches may cause errors.
Batch manage quality owners	Assign users to manage the quality rules. You can add (Append) or replace (Modify) quality owners for multiple objects at once. Append: Add new quality owners to the existing list by selecting users and user groups. Modify: Replace the entire list of current quality owners with the newly specified users and user groups.
Export rules	Select one or more monitored objects, and then click Export Rules to export all custom SQL quality rules that you have permission to view. You can export rules based on system or custom templates. For configuration details, see Export all quality rules. Note This feature is supported only for Dataphin tables and global data tables.
Enable/disable quality rule checks	Enable or disable quality rule checks for multiple objects at once.
Edit quality score weight	Modify quality score weights in a batch. Important This is supported only for Dataphin tables and global data tables. The quality score weight of a quality rule is used to calculate the quality score of the monitored object. Modifying the weight affects the quality scoring results. Proceed with caution.
Alert configuration	Configure alert settings in a batch for quality rules across different monitored objects. If an alert configuration with the same monitoring scope already exists for a selected object, the new settings overwrite the existing ones. If no such configuration exists, a new one is created. When you configure alerts in a batch, the monitoring scope is limited to: All Rules, All Strong Rules, and All Weak Rules. For configuration details, see Alert configuration. Note To define a custom monitoring scope, configure alerts for each monitored object individually. After configuring alerts in a batch, check if the changes affect the effective order of alerts.
Permission management	Manage which members can view check history details, quality rule details, and quality reports. In the Quality Rule Permission Management dialog box, select the members and click OK.
Delete	Delete multiple monitored objects at once. This operation also deletes all their quality rules and cannot be undone.

Next Steps

After adding a monitored object, you can configure quality rules to monitor it. For more information, see the following topics: