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

Export a report

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

When to use
Prerequisites
Procedure
Report content structure
What to do next

OAgent can export inspection results, alert query and handling guidelines, root cause analysis (RCA) findings, SQL diagnostics, and ASH diagnostic conclusions to an HTML report. By default, the HTML format is generated; you can also export it as a PDF in a browser. Generating a PDF directly is an environment-dependent capability. By default, the server only generates HTML for easier archiving, traceability, and team sharing.

When to use

  • After completing an inspection or an alert RCA during your shift, you need to deliver the results to the business team or superiors.
  • Before and after a major promotion, inventory the core clusters and generate a periodic health report.
  • Reports generated by scheduled tasks require long-term archiving or periodic review.

Prerequisites

  • A complete analysis conclusion (such as inspection, RCA, SQL diagnostics, or ASH diagnostics) has been generated in the current session.

Note

Only completed analyses can be exported. If no conclusion has been produced in the dialog, complete the corresponding analysis before initiating the export.

Procedure

  1. In the session where an analysis conclusion has been generated, enter your export request, for example:

    Export the inspection conclusion as HTML
    Generate a report for this RCA
    Export the SQL diagnostic conclusion above
    
  2. Press Enter to send it, and wait for the Agent to generate the report.

    • The Agent will assemble the report content based on the tool invocation results and analysis conclusions obtained, including an overview of the issue, key evidence, analysis conclusions, and remediation suggestions.
  3. Obtain the report from the returned result.

    • The report provides a download link in HTML file format.
    • If generated by a scheduled task, the report is archived in the execution history of the corresponding task. For details, see Overview of scheduled tasks.

Report content structure

Source Scenario
Main Sections of the Report
Cluster Health Check Cluster Overview, Resource Usage, Alert Overview, Slow/Top SQL Overview, Risk Alerts
Alerts and Root Cause Analysis Alert list, exception timeline, root cause ranking, and remediation suggestions
SQL diagnostics SQL details, execution plans, tuning suggestions (hints, indexes, and rewrite), and validation plan
ASH diagnostics Sampling Overview, Top Waiting Events, Top SQL, Session Distribution

What to do next

  • To view the data in the report in chart form, see Data visualization.

  • To automatically generate reports periodically, see Create a scheduled task.

Previous topic

FAQ
Last

Next topic

Tools
Next
on this page
When to use
Prerequisites
Procedure
Report content structure
What to do next