SQL Trace 
==============================

SQL Trace 能够交互式的提供上一次执行的 SQL 请求执行过程信息及各阶段的耗时。

SQL Trace 开关 
---------------------

SQL Trace 功能默认是关闭的，可通过 session 变量来控制其打开和关闭。

* 打开 SQL Trace 功能的语句如下：

  ```unknow
  obclient>SET ob_enable_trace_log = 1;
  ```

  




<!-- -->

* 关闭 SQL Trace 功能的语句如下：

  ```unknow
  obclient>SET ob_enable_trace_log = 0;
  ```

  

  




Show Trace 
-------------------

当 SQL Trace 功能打开后，执行需要诊断的 SQL，然后通过 `SHOW TRACE` 能够查看该 SQL 执行的信息。这些执行信息以表格方式输出，每列说明如下：


|  **列名**  |         **说明**         |
|----------|------------------------|
| Title    | 记录执行过程某一个阶段点           |
| KeyValue | 记录某一个阶段点产生的一些执行信息      |
| Time     | 记录上一个阶段点到这次阶段点执行耗时（us） |



示例 
-----------

1. 打开 SQL Trace：

   ```unknow
   obclient> SET ob_enable_trace_log = 1;
   ```

   




<!-- -->

2. 执行目标 SQL：

   ```unknow
   obclient> CREATE TABLE t1(c1 INT,c2 INT,c3 INT);
   Query OK, 0 rows affected (0.02 sec)
   
   obclient> INSERT INTO t1 VALUES(1,1,1);
   Query OK, 1 rows affected (0.02 sec)
   
   obclient> INSERT INTO t1 VALUES(2,2,2);
   Query OK, 1 rows affected (0.02 sec)
   
   obclient>SELECT * FROM t1 WHERE c1 = 1;
   
   +----+------+------+
   | c1 | c2   | c3   |
   +----+------+------+
   |  1 |    1 |    1 |
   +----+------+------+
   ```

   




<!-- -->

3. 显示 Trace：

   ```unknow
   obclient> SHOW TRACE;
   +------------------------------+---------------------------------------------------------------------------------------------------+
   
   | TITLE                        | KEYVALUE                                                                   | TIME |
   +------------------------------+----------------------------------------------------------------------------+------+
   | process begin                | in_queue_time:17, receive_ts:1612420489580707, enqueue_ts:1612420489580709 | 0    |
   | query begin                  | trace_id:YB42AC1E87E6-0005B8AB2D57844F                                     | 1    |
   | parse begin                  | stmt:"set ob_enable_trace_log = 1", stmt_len:27                            | 62   |
   | pc get plan begin            | NULL                                                                       | 9    |
   | pc get plan end              | NULL                                                                       | 19   |
   | transform_with_outline begin | NULL                                                                       | 1    |
   | transform_with_outline end   | NULL                                                                       | 31   |
   | resolve begin                | NULL                                                                       | 21   |
   | resolve end                  | NULL                                                                       | 33   |
   | execution begin              | arg1:false, end_trans_cb:false                                             | 14   |
   | start_auto_end_plan begin    | NULL                                                                       | 39   |
   | start_auto_end_plan end      | NULL                                                                       | 1    |
   | execution end                | NULL                                                                       | 11   |
   | query end                    | NULL                                                                       | 39   |                                                                                                                                                      
   +------------------------------+---------------------------------------------------------------------------------------------+------+
   ```

   

   示例中 `SHOW TRACE` 结果说明如下：
   * Title 列包含整个 SQL 执行经历的各个阶段的信息以及该 SQL 真实的执行路径。上述示例的结果中有经过 Resolve、Transform、Optimizer 和 Code Generate 四个流程，说明该 SQL 重新生成了计划，没有命中 plan cache。

     
   

   
   <!-- -->

   * KeyValue 列包含一些执行信息，可以用于排查问题：

     
   

   
   <!-- -->

   
   <!-- -->

   * Time 列显示上一个阶段点到这次阶段点执行耗时。

     例如，resolve end 对应的 206 us 表示的是 resolve begin 到 resolve 耗时。如果某个 SQL 执行很慢，则通过查看 time 列，能够快速定位出具体是哪个阶段执行较慢，然后再进行具体分析。此例中，执行耗时主要在生成计划过程中，因此只需要分析没有命中 plan cache 的原因，可能是计划淘汰后 第一次执行该 SQL，或是 plan cache 不支持的 SQL。
     
   

   



