OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase Diagnostic Tool

V4.3.0
  • obdiag Overview
  • obdiag installation
  • obdiag configuration
  • One-click Cluster Inspection
    • One-click cluster inspection
    • Detailed explanation of cluster inspection indicators
  • One-click Information Gathering
    • One-click routine information collection
      • OceanBase cluster log collection
      • Host information collection
      • SQL details collection
      • Stack information collection
      • Flame Picture/Bian Que Picture Collection
      • ASH report collection
      • Collect table-related information
      • Cluster parameter collection
      • Variable collection
      • clog/slog collection
      • DBMS_XPLAN information collection
      • Core file collection
      • AWR report collection
      • obproxy log collection
      • OMS log collection
      • Collect all information
    • One-click scenario-based information collection
      • Overview
      • Collect basic cluster information
      • Collect backup problem information
      • Collect backup cleanup problem information
      • Collect clog disk full problem information
      • Collect cluster downtime problem information
      • Collect merge problem information
      • Collect CPU high problem information
      • Collect information on delay issues in primary and standby databases
      • Collect I/O problem information
      • Collect log archiving problem information
      • Collect long transaction problem information
      • Collect memory problem information
      • Collect SQL performance problem information
      • Collect PX error reporting information
      • Collect recovery problem information
      • Collect observer restart information without reason
      • Collect owner-cutting problem information
      • Collect information about hanging transaction issues
      • Collect copy imbalance problem information
      • Collect SQL error reporting information
      • Collect cluster TopSQL information
      • Collect application error information
      • Collect obproxy restart problem information for no reason
      • Collect ODP parameter information
      • Collect unspecified scenario problem information
  • One-click Diagnostic Analysis
    • One-click diagnostic analysis log
    • One-click full-link diagnostic log analysis
    • Parameter analysis (compared with default values)
    • Parameter analysis (parameter differences on different observers)
    • Analyze variables
    • Instructions for using index space analysis
    • One-click diagnostic analysis of memory
    • One-click diagnosis and analysis of queue backlog
  • One-click Root Cause Analysis
    • One-click root cause analysis
    • Root cause analysis scenario: disconnection
    • Root cause analysis scenario: card merging major_hold
    • Root cause analysis scenario: lock conflict lock_conflict
    • Root cause analysis scenario: executing DDL and reporting disk full error ddl_disk_full
    • Root cause analysis scenario: clog disk is full clog_disk_full
    • Root cause analysis scenario: log error log_error
    • Root cause analysis scenario: DDL failure ddl_failure
    • Root cause analysis scenario: Troubleshooting index build execution error index_ddl_error
    • Root cause analysis scenario: transaction disconnection scenario transaction_disconnection
    • Root cause analysis scenario: transaction execution times out and error transaction_execute_timeout
    • Root cause analysis scenario: transaction does not end and error transaction_not_ending is reported
    • Root cause analysis scenario: transaction other errors transaction_other_error
    • Root cause analysis scenario: transaction rollback error transaction_rollback
    • Root cause analysis scenario: transaction wait timeout error transaction_wait_timeout
    • Root cause analysis scenario: OMS full migration exception oms_full_trans
    • Root cause analysis scenario: OMS obcdc component analysis oms_obcdc
    • Root cause analysis scenario: suspended transaction suspend_transaction
    • Root cause analysis scenario: Unit GC exception unit_gc
    • Root cause analysis scenario: OceanBase cluster playback card
    • Root cause analysis scenario: OceanBase cluster memory explosion
    • Root cause analysis scenario: Abnormal deletion of OBServer node
    • Root cause analysis scenario: GC troubleshooting gc_troubleshooting
    • Root cause analysis scenario: Schema leak schema_leak
    • Root cause analysis scenario: partition split scheduling error split_schedule_error
    • Root cause analysis scenario: weak read problem troubleshooting weak_read_troubleshooting
    • Root cause analysis scenario: SQL execution memory is too high execute_memory_high
  • One-click Cluster Insights
    • Overview
    • Cluster overview information insights
    • Cluster node information insight
    • Cluster unit information insight
    • Cluster Zone Information Insights
    • Cluster RS Information Insights
    • Cluster tenant information insight
    • Cluster event information insight
    • Cluster lock information insight
    • Cluster topsql information insight
    • Cluster slowsql information insight
    • Cluster table information insight
    • Cluster processlist information insight
    • SQL execution plan information insights
    • Insights into database disk usage information
    • Insight on the disk usage of the specified table in the database
    • Insights into the full tenant information of the cluster
    • Cluster node CPU usage information insights
    • Internal table name fuzzy matching information insight
    • Cluster leader information insight
    • Information insights into locks held on a certain table
    • Cluster long transaction information information insight
    • Actual execution plan operator information insight
    • Memory information insights for all tenants
    • processlist Real-time session summary information insights
    • Table/index storage method information insight
    • Table NDV Information Insights
    • Table index information insight
    • Merge status display
    • clog log volume/capacity statistics
  • Plug-in file upgrade
  • Update and uninstall
  • Telemetry Mode
  • FAQ
  • Tools
    • Configuration file encryption
    • AI Intelligent Diagnosis Assistant
    • Disk IO performance detection
    • Configure verification tool
  • Release Notes
    • obdiag V4.2.0
    • obdiag V4.1.0
    • obdiag V4.0.0
    • obdiag V3.7.2
    • obdiag V3.7.1
    • obdiag V3.7.0
    • obdiag V3.6.0
    • obdiag V3.5.0
    • obdiag V3.4.0
    • obdiag V3.3.0
    • obdiag V3.2.0
    • obdiag V3.1.0
    • obdiag V3.0.0
    • obdiag V2.6.0
    • obdiag V2.5.0
    • obdiag V2.4.0
    • obdiag V2.3.0
    • obdiag V2.2.0
    • obdiag V2.1.0
    • obdiag V2.0.0
    • obdiag V1.6.2
    • obdiag V1.6.1
    • obdiag V1.6.0
    • obdiag V1.5.2
    • obdiag V1.5.1
    • obdiag V1.5.0
    • obdiag V1.4.0
    • obdiag V1.3.0

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase Diagnostic Tool
  3. V4.3.0

