文章目录
-
- 简介
- 1、Maven依赖
- 2、 切换driverClass(必须)
- 3、增加配置文件
- 4、自定义配置类
简介
p6spy是一个开源项目,通常使用它来跟踪数据库操作,查看程序运行过程中执行的sql语句。展示效果如下:
代码语言:javascript复制SQL耗时【7毫秒】 连接信息【jdbc:p6spy:mysql://192.168.1.108:3306/leimingtech_member?allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8&useSSL=false】 最终执行SQL【SELECT id, member_name, nick_name, member_mobile, member_email FROM lmshop_member WHERE del_flag = 0 AND (id = 12345)】
1、Maven依赖
代码语言:javascript复制 <dependency>
<groupId>p6spy</groupId>
<artifactId>p6spy</artifactId>
<version>3.8.2</version>
</dependency>
由于SQL日志只在开发环境打印,生产环境禁止打印SQL语句,因此需要配置在节点下面,如下图所示:(prod环境不需要配置)
2、 切换driverClass(必须)
代码语言:javascript复制spring.datasource.druid.driver-class-name = com.p6spy.engine.spy.P6SpyDriver
spring.datasource.druid.url = jdbc:p6spy:mysql://****:3306/***?allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8&useSSL=false
P6SpyDriver底层是实现与com.mysql.jdbc.Driver类似都是实现java.sql.Driver接口 源码如下图所示:
3、增加配置文件
在resources下面创建spy.properties配置文件,如下图所示:
内容为:
代码语言:javascript复制module.log=com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
# 自定义日志打印
# class to use for formatting log messages (default is: com.p6spy.engine.spy.appender.SingleLineFormat)
#logMessageFormat=com.p6spy.engine.spy.appender.MultiLineFormat
logMessageFormat=com.leimingtech.commons.mybatis.logs.P6spyLogFormatStrategy
# 自带的日志格式 (default is com.p6spy.engine.spy.appender.FileLogger)
#appender=com.p6spy.engine.spy.appender.Slf4JLogger
#appender=com.p6spy.engine.spy.appender.StdoutLogger
#appender=com.p6spy.engine.spy.appender.FileLogger
#appender=com.p6spy.engine.spy.appender.Slf4JLogger
# 使用日志系统记录sql
appender=com.leimingtech.commons.mybatis.logs.P6SpyLogger
## 配置记录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
【注】 如果以上配置无法满足你的需求,可以查看一下详细的spy.properties说明,可以根据自己的需求配置。
代码语言:javascript复制# 指定应用的日志拦截模块,默认为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)
4、自定义配置类
如果需要自定义输出日志格式,以及输出的内容,可以自定义配置日志输出内容类,直接继承与MessageFormattingStrategy即可,可以参考如下类:
P6spyLogFormatStrategy.java 自定义日志输出内容
代码语言:javascript复制/** * p6spySQL日志格式打印 * * @author lixiang * @version V1.0 * @date 2020/1/16 9:50 **/
public class P6spyLogFormatStrategy implements MessageFormattingStrategy {
/** * 日志格式化方式(打印SQL日志会进入此方法,耗时操作,生产环境不建议使用) * * @param connectionId: 连接ID * @param now: 当前时间 * @param elapsed: 花费时间 * @param category: 类别 * @param prepared: 预编译SQL * @param sql: 最终执行的SQL * @param url: 数据库连接地址 * @return 格式化日志结果 * @date 2020/1/16 9:52 * @author lixiangx@leimingtech.com **/
@Override
public String formatMessage(int connectionId, String now, long elapsed,
String category, String prepared, String sql,
String url) {
return "SQL耗时【" elapsed "毫秒】 连接信息【" url "】 最终执行SQL【" sql "】";
}
}
P6SpyLogger.java 控制日志输出级别
代码语言:javascript复制/** * 自定义SQL格式 * * @author lixiang * @version V1.0 * @date 2020/1/16 10:11 **/
@Slf4j
public class P6SpyLogger extends FormattedLogger {
@Override
public void logException(Exception e) {
log.info("", e);
}
@Override
public void logText(String text) {
log.info(text);
}
/** * 根据类别打印不同等级的日志 * * @param connectionId: 连接ID * @param now: 当前时间 * @param elapsed: 花费时间 * @param category: 类别 * @param prepared: 预编译SQL * @param sql: 最终执行的SQL * @param url: 数据库连接地址 * @date 2020/1/16 9:52 * @author lixiangx@leimingtech.com **/
@Override
public void logSQL(int connectionId, String now, long elapsed, Category category, String prepared, String sql, String url) {
final String msg = strategy.formatMessage(connectionId, now, elapsed,
category.toString(), prepared, sql, url);
if (StringUtils.isEmpty(msg)) {
return;
}
if (Category.ERROR.equals(category)) {
log.error(msg);
} else if (Category.WARN.equals(category)) {
log.warn(msg);
} else if (Category.DEBUG.equals(category)) {
log.debug(msg);
} else {
log.info(msg);
}
}
/** * 根据类别开启指定的日志级别 * * @param category 日志类别 * @return 是否开启 * @date 2020/1/16 10:42 * @author lixiangx@leimingtech.com **/
@Override
public boolean isCategoryEnabled(Category category) {
if (Category.ERROR.equals(category)) {
return log.isErrorEnabled();
} else if (Category.WARN.equals(category)) {
return log.isWarnEnabled();
} else if (Category.DEBUG.equals(category)) {
return log.isDebugEnabled();
} else {
return log.isInfoEnabled();
}
}
}
到此配置完成,启动项目,即可在控制台上查看你配置的日志格式。
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。
发布者:全栈程序员栈长,转载请注明出处:https://javaforall.cn/185356.html原文链接:https://javaforall.cn