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

Databases

OceanBase DatabaseOceanBase AI 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 ServiceOceanBase DataPilotOceanBase OAgent

Connectors and Middleware

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

Databases

OceanBase DatabaseOceanBase AI 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 ServiceOceanBase DataPilotOceanBase OAgent
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase OAgent

V2.2.0
  • Product overview
    • What is OAgent?
    • Key features
    • System architecture
    • Use cases
  • Quick start
  • Deployment
  • Overview
  • Sessions and diagnosis
    • Manage sessions
    • Switch dialogue models
    • Use @ to mention the analysis target
    • View the tool invocation process
    • Upload an attachment
    • Data visualization
    • FAQ
    • Export a report
  • Tools
  • Skill Management
  • Channel management
  • Knowledge base
    • Built-in knowledge base
    • Custom knowledge base
  • Scheduled tasks
    • Overview of scheduled tasks
    • Create a scheduled task
  • View usage
  • Model configuration
    • Manage model services
    • Model scoring
  • Settings and security
    • Product management
    • Experimental features
  • Best practices
    • Perform a cluster health inspection
    • Query cluster and topology information
    • Query resource metrics and task status
    • Read-only queries
    • Alert query and troubleshooting guide
    • Root cause analysis of exceptions
    • ASH diagnostic report
    • Analyze slow SQL, TopSQL, and abnormal SQL
    • SQL pre-analysis and tuning recommendations
    • Interpret execution plans
    • Diagnostic information statistics
    • Parameter check and change governance
    • Database change ticket
  • Appendix
    • Feature list
    • Built-in Skills
  • Release notes
    • OAgent V2.2.0 Release note
    • OAgent V2.1.0 Release note
    • OAgent V2.0.0 Release note
    • OAgent V1.8.0 Release note

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase OAgent
  3. V2.2.0

Perform a cluster health inspection

Last Updated:2026-11-20 07:25:11

When to use
Prerequisites
Procedure
What to do next

Cluster health inspections are used to periodically or temporarily assess the overall health of an OceanBase cluster, producing a structured inspection summary and risk alerts.

When to use

  • Conduct a comprehensive check-up on core clusters before or after shift handovers.

  • Verify cluster resources and alert status before critical events such as major business promotions.

  • When user feedback is received but the issue is unclear, perform a thorough inspection first to narrow down the troubleshooting scope.

Prerequisites

  • You have configured an OCP connection for the product to which the target cluster belongs. If diagnostic metrics such as slow SQL and top SQL need to be inspected, you must also configure an OAS connection.

  • The cluster_inspection skill is enabled.

Procedure

  1. On the Create Dialog page, enter @ and select the target product and cluster.

  2. Enter your inspection request, for example:

    Help me inspect this cluster.
    

    You can also click the shortcut entry Cluster Health Inspection and then specify the cluster and time range.

  3. Press Enter to send the request and wait for the Agent to complete the analysis.

    The Agent will sequentially query multi-dimensional data such as the cluster's basic information, resource usage (CPU/memory/disk), current active alerts, and an overview of slow queries and top SQL.

  4. View the inspection conclusion.

    The conclusion output by the Agent typically includes the following sections:

    • Problem Overview: The core issues identified in this inspection and their impact.

    • Root Cause Analysis: The possible root cause of the problem, along with supporting evidence such as waiting events, proportion, and involved background processes.

    • Key Evidence: Cited raw metric data, for example, sampling proportion of Top Background DB Time, tenant load characteristics, I/O bandwidth data, etc.

    • Solution: Troubleshooting and remediation steps prioritized by order.

What to do next

  • Expand Tool Output to view the key metrics referenced in the verification conclusion. For more information, see View the tool call process.

  • Configure inspection to run automatically daily or weekly. For more information, see Create a scheduled task.

  • If an inspection identifies slow SQL risks, you can drill down for analysis within the same session. For more information, see Slow SQL, TopSQL, and abnormal SQL analysis.

Previous topic

Experimental features
Last

Next topic

Query cluster and topology information
Next
on this page
When to use
Prerequisites
Procedure
What to do next