OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
Start on Cloud

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS
OceanBase CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase Database
BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Diagnostic Tool

V2.4.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
      • 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
  • 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
  • Upgrade obdiag by using add-on files
  • Upgrade and uninstall obdiag
  • Telemetry Mode
  • FAQ
  • Release Notes
    • 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

Overview Install obdiag Configure obdiag Use obdiag to inspect an OceanBase cluster Inspection metrics 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 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 other.application_error obproxy.restart observer.unknown obdiag analyze log obdiag analyze flt_trace obdiag analyze parameter default obdiag analyze parameter diff obdiag analyze variable diff obdiag analyze index_space 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 Upgrade obdiag by using add-on files Upgrade and uninstall obdiag Telemetry Mode FAQ 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
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & Certification
Company
About OceanBaseTrust CenterLegalPartnerContact Us
Follow Us

© OceanBase 2026. All rights reserved

Cloud Service AgreementPrivacy PolicySecurity
Contact Us
Document Feedback
  1. Documentation Center
  2. OceanBase Diagnostic Tool
  3. V2.4.0
iconOceanBase Diagnostic Tool
V 2.4.0
  • V 3.3.0
  • V 3.2.0
  • V 3.1.0
  • V 3.0.0
  • V 2.6.0
  • V 2.5.0
  • V 2.4.0
  • V 2.3.0
  • V 1.5.0
  • V 1.4.0

FAQ

Last Updated:2026-04-13 09:12:25  Updated
share
What is on this page
share

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 V2.4.0
Next