Diagnosing a RocketMQ Instance
You can diagnose an instance to quickly locate faults when message consumption is slow or fails.
Prerequisites
- A consumer group has been created, and there are consumers in the group.
- A topic has been created.
Procedure
- Log in to the RocketMQ console.
- Click a RocketMQ instance name to go to the instance overview page.
- In the navigation pane on the left, choose Analysis & Diagnosis > Instance Diagnosis.
- Select a consumer group and click Start Diagnose.
After the diagnosis is complete, a diagnosis record is displayed in the Diagnosis Reports area.
- Click View to go to the Diagnosis Report to view the diagnosis result.
The result contains the active status, number of consumers, subscription consistency, client ID, consumption type, and message accumulation.
Figure 1 Diagnosis result
If the consumer group is not online, the diagnosis is successful, but one abnormality is displayed.
- (Optional) In the Consumer Connections area, click View in the Operation column to view the diagnosis details.
Figure 2 Diagnosis details
Exporting Diagnosis Records
- Log in to the RocketMQ console.
- Click a RocketMQ instance name to go to the instance overview page.
- In the navigation pane on the left, choose Analysis & Diagnosis > Instance Diagnosis.
- Export instance diagnosis records in either of the following ways:
- Select the desired records and choose Export > Export selected data to an XLSX file.
- Choose Export > Export all data to an XLSX file to export all the records.
Deleting Diagnosis Records
- Log in to the RocketMQ console.
- Click a RocketMQ instance name to go to the instance overview page.
- In the navigation pane on the left, choose Analysis & Diagnosis > Instance Diagnosis.
- Use either of the following methods to delete diagnosis records:
- In the row containing the record you want to delete, click Delete.
- Select multiple records you want to delete and click Delete above the record list.
- In the confirmation dialog box, click OK.
Related Documents
- To handle message accumulation excess, see Handling Message Accumulation.
- To handle subscription inconsistency, see Ensuring Subscription Consistency.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.