Parameter inspection and comparison

Background

The parameter inspection and comparison features support customizable rule templates. You can use these templates to periodically run parameter inspection and comparison tasks for your instances, either automatically or manually. The results are presented as reports that provide diagnostic recommendations and details about inconsistent parameter settings between instances.

Use cases

• Parameter inspection: Checks the parameter settings of instances in batches against custom or default recommended values.

  • Custom parameter values: Values that you specify based on your business requirements.

  • Default recommended values: Values recommended by DAS, consistent with the parameter diagnostics feature. These values are derived from instance status information, parameter templates, baseline concepts for additional parameters, calculation formulas, and expert experience.

• Parameter comparison: Identifies differences in parameter settings between instances, or between an instance's parameter values and user-defined values.

Limitations

• The database engine must be one of the following:

  • ApsaraDB RDS for MySQL (MySQL cluster series are not supported)

  • PolarDB for MySQL

• The database instance must be connected to DAS and its status is Normal Access. For more information, see Connect a database instance to DAS.

• Only parameters that are modifiable in the console can be inspected and compared.

• You can create a maximum of 100 rules.

  • A rule defines the basic configuration for parameter inspection or comparison, including an alias, remarks, a supported engine, and an analysis type. You can also set target parameter values for the inspection or comparison.

• You can create a maximum of 100 templates.

  • A template is a runnable configuration built from rules for parameter inspection and comparison, including an alias, remarks, an associated base rule, an automatic inspection cycle, and an enabled status. You can also select the instances to which the template applies.

• A parameter inspection template can be associated with a maximum of 100 instances.

• A parameter comparison template can be associated with a maximum of 10 instances.

• An instance can be associated with only one template of a given type (inspection or comparison) at a time. A new association overwrites the existing one.

• Only parameter inspection supports automatic task initiation, so only inspection templates support cycle configuration.

Features

• Rule templates

  • Create and manage rules

    On the Rule Management page, search for rules by Rule Alias or Rule ID, filter them by Engine and Type, and perform batch deletions.

    • Create a rule: Create custom rules for parameter inspection and comparison for ApsaraDB RDS for MySQL and PolarDB for MySQL, and set the corresponding parameter values for analysis.

      Analysis tasks perform parameter inspection and comparison based on the following priority: Specific parameter values (if set) > Instance parameter values (if selected) > Default recommended values (consistent with parameter diagnostics recommendations).

    • Manage rules: On the rule management page, you can view, modify, and delete rules.

  • Create and manage templates

    On the rule template management page, filter templates by template alias or ID, engine, type, and enabled status. You can also perform batch deletions, bulk enable, and bulk disable operations.

    • Create a template: Create templates for parameter inspection and comparison based on rules. You can customize the automatic inspection cycle, set the template status, and select the instances to which the template applies.

      Important

      You cannot set a cycle for parameter comparison templates.

    • Manage templates: On the template management page, you can view, modify, and delete templates, and change the associations between instances and templates.

• Initiate tasks

  • Automatic inspection tasks: Enabled inspection templates run parameter inspection tasks automatically on the configured cycle.

  • Manual tasks: Select a template to manually start a parameter inspection or comparison task. For parameter comparison, you can also select instances directly to run an ad-hoc comparison of their parameter settings.

• View results

  • View an overview of historical tasks and detailed task reports on the feature page.

    The Parameter Inspection and Comparison page has two tabs: MySQL and PolarDB for MySQL. Click Initiate Task to create an inspection or comparison task, and filter tasks by criteria such as task type and initiation type. The task list shows the task type, start and completion times, initiation type (manual or automatic), configuration, and status. In the Actions column, click View Report to view the corresponding report.

    • Parameter inspection: View the report to see recommendations from parameter diagnostics.

    • Parameter comparison: View the report to see the comparison of parameter settings.

Procedure

1. Log on to the DAS console.

2. In the left-side navigation pane, choose Tools > Inspection and Scoring.

3. Then, click Parameter Inspection and Comparison.

4. Click Settings to open the rule template page.

   1. Configure rules

      1. Create a rule: In the upper-left corner, click Rule Management, and then click Create Rule in the drawer that appears.

      2. View rules: You can search for existing rules by rule ID or rule alias, or filter rules by engine and type.

      3. Manage rules: In the Actions column, click Details to view and modify a rule. You can delete rules individually or in batches.

      Parameter	Description
      Rule alias	A custom alias to quickly identify the rule.
      Rule remarks	Custom remarks that briefly describe the rule.
      Engine type	The engine type that the rule applies to. MySQL: The rule applies to the ApsaraDB RDS for MySQL engine. PolarDB for MySQL: The rule applies to the PolarDB for MySQL engine.
      Type	The rule type. Parameter Inspection Rule Parameter Comparison Rule
      Parameter values	The baseline parameter values for inspection or comparison. By default, the parameter values consistent with the parameter diagnostics recommendations are used. Select instance parameter values: Uses a snapshot of the selected instance's current parameter values for analysis. Select specific parameter values: Uses the specified parameter settings for analysis. Important Analysis tasks prioritize parameter value sources in the following order: Specific parameter values (if set) > Instance parameter values (if set) > Default recommended values. Make sure that you enter the parameter names and values in the correct format.

   2. Configure templates

      1. Create a template: In the upper-left corner, click Create Template and configure the settings in the dialog box that appears.

      2. View templates: You can search for existing templates by template ID or template alias, or filter templates by engine, type, and enabled status.

      3. Manage templates: In the Actions column, click Details to view and modify a template. You can delete templates or change their enabled status individually or in batches. In the Actions column, click Select Instance to adjust the associations between instances and the template.

         Parameter	Description
         Template alias	A custom alias to quickly identify the template.
         Template remarks	Custom remarks that briefly describe the template.
         Enabled status	The template's enabled status. Note When you create an analysis task, you can select only enabled templates.
         Associated rule	Each template must be associated with a rule. Important After the initial association, the associated rule can only be changed to another rule of the same engine and type.
         Cycle	The template's execution cycle. Important Only parameter inspection supports custom cycles. You cannot select a cycle when the associated rule type is parameter comparison.
         Select instances	Select the instances to which this template applies. Important A parameter inspection template can be associated with a maximum of 100 instances. A parameter comparison template can be associated with a maximum of 10 instances. An instance can be associated with only one template of a given type (inspection or comparison) at a time. A new association overwrites the existing one. The analysis process removes expired associated instances.

5. After the template is configured, parameter inspection tasks run automatically based on the template. Alternatively, on the Parameter Inspection and Comparison tab, click Initiate Task to manually create a parameter inspection or comparison task.

   Type	Manual initiation
   Parameter inspection	Select an enabled parameter inspection template to initiate a task.
   Parameter comparison	Select an enabled parameter comparison template to initiate a task. Select instances to initiate an ad-hoc parameter comparison task.

6. On the corresponding engine tab, view the detailed results of the parameter inspection and comparison.

   1. On this page, you can filter tasks by Task Type and Initiation Type.

   2. In the Actions column, click View Report to view the detailed results.

      Recommendation levels in diagnosis results:

      Level	Description
      Important	The parameter value is user-defined.
      Critical	Immediate modification is recommended.
      Warn	Consider modifying the parameter value based on your needs.
      Notice	The parameter value differs from the value in the default engine template.

Related documentation

Best practices for parameter inspection and comparison