spring boot应用p6spy监控sql

Spring boot中使用p6spy监控hibernate sql语句值

开发环境

• 开发工具：IDEA
• 开发环境：spring mvc、spring boot、spring data
• 数据库:mysql

具体步骤如下：

• pom.xml中添加p6spy包依赖：

        <dependency>            <groupId>p6spy</groupId>            <artifactId>p6spy</artifactId>            <version>3.0.0</version>        </dependency>

• application.yml配置中：

(1). url中必须增加p6spy,才能对SQL进行拦截：

jdbc:p6spy:mysql://192.0.6.116:3066/testdb

(2). driver-class需替换为：

com.p6spy.engine.spy.P6SpyDriver

具体如下：

spring:  datasource:    url: jdbc:p6spy:mysql://192.0.6.116:3066/testdb    #driver-class-name: com.mysql.jdbc.Driver    driver-class-name: com.p6spy.engine.spy.P6SpyDriver    username: root    password: xxxxxx

• 将spy.properties放到resources根目录下

spy.properties文件内容参考如下：

#### #%L# P6Spy# %%# Copyright (C) 2013 P6Spy# %%# Licensed under the Apache License, Version 2.0 (the "License");# you may not use this file except in compliance with the License.# You may obtain a copy of the License at# #      http://www.apache.org/licenses/LICENSE-2.0# # Unless required by applicable law or agreed to in writing, software# distributed under the License is distributed on an "AS IS" BASIS,# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.# See the License for the specific language governing permissions and# limitations under the License.# #L%##################################################################### P6Spy Options File                                            ## See documentation for detailed instructions                   ## http://p6spy.github.io/p6spy/2.0/configandusage.html          #################################################################################################################################### MODULES                                                       ##                                                               ## Module list adapts the modular functionality of P6Spy.        ## Only modules listed are active.                               ## (default is com.p6spy.engine.logging.P6LogFactory and         ## com.p6spy.engine.spy.P6SpyFactory)                            ## Please note that the core module (P6SpyFactory) can't be      # # deactivated.                                                  ## Unlike the other properties, activation of the changes on     ## this one requires reload.                                     ###################################################################modulelist=com.p6spy.engine.spy.P6SpyFactory,com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactorymodulelist=com.p6spy.engine.spy.P6SpyFactory,com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory################################################################# CORE (P6SPY) PROPERTIES                                      ################################################################## A comma separated list of JDBC drivers to load and register.# (default is empty)## Note: This is normally only needed when using P6Spy in an# application server environment with a JNDI data source or when# using a JDBC driver that does not implement the JDBC 4.0 API# (specifically automatic registration).#driverlist=#url="jdbc:p6spy:oracle:thin:@localhost:1521:orcl" 其中的p6spy必须要，因为这样才会被拦截#drive=com.p6spy.engine.spy.P6SpyDriver#driverlist=oracle.jdbc.driver.OracleDriverdriverlist=com.mysql.jdbc.Driver# for flushing per statement# (default is false)#autoflush = false# prints a stack trace for every statement logged#stacktrace=false# if stacktrace=true, specifies the stack trace to print#stacktraceclass=# determines if property file should be reloaded# Please note: reload means forgetting all the previously set# settings (even those set during runtime - via JMX)# and starting with the clean table # (default is false)#reloadproperties=false# determines how often should be reloaded in seconds# (default is 60)#reloadpropertiesinterval=60# specifies the appender to use for logging# Please note: reload means forgetting all the previously set# settings (even those set during runtime - via JMX)# and starting with the clean table # (only the properties read from the configuration file)# (default is com.p6spy.engine.spy.appender.FileLogger)#appender=com.p6spy.engine.spy.appender.Slf4JLogger#appender=com.p6spy.engine.spy.appender.StdoutLoggerappender=com.p6spy.engine.spy.appender.FileLogger# name of logfile to use, note Windows users should make sure to use forward slashes in their pathname (e:/test/spy.log) # (used for com.p6spy.engine.spy.appender.FileLogger only)# (default is spy.log)#logfile = spy.log#windows 用户请用 C:/spy.log 格式，不要用\logfile =d:/spy.log# append to the p6spy log file. if this is set to false the# log file is truncated every time. (file logger only)# (default is true)#追加到 p6spy 日志文件。如果设置为false#日志文件被截断每次。 （只限于文件记录器）#（默认为true）#append=true# class to use for formatting log messages (default is: com.p6spy.engine.spy.appender.SingleLineFormat)#多行输出为 com.p6spy.engine.spy.appender.MultiLineFormat#行的时间格式化配置在 dateformat 设定#current time|execution time|category|connection id|statement SQL String|effective SQL string#日志格式为 当前时间戳|执行语句花费的时间|调用的类别|connectionId|声明SQL字符串|有效的SQL字符串#logMessageFormat=com.p6spy.engine.spy.appender.SingleLineFormat# format that is used for logging of the date/time/... (has to be compatible with java.text.SimpleDateFormat)# (default is dd-MMM-yy)databaseDialectDateFormat=yyyy-MM-dd HH:mm:ss# sets the date format using Java's SimpleDateFormat routine. # In case property is not set, miliseconds since 1.1.1970 (unix time) is used (default is empty)#dateformat=dateformat=yyyy-MM-dd HH:mm:ss# whether to expose options via JMX or not# (default is true)#jmx=true# if exposing options via jmx (see option: jmx), what should be the prefix used?# jmx naming pattern constructed is: com.p6spy(.<jmxPrefix>)?:name=<optionsClassName># please note, if there is already such a name in use it would be unregistered first (the last registered wins)# (default is none)#jmxPrefix=################################################################## DataSource replacement                                        ##                                                               ## Replace the real DataSource class in your application server  ## configuration with the name com.p6spy.engine.spy.P6DataSource ## (that provides also connection pooling and xa support).       ## then add the JNDI name and class name of the real             ## DataSource here                                               ##                                                               ## Values set in this item cannot be reloaded using the          ## reloadproperties variable. Once it is loaded, it remains      ## in memory until the application is restarted.                 ##                                                               ###################################################################realdatasource=/RealMySqlDS#realdatasourceclass=com.mysql.jdbc.jdbc2.optional.MysqlDataSource################################################################## DataSource properties                                         ##                                                               ## If you are using the DataSource support to intercept calls    ## to a DataSource that requires properties for proper setup,    ## define those properties here. Use name value pairs, separate  ## the name and value with a semicolon, and separate the         ## pairs with commas.                                            ##                                                               ## The example shown here is for mysql                           ##                                                               ###################################################################realdatasourceproperties=port;3306,serverName;myhost,databaseName;jbossdb,foo;bar################################################################## JNDI DataSource lookup                                        ##                                                               ## If you are using the DataSource support outside of an app     ## server, you will probably need to define the JNDI Context     ## environment.                                                  ##                                                               ## If the P6Spy code will be executing inside an app server then ## do not use these properties, and the DataSource lookup will   ## use the naming context defined by the app server.             ##                                                               ## The two standard elements of the naming environment are       ## jndicontextfactory and jndicontextproviderurl. If you need    ## additional elements, use the jndicontextcustom property.      ## You can define multiple properties in jndicontextcustom,      ## in name value pairs. Separate the name and value with a       ## semicolon, and separate the pairs with commas.                ##                                                               ## The example shown here is for a standalone program running on ## a machine that is also running JBoss, so the JDNI context     ## is configured for JBoss (3.0.4).                              ##                                                               ## (by default all these are empty)                              ###################################################################jndicontextfactory=org.jnp.interfaces.NamingContextFactory#jndicontextproviderurl=localhost:1099#jndicontextcustom=java.naming.factory.url.pkgs;org.jboss.nameing:org.jnp.interfaces#jndicontextfactory=com.ibm.websphere.naming.WsnInitialContextFactory#jndicontextproviderurl=iiop://localhost:900################################################################# P6 LOGGING SPECIFIC PROPERTIES                               ################################################################## filter what is logged# please note this is a precondition for usage of: include/exclude/sqlexpression# (default is false)#filter=false# comma separated list of strings to include# please note that special characters escaping (used in java) has to be done for the provided regular expression# (default is empty)#include =# comma separated list of strings to exclude# (default is empty)#exclude =# sql expression to evaluate if using regex# please note that special characters escaping (used in java) has to be done for the provided regular expression# (default is empty)#sqlexpression = #list of categories to exclude: error, info, batch, debug, statement,#commit, rollback and result are valid values# (default is info,debug,result,resultset,batch)#excludecategories=info,debug,result,resultset,batch# Execution threshold applies to the standard logging of P6Spy.       # While the standard logging logs out every statement          # regardless of its execution time, this feature puts a time   # condition on that logging. Only statements that have taken   # longer than the time specified (in milliseconds) will be     # logged. This way it is possible to see only statements that  # have exceeded some high water mark.                          # This time is reloadable.                                     ## executionThreshold=integer time (milliseconds)# (default is 0)#executionThreshold=################################################################# P6 OUTAGE SPECIFIC PROPERTIES                                ################################################################## Outage Detection## This feature detects long-running statements that may be indicative of# a database outage problem. If this feature is turned on, it will log any# statement that surpasses the configurable time boundary during its execution.# When this feature is enabled, no other statements are logged except the long# running statements. The interval property is the boundary time set in seconds.# For example, if this is set to 2, then any statement requiring at least 2# seconds will be logged. Note that the same statement will continue to be logged# for as long as it executes. So if the interval is set to 2, and the query takes# 11 seconds, it will be logged 5 times (at the 2, 4, 6, 8, 10 second intervals).## outagedetection=true|false# outagedetectioninterval=integer time (seconds)## (default is false)#outagedetection=false# (default is 60)#outagedetectioninterval=30

