Python实现自动生成Oracle AWR报告

目前在规划、开发性能自动化执行框架，其中有个环节很有意思，就是如何通过框架自动获得场景执行期间的Oracle awr报告。虽然Oracle客户端提供的awrrpt.sql脚本可以提供交互方式生成awr报告，但并不能直接使用在自动化框架中，至少需要做一些改造，将交互的模式变成可以静默执行。

一 问题分析

经过对问题的分析，有两种基本的解决思路：

A.  在oracle服务器上部署shell脚本，使用shell命令启动oracle的sqlplus执行autoawr.sql,其中autoawr.sql主要用于获取必须入参值，然后调用oracle包的DBMS_WORKLOAD_REPOSITORY.awr_report_html实现awr报告的自动生成；

B.  直接在性能框架里通过本地的sqlplus调用oracle包的DBMS_WORKLOAD_REPOSITORY.awr_report_html实现awr报告的生成；

二 方案比较

两种思路的比较：

对于A，需要提前将改造的shell脚本和sql脚本部署到oracle服务器，该步骤是脱离框架的，且生成的报告是在oracle服务器上，需要框架提供方法将远程oracle上的awr获取到本地，用于后续分析和报告输出；

对于B，在框架实现了该功能，使用框架前无需额外部署，使框架更独立，使用更方便，且可以直接将报告生成在本地指定的位置；

本质上，两种思路是相同的，只是对于性能框架而言，该功能应该在哪端实现，是性能框架还是oracle服务器。

三 实现思路

通过对实现端的比较，决定将该功能在性能框架实现，简要描述一下实现思路。

实现分为三步：

第一：获取awr_report_html函数的4参数，即dbid,inst_num，l_bid，l_eid；

第二：拼接调用awr_report_html且使用spool将结果写入html的sql语句；

第三：调用sqlplus执行sql文件，生成awr；

四  awr_report_html函数

Awr_report_html函数如下：

函数使用方法一般为：

SELECT output FROM TABLE(DBMS_WORKLOAD_REPOSITORY.AWR_REPORT_HTML(dbid, inst_num,l_bid,l_eid,0));

需要注意的是：

1.  虽然通过调用AWR_REPORT_HTML可以select到html格式的text，在Python实现时我并没有将返回结果放到迭代器里，通过readlines的方法写入html文件，因output里包含了一些额外信息，生成的html并不能顺利打开，原因与sqlplus的参数配置有关，因为采用spool直接写入文件的方法；

2.  使用spool时，在sql脚本里设置以下sqlplus配置，避免输出中包含无关信息或格式问题，设置如下：

set heading off

set trimout on

set trimspool on

set linesize 2500

五 python 源码

根据上述思路，实现源码如下：