OceanBase Database is a native distributed database system, so root cause analysis for faults is often complex, as it may involve many factors such as server environment, configuration parameters, and operational loads. When troubleshooting issues, experts need to collect extensive information for fault analysis. This is where OceanBase Diagnostic Tool (obdiag) comes into play. It aims to efficiently collect and analyze information dispersed across various nodes.
What is obdiag?
obdiag is a CLI diagnostic tool designed for OceanBase Database. It scans and collects information such as logs, SQL audit records, and process stack information of OceanBase Database. You can use obdiag to collect diagnostic information with a few clicks when your OceanBase cluster is deployed in different modes, for example, by using OceanBase Cloud Platform (OCP) or OceanBase Deployer (OBD), or manually deployed based on relevant documentation.
Features
obdiag has the following features:
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.
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.5.0 allows 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 the host information
- Collect the stack information of OceanBase Database
- Collect the parsed commit logs (clogs) and SSTable logs (slogs)
- Collect the performance information of OceanBase Database
- Collect the 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
- Collect, inspect, and analyze the diagnostic information and logs of an OceanBase cluster deployed by using Docker
- Inspect an OceanBase cluster during a stress test using Sysbench and analyze the causes of existing or possible cluster exceptions to provide O&M suggestions
- Perform end-to-end diagnostics based on the
trace.logfile