其中spy.properties文件中的logMessageFormat可以使用自定义类，自定义输出格式：

logMessageFormat=com.aellelib.common.utils.P6LogFormat

P6LogFormat类代码如下：

package com.aellelib.common.utils;import com.p6spy.engine.common.P6Util;import com.p6spy.engine.spy.appender.SingleLineFormat;import org.hibernate.engine.jdbc.internal.BasicFormatterImpl;/** * Created by aelle on 2017/7/12. */public class P6LogFormat extends SingleLineFormat {    private static BasicFormatterImpl formatter = new BasicFormatterImpl();    private int i = 0;    @Override    public String formatMessage(int connectionId, String now, long elapsed, String category, String prepared, String sql) {        if (i == 0) {            i++;            return now + "|" + "" + elapsed + "|"  + "" + category + "|connection " + "" + connectionId + "|" + "\nAfter Prepared SQL:" +            formatter.format(P6Util.singleLine(prepared)) + "\nBefore Prepared SQL:" + formatter.format(P6Util.singleLine(sql));        } else {            i =  0;            return now + "|" + category + "|" + "Time Consumin:" + elapsed + "ms";        }    }}

注：本文参考了如下内容：

http://shoukaiseki.blog.163.com/blog/static/19285614920163129817280/

http://blog.csdn.net/qq_36224522/article/details/68059460