使用P6Spy監控你的Spring boot數據庫操作

引言

最近換了號稱最快的HikariDataSource，由於沒有了SQL監控，加之於Mybaits默認輸出日誌之拙計。遂用此物，與之相仿還有log4jdbc，比較活躍度後選擇了P6Spy。

版本

• P6Sspy: 3.7
• Gradle: 4.10
• Spring Boot: 2.0.4

步驟

具體步驟比較簡單，這裏說下簡單原理。P6Spy通過劫持JDBC驅動，在調用實際JDBC驅動前攔截調用的目標語，達到SQL語句日誌記錄的目的。

它包括P6Log和P6Outage兩個模塊。

• P6Log 用來攔截和記錄任務應用程序的 JDBC 語句
• P6Outage 專門用來檢測和記錄超過配置條件裏時間的 SQL 語句

應用P6Spy只需要

• 1.替換你的JDBC Driver爲com.p6spy.engine.spy.P6SpyDriver
• 2.修改JDBC Url爲jdbc:p6spy:xxxx
• 3.配置spy.properties

1.修改application.yml文件,替換jdbc driver和url

 

# 數據源
spring:
  datasource:
    type: com.zaxxer.hikari.HikariDataSource
    url: jdbc:p6spy:mysql://...
    username: ...
    password: ...
    driver-class-name: com.p6spy.engine.spy.P6SpyDriver

2.配置spy.properties

 

module.log=com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
# 自定義日誌打印
logMessageFormat=org.pkaq.core.log.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

3.自定義日誌打印 , 這裏有兩種方式

一、實現MessageFormattingStrategy接口

 

public class P6SpyLogger implements MessageFormattingStrategy {

    @Override
    public String formatMessage(int connectionId, String now, long elapsed, String category, String prepared, String sql) {
        return !"".equals(sql.trim()) ? "[ " + LocalDateTime.now() + " ] --- | took "
                + elapsed + "ms | " + category + " | connection " + connectionId + "\n "
                + sql + ";" : "";
    }
}

二、在 spy.properties中指定

 

# 自定義日誌打印
logMessageFormat=com.p6spy.engine.spy.appender.CustomLineFormat
customLogMessageFormat=%(currentTime) | SQL耗時： %(executionTime) ms | 連接信息： %(category)-%(connectionId) | 執行語句： %(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)

作者：PKAQ
鏈接：https://www.jianshu.com/p/5a32434d43eb
來源：簡書
著作權歸作者所有。商業轉載請聯繫作者獲得授權，非商業轉載請註明出處。