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

V3.0.0
  • Overview
  • Install obdiag
  • Configure obdiag
  • One-click Cluster Inspection
    • Use obdiag to inspect an OceanBase cluster
    • Inspection metrics
  • One-click Information Collection
    • One-click General Information Collection
      • obdiag gather log
      • obdiag gather sysstat
      • obdiag gather plan_monitor
      • obdiag gather stack
      • obdiag gather perf
      • obdiag gather ash
      • obdiag gather tabledump
      • obdiag gather parameter
      • obdiag gather variable
      • obdiag gather clog/obdiag gather slog
      • obdiag gather obproxy_log
      • obdiag gather all
    • One-click Scenario-based Information Collection
      • Overview
      • observer.base
      • observer.backup
      • observer.backup_clean
      • observer.clog_disk_full
      • observer.cluster_down
      • observer.compaction
      • observer.cpu_high
      • observer.delay_of_primary_and_backup
      • observer.io
      • observer.log_archive
      • observer.long_transaction
      • observer.memory
      • observer.perf_sql
      • observer.px_collect_log
      • observer.recovery
      • observer.restart
      • observer.rootservice_switch
      • observer.suspend_transaction
      • observer.unit_data_imbalance
      • observer.perf_sql
      • observer.topsql
      • other.application_error
      • obproxy.restart
      • observer.unknown
  • One-click Diagnostic Analysis
    • obdiag analyze log
    • obdiag analyze flt_trace
    • obdiag analyze parameter default
    • obdiag analyze parameter diff
    • obdiag analyze variable diff
    • obdiag analyze index_space
    • obdiag analyze memory
    • obdiag analyze queue
  • One-click Root Cause Analysis
    • Use obdiag for root cause analysis
    • disconnection
    • major_hold
    • lock_conflict
    • ddl_disk_full
    • clog_disk_full
    • log_error
    • ddl_failure
    • index_ddl_error
    • transaction_disconnection
    • transaction_execute_timeout
    • transaction_not_ending
    • transaction_other_error
    • transaction_rollback
    • transaction_wait_timeout
    • oms_full_trans
  • One-click Cluster Display
    • Overview
    • Basic information of a cluster
    • Information about nodes in a cluster
    • Information about units in a cluster
    • Information about zones in a cluster
    • RootService information of a cluster
    • Information about tenants in a cluster
    • Information about events in a cluster
    • Information about locks in a cluster
    • Information about top SQL statements in a cluster
    • Information about slow SQL statements in a cluster
    • Information about tables in a cluster
    • Information about the process list in a cluster
    • Information about the execution plan of an SQL statement
    • Disk usage of a database
    • Disk usage of the specified table in a database
  • Upgrade obdiag by using add-on files
  • Upgrade and uninstall obdiag
  • Telemetry Mode
  • FAQ
  • Release Notes
    • 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. V3.0.0

FAQ

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

Q1: What do I do if the files of collected logs are excessively large?

A: The size of log files is limited to 2 GB on a single node. If the size of log files exceeds the limit, no log file is returned and the error message Error:File too large is returned. In this case, you must adjust the query time range or change the value of the file_size_limit parameter in the config.yml file.

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 do I do if too many log files are to be collected?

A: The number of log files is limited to 20 on a single node. If the number of log files exceeds the limit, the collection task is not executed and the error message Error:Too many files xx > 20 is returned. In this case, you must adjust the query time range or change the value of the file_number_limit parameter in the config.yml file.

Q3: What do I do if the error message zip: command not found is returned?

A: Collected information is compressed by using a zip tool on the target host. Therefore, a zip tool must be installed on the target host whose information is to be collected.

Q4: What do I do if I was repeatedly asked to confirm whether to overwrite files during the execution of the source /usr/local/oceanbase-diagnostic-tool/init.sh command?

A: Check the ~/.bashrc file and delete the -i option in cp commands. Then, run the source ~/.bashrc command to reset the cp commands.

Q5: What do I do if commands are not automatically completed on a Debian-based system?

A: You can manually add the source /etc/profile.d/obdiag.sh command to the ~/.bashrc file.

Q6: What do I do if I do not want to enter the SSH username and password during the execution of the obdiag config command?

A: Enable password-free SSH connection between the remote node, which is generally an OBServer node, and the node where obdiag is deployed. For example, if server A needs to connect to server B without using a password, perform the following steps:

# Step 1: Generate a public key on server A. Typically, you can keep the default settings.
# id_rsa.pub (public key)
ssh-keygen -t rsa
ls ~/.ssh

# Step 2: Upload the public key of server A to server B.
ssh-copy-id -i ~/.ssh/id_rsa.pub User@IP address of server B

Previous topic

Telemetry Mode
Last

Next topic

obdiag V3.0.0
Next