Updated on 2025-09-05 GMT+08:00

Generating a Workload Diagnosis Report

Scenarios

You can collect and download workload diagnosis reports (WDRs) on the GaussDB console.

Constraints

The DB engine version of GaussDB instances must be V2.0-3.100 or later, and the kernel version must be 503.0 or later. For details about how to query the version, see Checking the DB Engine and Kernel Engine Version of a GaussDB Instance.

Precautions

The two snapshots used to generate a report should meet the following conditions:

  • No node is rebooted between the two snapshots.
  • No primary/standby switchover is performed between the two snapshots.
  • No DROP operation is performed on the database between the two snapshots.
  • The DB instance is not read-only.
  • The DB instance is not a DR instance.

Operation tips:

  • To generate a snapshot immediately without waiting for the specified generation interval, click Create Snapshot.
  • By default, snapshots are generated every 60 minutes. Set the collection period based on the specified generation interval. If the specified period is shorter than the interval, the collection fails.
  • If the number of generated snapshots exceeds the maximum number allowed within the retention period (24 x 8 = 192 by default), each time a new snapshot is generated, the system deletes the snapshot with the lowest snapshot ID.
  • Snapshot collection may fail if the data is collected when a large number of DDL statements are executed.
  • If a DB instance contains a large number of databases or tables, it takes a long time to collect snapshot data.
  • The kernel collects data from DNs by shard. If you select one DN in a shard in a WDR report, data of all DNs in that shard will be displayed. Assume that dn_6001, dn_6002, and dn_6003 belong to the same shard. If dn_6001 is selected for data collection, dn_6001_6002_6003 is displayed in the report.

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and project.
  3. Click in the upper left corner of the page and choose Databases > GaussDB.
  4. On the Instances page, click the name of the target instance to go to the Basic Information page.
  5. In the navigation pane, choose Diagnostics and Optimization > Performance Reports.

  6. Specify the snapshot collection period as required and click Create Snapshot.

    This operation will trigger a full WDR snapshot query to retrieve all available completed snapshots within the specified period. Any time ranges that include kernel reset events (node restarts, primary/standby switchovers, RESET operations on performance metrics, or DROP DATABASE operations) will be excluded. The system then displays all available snapshot ranges.

  7. Specify Collection Type.

    • In the Collection Type field, select a type as required.

      Instance level and Component level are available. You can change selected components if Component level is selected.

    Figure 1 WDR task configuration

  8. Click Collect to submit the snapshot collection and WDR report creation task.
  9. View the WDR task list and wait until the task is created.

    • If the collection status is Successful, click Download WDR to obtain the performance report of the specified period.
      Figure 2 WDR task list

    • If the collection status is Failed, contact Huawei Cloud customer service.