FAQ

Last Updated:2026-09-04 08:22:12

**Q1: What if the collected log files are too large? **

A: The default maximum file size returned by a single node is 5GB (controlled by the system configuration obdiag.basic.file_size_limit). If the total size of a single collection return exceeds this limit, the return will be limited and Error: File too large will be returned in the result. The query time range can be adjusted, such as configuring --inner_config obdiag.basic.file_size_limit=2G in the command or modifying file_size_limit in /opt/oceanbase-diagnostic-tool/conf/inner_config.yml.

Summary:
+------------------+----------------------+--------+------------+--------+------------+
| Node             | Status               | Size   | Password   | Time   | PackPath   |
+==================+======================+========+============+========+============+
| xxx.xxx.xxx.xxx  | Error:File too large | 0.000B |            | 21 s   |            |
+------------------+----------------------+--------+------------+--------+------------+
| xxx.xxx.xxx.xxx  | Error:File too large | 0.000B |            | 70 s   |            |
+------------------+----------------------+--------+------------+--------+------------+
```**Q2: What if the number of collected logs is too large? **

A: By default, the upper limit of the number of files returned by a single node at a time is 50 (controlled by the system configuration `obdiag.basic.file_number_limit`). When the number of files exceeds this limit, the excess will not be returned, and an `Error: Too many files xx > 50` message will appear in the result. You can reduce the query time range or increase the limit, such as modifying the `file_number_limit` parameter in the configuration file path, or adding the following internal parameters when executing the command:

```shell
--inner_config obdiag.basic.file_number_limit=100

The system configuration file path is /opt/oceanbase-diagnostic-tool/conf/inner_config.yml (the actual path shall prevail during source code installation).

**Q3: Error zip: command not found. **

A: Obdiag 3.2.0 (not included) used to use the zip tool of the target host for compression when collecting information and transmitting it back, so you need to install the zip tool on the host being collected.

**Q4: When executing source /usr/local/oceanbase-diagnostic-tool/init.sh, it is required to repeatedly confirm whether it needs to be overwritten. **

A: It may be because the cp command has been rewritten and the -i prefix has been added. It is recommended to check the ~/.bashrc file to see if the cp command has been rewritten, delete -i and then execute source ~/.bashrc to reset the cp command.

Description

This problem only exists in versions before obdiag V3.2.0 and has been solved since V3.2.0.

**Q5: Why is there no command auto-completion under Debian system? **

A: Some Debian systems will not automatically source /etc/profile.d/obdiag.sh. Users can manually add the source /etc/profile.d/obdiag.sh statement to ~/.bashrc.

Q6: What should I do if I don’t want to fill in the ssh username and ssh password when the obdiag config command is executed?

A: Just open the ssh password-free ssh between the remote node (usually the OBServer node) and the obdiag deployment node. Example: Machine A needs to use ssh to log in to machine B without a password.

# step1: On machine A, generate SSH key pair (press Enter for defaults)
# id_rsa.pub (public key)
ssh-keygen -t rsa
ls ~/.ssh

# step2: Copy machine A's public key to machine B
ssh-copy-id -i ~/.ssh/id_rsa.pub user@machine_b_ip
```**Q7: When there are parameters with special characters in the input, obdiag has a problem with parsing the parameters, and the command recognition is incorrect. **

A: You can use temporary environment variables to pass in parameters to avoid the problem of the shell parsing special characters (such as `!`). For example:

```shell
PASSWORD='xxxxx_!XSP'
obdiag gather scene run --scene=observer.perf_sql \
    --env host=xx.xx.xx.xx --env port=2881 --env user=xxx@xxx --env password=$PASSWORD --env database=xx \
    --env trace_id=YBxxxxx
```**Q8: How to view the detailed log of a certain obdiag execution? **

A: Trace ID will be output after each execution. Use `obdiag display-trace <trace_id>` to view detailed logs of this execution. The log file is located by default at `~/.obdiag/log/obdiag.log`.

Previous topic

Telemetry Mode
Last

Next topic

Configuration file encryption
Next