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
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 abovePress 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.
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.