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 Cloud

OceanBase Database

Tools Connectors and Middleware

QUICK START

OceanBase Cloud OceanBase 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

OceanBase Diagnostic Tool

V3.3.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
- oms_obcdc
- suspend_transaction
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 tenant
- Information about the execution plan of an SQL statement
- Disk usage of a database
- Disk usage of the specified table in a database
- Information about all tenants in a cluster
- Information about CPU utilization of nodes in a cluster
- Internal table names fuzzy matched with the specified keyword
- Information about leaders in a cluster
- Information about locks on a table
- Information about long-running transactions in a cluster
- Information about operators in the actually executed plan
- Information about the memory of all tenants
- Information about statistics on real-time sessions of the process list
- Information about the storage method of tables and indexes
- Information about column NDVs of a table
- Information about table indexes
Upgrade obdiag by using add-on files
Upgrade and uninstall obdiag
Telemetry Mode
FAQ
Release Notes
- 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

Upgrade obdiag by using add-on files

Last Updated：2026-04-13 09:12:30 Updated

OceanBase Diagnostic Tool (obdiag) must support online upgrades to reduce the dependency on the release of new versions and implement quick updates and real-time iterations. The design of obdiag allows the decoupling of the execution of some features from the execution logic. This makes online upgrades feasible.

Syntax of `update` commands

obdiag update
obdiag update --file=<file_name>

file_name specifies the path of add-on files used to manually upgrade obdiag. If you do not specify this parameter, the online upgrade process is used.

If you use the --file parameter to specify the path, you need to ensure the correctness of the files.

Upgrade process

Move the original add-on file folder, such as ~/.obdiag/check, to {original folder name}.d, such as ~/.obdiag/check.d.
Decompress the latest add-on files to ~/.obdiag/.

Notice

Earlier inspection-related files are stored in ~/.obdiag/, such as ~/.obdiag/tasks. You need to determine whether to delete these files.

Previous topic

Information about table indexes

Last

Next topic

Upgrade and uninstall obdiag