P6Spy簡介
P6Spy是一個可以用來在應用程序中攔截和修改數據操作語句的開源框架。通過P6Spy我們可以對SQL語句進行攔截,相當於一個SQL語句的記錄器,這樣我們可以用它來作相關的分析,比如性能分析。
P6SPY提供了如下幾個功能:
\1. 記錄SQL語句的執行時間戳。
\2. 記錄SQL語句類型。
\3. 記錄SQL填入參數的和沒有填入參數的SQL語句。
\4. 根據配置的時間控制SQL語句的執行時間,對超出時間的SQL語句輸出到日志文件中。
配置步驟:
<dependency>
<groupId>p6spy</groupId>
<artifactId>p6spy</artifactId>
<version>3.9.1</version>
</dependency>
01.將你的JDBC驅動替換為
# 修改 JDBC 驅動為如下 P6SpyDriver 配置
# 之前為:
# spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.driver-class-name=com.p6spy.engine.spy.P6SpyDriver
02.修改spring.datasource.url
# 注意是 jdbc:p6spy:mysql
spring.datasource.url=jdbc:p6spy:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=UTF-8
03.添加配置文件 spy.properties
module.log=com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
# 自定義日志打印,改成你自定義配置類的全類名
logMessageFormat=com.kangqing.platform.aop.P6SpyLogger
# 使用日志系統記錄sql
appender=com.p6spy.engine.spy.appender.Slf4JLogger
## 配置記錄Log例外
excludecategories=info,debug,result,batc,resultset
# 設置使用p6spy driver來做代理
deregisterdrivers=true
# 日期格式
dateformat=yyyy-MM-dd HH:mm:ss
# 實際驅動
driverlist=com.mysql.jdbc.Driver
# 是否開啟慢SQL記錄
#outagedetection=true
# 慢SQL記錄標准 秒
#outagedetectioninterval=2
04.自定義日志打印
(我喜歡這個功能)可以把 mybatis 占位符填進去,輸入完整的sql日志
/**
* 自定義日志
* 默認com.p6spy.engine.spy.appender.SingleLineFormat
* @author kangqing
* @date 2020/9/7 10:58
*/
public class P6SpyLogger implements MessageFormattingStrategy {
/**
* 日志格式
* @param connectionId 連接id
* @param now 當前時間
* @param elapsed 耗時多久
* @param category 類別
* @param prepared mybatis帶占位符的sql
* @param sql 占位符換成參數的sql
* @param url sql連接的 url
* @return 自定義格式日志
*/
@Override
public String formatMessage(int connectionId, String now, long elapsed, String category, String prepared, String sql, String url) {
return !"".equals(sql.trim()) ? "P6SpyLogger " + LocalDateTime.now() + " | elapsed " + elapsed + "ms | category " + category + " | connection " + connectionId + " | url " + url + " | sql \n" + sql : "";
}
}
附
spy.properties詳細說明
# 指定應用的日志攔截模塊,默認為com.p6spy.engine.spy.P6SpyFactory
modulelist=com.p6spy.engine.spy.P6SpyFactory,com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
# 真實JDBC driver , 多個以 逗號 分割 默認為空
driverlist=
# 是否自動刷新 默認 flase
autoflush=false
# 配置SimpleDateFormat日期格式 默認為空
dateformat=
# 打印堆棧跟蹤信息 默認flase
stacktrace=false
# 如果 stacktrace=true,則可以指定具體的類名來進行過濾。
stacktraceclass=
# 監測屬性配置文件是否進行重新加載
reloadproperties=false
# 屬性配置文件重新加載的時間間隔,單位:秒 默認60s
reloadpropertiesinterval=60
# 指定 Log 的 appender,取值:
appender=com.p6spy.engine.spy.appender.Slf4JLogger
appender=com.p6spy.engine.spy.appender.StdoutLogger
appender=com.p6spy.engine.spy.appender.FileLogger
# 指定 Log 的文件名 默認 spy.log
logfile=spy.log
# 指定是否每次是增加 Log,設置為 false 則每次都會先進行清空 默認true
append=true
# 指定日志輸出樣式 默認為com.p6spy.engine.spy.appender.SingleLineFormat , 單行輸出 不格式化語句
logMessageFormat=com.p6spy.engine.spy.appender.SingleLineFormat
# 也可以采用 com.p6spy.engine.spy.appender.CustomLineFormat 來自定義輸出樣式, 默認值是%(currentTime)|%(executionTime)|%(category)|connection%(connectionId)|%(sqlSingleLine)
# 可用的變量為:
# %(connectionId) connection id
# %(currentTime) 當前時間
# %(executionTime) 執行耗時
# %(category) 執行分組
# %(effectiveSql) 提交的SQL 換行
# %(effectiveSqlSingleLine) 提交的SQL 不換行顯示
# %(sql) 執行的真實SQL語句,已替換占位
# %(sqlSingleLine) 執行的真實SQL語句,已替換占位 不換行顯示
customLogMessageFormat=%(currentTime)|%(executionTime)|%(category)|connection%(connectionId)|%(sqlSingleLine)
# date類型字段記錄日志時使用的日期格式 默認dd-MMM-yy
databaseDialectDateFormat=dd-MMM-yy
# boolean類型字段記錄日志時使用的日期格式 默認boolean 可選值numeric
databaseDialectBooleanFormat=boolean
# 是否通過jmx暴露屬性 默認true
jmx=true
# 如果jmx設置為true 指定通過jmx暴露屬性時的前綴 默認為空
# com.p6spy(.<jmxPrefix>)?:name=<optionsClassName>
jmxPrefix=
# 是否顯示納秒 默認false
useNanoTime=false
# 實際數據源 JNDI
realdatasource=/RealMySqlDS
# 實際數據源 datasource class
realdatasourceclass=com.mysql.jdbc.jdbc2.optional.MysqlDataSource
# 實際數據源所攜帶的配置參數 以 k=v 方式指定 以 分號 分割
realdatasourceproperties=port;3306,serverName;myhost,databaseName;jbossdb,foo;bar
# jndi數據源配置
# 設置 JNDI 數據源的 NamingContextFactory。
jndicontextfactory=org.jnp.interfaces.NamingContextFactory
# 設置 JNDI 數據源的提供者的 URL。
jndicontextproviderurl=localhost:1099
# 設置 JNDI 數據源的一些定制信息,以分號分隔。
jndicontextcustom=java.naming.factory.url.pkgs;org.jboss.naming:org.jnp.interfaces
# 是否開啟日志過濾 默認false, 這項配置是否生效前提是配置了 include/exclude/sqlexpression
filter=false
# 過濾 Log 時所包含的表名列表,以逗號分隔 默認為空
include=
# 過濾 Log 時所排除的表名列表,以逗號分隔 默認為空
exclude=
# 過濾 Log 時的 SQL 正則表達式名稱 默認為空
sqlexpression=
#顯示指定過濾 Log 時排隊的分類列表,取值: error, info, batch, debug, statement,
#commit, rollback, result and resultset are valid values
# (默認 info,debug,result,resultset,batch)
excludecategories=info,debug,result,resultset,batch
# 是否過濾二進制字段
# (default is false)
excludebinary=false
# P6Log 模塊執行時間設置,整數值 (以毫秒為單位),只有當超過這個時間才進行記錄 Log。默認為0
executionThreshold=
# P6Outage 模塊是否記錄較長時間運行的語句 默認false
outagedetection=true|false
# P6Outage 模塊執行時間設置,整數值 (以秒為單位)),只有當超過這個時間才進行記錄 Log。默認30s
outagedetectioninterval=integer time (seconds)
參考:
https://my.oschina.net/hutaishi/blog/3020251
往期推薦