In the native distributed database system OceanBase Database, root cause analysis for faults is complex because many factors may be involved, such as the server environment, parameters, and running load. A large amount of information must be collected and analyzed for troubleshooting. OceanBase Diagnostic Tool (obdiag) is designed to help you efficiently collect information scattered on various nodes.
What is obdiag?
obdiag is a CLI diagnostic tool designed for OceanBase Database. It scans and collects information such as the logs, SQL audit records, and the process stack information of OceanBase Database. You may deploy your OceanBase cluster by using OceanBase Cloud Platform (OCP) or OceanBase Deployer (OBD), or manually deploy it based on the OceanBase documentation. Regardless of the deployment mode, you can use obdiag to collect diagnostic information with a few clicks.
Features and characteristics
obdiag has the following characteristics:
Easy deployment: You can deploy obdiag by using the RPM package or OBD with a few clicks. You can deploy it on an OBServer node or any server that can connect to nodes in the OceanBase cluster.
Out-of-the-box: The Python packages required for running obdiag are all built-in packages. In other words, obdiag can directly run provided that the Python2 or Python3 environment exists on the server where obdiag is deployed.
Centralized collection: You need to deploy obdiag only on a single server rather than all servers. Then, you can execute collection or analysis commands on the server where obdiag is deployed.
obdiag V1.4.0 and later allow you to perform the following operations with a few clicks:
- Collect logs of OceanBase Database
- Collect automatic Workload Repository (AWR) reports (OCP Enterprise Edition required)
- Collect host information
- Collect stack information of OceanBase Database
- Collect parsed commit logs (clogs) and SSTable logs (slogs)
- Collect Perf information of OceanBase Database
- Collect execution details of parallel SQL statements
- Collect logs of OceanBase Database Proxy (ODP)
- Analyze logs of OceanBase Database to identify errors that have occurred
- Inspect OceanBase clusters for possible or existing exceptions, analyze their causes, and provide O&M suggestions