SpringBoot 监控 SQL 运行情况?
优采云 发布时间: 2022-05-02 20:21SpringBoot 监控 SQL 运行情况?
虽然 HikariCP 的速度稍快,但是,Druid能够提供强大的监控和扩展功能,也是阿里巴巴的开源项目。
Druid是阿里巴巴开发的号称为监控而生的数据库连接池,在功能、性能、扩展性方面,都超过其他数据库连接池,包括DBCP、C3P0、BoneCP、Proxool、JBoss DataSource等等等,秒杀一切。
Druid 可以很好的监控 DB 池连接和 SQL 的执行情况,天生就是针对监控而生的 DB 连接池。
Spring Boot 默认数据源 HikariDataSource 与 JdbcTemplate中已经介绍 Spring Boot 2.x 默认使用 Hikari 数据源,可以说 Hikari 与 Driud 都是当前 Java Web 上最优秀的数据源。
而Druid已经在阿里巴巴部署了超过600个应用,经过好几年生产环境*敏*感*词*部署的严苛考验!
2 添加依赖
推荐一个 Spring Boot 基础教程及实战示例:
pom.xml
<p style="border-radius: 4px;font-size: 0.85em;margin: 0px 8px;background: rgb(248, 248, 248);color: rgb(51, 51, 51);display: block;padding: 5.20625px;overflow-x: auto;white-space: nowrap;"><br mpa-from-tpl="t" /><br mpa-from-tpl="t" /> com.alibaba<br mpa-from-tpl="t" /> druid-spring-boot-starter<br mpa-from-tpl="t" /> 1.1.23<br mpa-from-tpl="t" /><br mpa-from-tpl="t" /><br mpa-from-tpl="t" /><br mpa-from-tpl="t" /> mysql<br mpa-from-tpl="t" /> mysql-connector-java<br mpa-from-tpl="t" /> runtime<br mpa-from-tpl="t" /><br mpa-from-tpl="t" /><br mpa-from-tpl="t" /><br mpa-from-tpl="t" /> org.springframework.boot<br mpa-from-tpl="t" /> spring-boot-starter-log4j2<br mpa-from-tpl="t" /><br mpa-from-tpl="t" /><br mpa-from-tpl="t" /><br mpa-from-tpl="t" /><br mpa-from-tpl="t" /> org.mybatis.spring.boot<br mpa-from-tpl="t" /> mybatis-spring-boot-starter<br mpa-from-tpl="t" /> 2.1.3<br mpa-from-tpl="t" /> <br mpa-from-tpl="t" /> <br mpa-from-tpl="t" /> <br mpa-from-tpl="t" /> com.zaxxer<br mpa-from-tpl="t" /> HikariCP<br mpa-from-tpl="t" /> <br mpa-from-tpl="t" /> <br mpa-from-tpl="t" /></p>
3. 配置相关属性
配置Druid数据源(连接池):如同以前 c3p0、dbcp 数据源可以设置数据源连接初始化大小、最大连接数、等待时间、最小连接数 等一样,Druid 数据源同理可以进行设置;
配置 Druid web 监控 filter(WebStatFilter):这个过滤器的作用就是统计 web 应用请求中所有的数据库信息,比如 发出的 sql 语句,sql 执行的时间、请求次数、请求的 url 地址、以及seesion 监控、数据库表的访问次数 等等。
配置 Druid 后台管理 Servlet(StatViewServlet):Druid 数据源具有监控的功能,并提供了一个 web 界面方便用户查看,类似安装 路由器 时,人家也提供了一个默认的 web 页面;需要设置 Druid 的后台管理页面的属性,比如 登录账号、密码 等;
注意:
Druid Spring Boot Starter 配置属性的名称完全遵照 Druid,可以通过 Spring Boot 配置文件来配置Druid数据库连接池和监控,如果没有配置则使用默认值。
application.yml
<p style="border-radius: 4px;font-size: 0.85em;margin: 0px 8px;background: rgb(248, 248, 248);color: rgb(51, 51, 51);display: block;padding: 5.20625px;overflow-x: auto;white-space: nowrap;">########## 配置数据源 (Druid)##########<br mpa-from-tpl="t" />spring:<br mpa-from-tpl="t" /> datasource:<br mpa-from-tpl="t" /> ########## JDBC 基本配置 ##########<br mpa-from-tpl="t" /> username: xxx<br mpa-from-tpl="t" /> password: xxx<br mpa-from-tpl="t" /> driver-class-name: com.mysql.cj.jdbc.Driver # mysql8 的连接驱动<br mpa-from-tpl="t" /> url: jdbc:mysql://127.0.0.1:3306/test?serverTimezone=Asia/Shanghai<br mpa-from-tpl="t" /> platform: mysql # 数据库类型<br mpa-from-tpl="t" /> type: com.alibaba.druid.pool.DruidDataSource # 指定数据源类型<br mpa-from-tpl="t" /> ########## 连接池 配置 ##########<br mpa-from-tpl="t" /> druid:<br mpa-from-tpl="t" /> # 配置初始化大小、最小、最大<br mpa-from-tpl="t" /> initial-size: 5<br mpa-from-tpl="t" /> minIdle: 10<br mpa-from-tpl="t" /> max-active: 20<br mpa-from-tpl="t" /> # 配置获取连接等待超时的时间(单位:毫秒)<br mpa-from-tpl="t" /> max-wait: 60000<br mpa-from-tpl="t" /> # 配置间隔多久才进行一次检测,检测需要关闭的空闲连接,单位是毫秒<br mpa-from-tpl="t" /> time-between-eviction-runs-millis: 2000<br mpa-from-tpl="t" /> # 配置一个连接在池中最小生存的时间,单位是毫秒<br mpa-from-tpl="t" /> min-evictable-idle-time-millis: 600000<br mpa-from-tpl="t" /> max-evictable-idle-time-millis: 900000<br mpa-from-tpl="t" /> # 用来测试连接是否可用的SQL语句,默认值每种数据库都不相同,这是mysql<br mpa-from-tpl="t" /> validationQuery: select 1<br mpa-from-tpl="t" /> # 应用向连接池申请连接,并且testOnBorrow为false时,连接池将会判断连接是否处于空闲状态,如果是,则验证这条连接是否可用<br mpa-from-tpl="t" /> testWhileIdle: true<br mpa-from-tpl="t" /> # 如果为true,默认是false,应用向连接池申请连接时,连接池会判断这条连接是否是可用的<br mpa-from-tpl="t" /> testOnBorrow: false<br mpa-from-tpl="t" /> # 如果为true(默认false),当应用使用完连接,连接池回收连接的时候会判断该连接是否还可用<br mpa-from-tpl="t" /> testOnReturn: false<br mpa-from-tpl="t" /> # 是否缓存preparedStatement,也就是PSCache。PSCache对支持游标的数据库性能提升巨大,比如说oracle<br mpa-from-tpl="t" /> poolPreparedStatements: true<br mpa-from-tpl="t" /> # 要启用PSCache,必须配置大于0,当大于0时, poolPreparedStatements自动触发修改为true,<br mpa-from-tpl="t" /> # 在Druid中,不会存在Oracle下PSCache占用内存过多的问题,<br mpa-from-tpl="t" /> # 可以把这个数值配置大一些,比如说100<br mpa-from-tpl="t" /> maxOpenPreparedStatements: 20<br mpa-from-tpl="t" /> # 连接池中的minIdle数量以内的连接,空闲时间超过minEvictableIdleTimeMillis,则会执行keepAlive操作<br mpa-from-tpl="t" /> keepAlive: true<br mpa-from-tpl="t" /> # Spring 监控,利用aop 对指定接口的执行时间,jdbc数进行记录<br mpa-from-tpl="t" /> aop-patterns: "com.springboot.template.dao.*"<br mpa-from-tpl="t" /> ########### 启用内置过滤器(第一个 stat必须,否则监控不到SQL)##########<br mpa-from-tpl="t" /> filters: stat,wall,log4j2<br mpa-from-tpl="t" /> # 自己配置监控统计拦截的filter<br mpa-from-tpl="t" /> filter:<br mpa-from-tpl="t" /> # 开启druiddatasource的状态监控<br mpa-from-tpl="t" /> stat:<br mpa-from-tpl="t" /> enabled: true<br mpa-from-tpl="t" /> db-type: mysql<br mpa-from-tpl="t" /> # 开启慢sql监控,超过2s 就认为是慢sql,记录到日志中<br mpa-from-tpl="t" /> log-slow-sql: true<br mpa-from-tpl="t" /> slow-sql-millis: 2000<br mpa-from-tpl="t" /> # 日志监控,使用slf4j 进行日志输出<br mpa-from-tpl="t" /> slf4j:<br mpa-from-tpl="t" /> enabled: true<br mpa-from-tpl="t" /> statement-log-error-enabled: true<br mpa-from-tpl="t" /> statement-create-after-log-enabled: false<br mpa-from-tpl="t" /> statement-close-after-log-enabled: false<br mpa-from-tpl="t" /> result-set-open-after-log-enabled: false<br mpa-from-tpl="t" /> result-set-close-after-log-enabled: false<br mpa-from-tpl="t" /> ########## 配置WebStatFilter,用于采集web关联监控的数据 ##########<br mpa-from-tpl="t" /> web-stat-filter:<br mpa-from-tpl="t" /> enabled: true # 启动 StatFilter<br mpa-from-tpl="t" /> url-pattern: /* # 过滤所有url<br mpa-from-tpl="t" /> exclusions: "*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*" # 排除一些不必要的url<br mpa-from-tpl="t" /> session-stat-enable: true # 开启session统计功能<br mpa-from-tpl="t" /> session-stat-max-count: 1000 # session的最大个数,默认100<br mpa-from-tpl="t" /> ########## 配置StatViewServlet(监控页面),用于展示Druid的统计信息 ##########<br mpa-from-tpl="t" /> stat-view-servlet:<br mpa-from-tpl="t" /> enabled: true # 启用StatViewServlet<br mpa-from-tpl="t" /> url-pattern: /druid/* # 访问内置监控页面的路径,内置监控页面的首页是/druid/index.html<br mpa-from-tpl="t" /> reset-enable: false # 不允许清空统计数据,重新计算<br mpa-from-tpl="t" /> login-username: root # 配置监控页面访问密码<br mpa-from-tpl="t" /> login-password: 123<br mpa-from-tpl="t" /> allow: 127.0.0.1 # 允许访问的地址,如果allow没有配置或者为空,则允许所有访问<br mpa-from-tpl="t" /> deny: # 拒绝访问的地址,deny优先于allow,如果在deny列表中,就算在allow列表中,也会被拒绝</p>
上述配置文件的参数可以在com.alibaba.druid.spring.boot.autoconfigure.properties.DruidStatProperties和org.springframework.boot.autoconfigure.jdbc.DataSourceProperties中找到;
3.1 如何配置 Filter
可以通过spring.datasource.druid.filters=stat,wall,log4j ...的方式来启用相应的内置Filter,不过这些Filter都是默认配置。如果默认配置不能满足需求,
<p style="border-radius: 4px;font-size: 0.85em;margin: 0px 8px;background: rgb(248, 248, 248);color: rgb(51, 51, 51);display: block;padding: 5.20625px;overflow-x: auto;white-space: nowrap;"># 配置StatFilter<br mpa-from-tpl="t" />spring.datasource.druid.filter.stat.enabled=true<br mpa-from-tpl="t" />spring.datasource.druid.filter.stat.db-type=h2<br mpa-from-tpl="t" />spring.datasource.druid.filter.stat.log-slow-sql=true<br mpa-from-tpl="t" />spring.datasource.druid.filter.stat.slow-sql-millis=2000<br mpa-from-tpl="t" /><br mpa-from-tpl="t" /># 配置WallFilter<br mpa-from-tpl="t" />spring.datasource.druid.filter.wall.enabled=true<br mpa-from-tpl="t" />spring.datasource.druid.filter.wall.db-type=h2<br mpa-from-tpl="t" />spring.datasource.druid.filter.wall.config.delete-allow=false<br mpa-from-tpl="t" />spring.datasource.druid.filter.wall.config.drop-table-allow=false</p>
目前为以下 Filter 提供了配置支持,根据(spring.datasource.druid.filter.*)进行配置。
不想使用内置的 Filters,要想使自定义 Filter 配置生效需要将对应 Filter 的 enabled 设置为 true ,Druid Spring Boot Starter默认禁用 StatFilter,可以将其 enabled 设置为 true 来启用它。
4 监控页面
(1)启动项目后,访问/druid/login.html来到登录页面,输入用户名密码登录
(2)数据源页面 是当前DataSource配置的基本信息,上述配置的Filter可以在里面找到,如果没有配置Filter(一些信息会无法统计,例如“SQL监控”,会无法获取JDBC相关的SQL执行信息)
(3) SQL监控页面,统计了所有SQL语句的执行情况
(4)URL监控页面,统计了所有Controller接口的访问以及执行情况
(5)Spring 监控页面,利用aop 对指定接口的执行时间,jdbc数进行记录
(6)SQL防火墙页面
druid提供了黑白名单的访问,可以清楚的看到sql防护情况。
(7)Session监控页面
可以看到当前的session状况,创建时间、最后活跃时间、请求次数、请求时间等详细参数。
(8)JSONAPI 页面
通过api的形式访问Druid的监控接口,api接口返回Json形式数据。
5 sql监控
配置 Druid web 监控 filter(WebStatFilter)这个过滤器,作用就是统计 web 应用请求中所有的数据库信息,比如 发出的 sql 语句,sql 执行的时间、请求次数、请求的 url 地址、以及seesion 监控、数据库表的访问次数 等等。
<p style="border-radius: 4px;font-size: 0.85em;margin: 0px 8px;background: rgb(248, 248, 248);color: rgb(51, 51, 51);display: block;padding: 5.20625px;overflow-x: auto;white-space: nowrap;">spring:<br mpa-from-tpl="t" /> datasource:<br mpa-from-tpl="t" /> druid:<br mpa-from-tpl="t" /> ########## 配置WebStatFilter,用于采集web关联监控的数据 ##########<br mpa-from-tpl="t" /> web-stat-filter:<br mpa-from-tpl="t" /> enabled: true # 启动 StatFilter<br mpa-from-tpl="t" /> url-pattern: /* # 过滤所有url<br mpa-from-tpl="t" /> exclusions: "*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*" # 排除一些不必要的url<br mpa-from-tpl="t" /> session-stat-enable: true # 开启session统计功能<br mpa-from-tpl="t" /> session-stat-max-count: 1000 # session的最大个数,默认100</p>
6. 慢sql记录
有时候,系统中有些SQL执行很慢,我们希望使用日志记录下来,可以开启Druid的慢SQL记录功能
<p style="border-radius: 4px;font-size: 0.85em;margin: 0px 8px;background: rgb(248, 248, 248);color: rgb(51, 51, 51);display: block;padding: 5.20625px;overflow-x: auto;white-space: nowrap;">spring:<br mpa-from-tpl="t" /> datasource:<br mpa-from-tpl="t" /> druid:<br mpa-from-tpl="t" /> filter:<br mpa-from-tpl="t" /> stat:<br mpa-from-tpl="t" /> enabled: true # 开启DruidDataSource状态监控<br mpa-from-tpl="t" /> db-type: mysql # 数据库的类型<br mpa-from-tpl="t" /> log-slow-sql: true # 开启慢SQL记录功能<br mpa-from-tpl="t" /> slow-sql-millis: 2000 # 默认3000毫秒,这里超过2s,就是慢,记录到日志</p>
启动后,如果遇到执行慢的SQL,便会输出到日志中。
7.spring 监控
访问之后spring监控默认是没有数据的;这需要导入SprngBoot的AOP的Starter
<p style="border-radius: 4px;font-size: 0.85em;margin: 0px 8px;background: rgb(248, 248, 248);color: rgb(51, 51, 51);display: block;padding: 5.20625px;overflow-x: auto;white-space: nowrap;"><br mpa-from-tpl="t" /><br mpa-from-tpl="t" /> org.springframework.boot<br mpa-from-tpl="t" /> spring-boot-starter-aop<br mpa-from-tpl="t" /></p>
需要在 application.yml 配置:
Spring监控AOP切入点,如com.springboot.template.dao.*,配置多个英文逗号分隔
<p style="border-radius: 4px;font-size: 0.85em;margin: 0px 8px;background: rgb(248, 248, 248);color: rgb(51, 51, 51);display: block;padding: 5.20625px;overflow-x: auto;white-space: nowrap;">spring.datasource.druid.aop-patterns="com.springboot.template.dao.*"</p>
8. 去 Ad(广告)
访问监控页面的时候,你可能会在页面底部(footer)看到阿里巴巴的广告原因:引入的druid的jar包中的common.js(里面有一段js代码是给页面的footer追加广告的)如果想去掉,有两种方式:
(1) 直接手动注释这段代码
如果是使用Maven,直接到本地仓库中,查找这个jar包要注释的代码:
// this.buildFooter();
common.js的位置:
com/alibaba/druid/1.1.23/druid-1.1.23.jar!/support/http/resources/js/common.js(2) 使用过滤器过滤
注册一个过滤器,过滤common.js的请求,使用正则表达式替换相关的广告内容
<p>@Configuration<br mpa-from-tpl="t" />@ConditionalOnWebApplication<br mpa-from-tpl="t" />@AutoConfigureAfter(DruidDataSourceAutoConfigure.class)<br mpa-from-tpl="t" />@ConditionalOnProperty(name = "spring.datasource.druid.stat-view-servlet.enabled",<br mpa-from-tpl="t" />havingValue = "true", matchIfMissing = true)<br mpa-from-tpl="t" />public class RemoveDruidAdConfig {<br mpa-from-tpl="t" /><br mpa-from-tpl="t" /> /**<br mpa-from-tpl="t" /> * 方法名: removeDruidAdFilterRegistrationBean<br mpa-from-tpl="t" /> * 方法描述 除去页面底部的广告<br mpa-from-tpl="t" /> * @param properties com.alibaba.druid.spring.boot.autoconfigure.properties.DruidStatProperties<br mpa-from-tpl="t" /> * @return org.springframework.boot.web.servlet.FilterRegistrationBean<br mpa-from-tpl="t" /> */<br mpa-from-tpl="t" /> @Bean<br mpa-from-tpl="t" /> public FilterRegistrationBean removeDruidAdFilterRegistrationBean(DruidStatProperties properties) {<br mpa-from-tpl="t" /><br mpa-from-tpl="t" /> // 获取web监控页面的参数<br mpa-from-tpl="t" /> DruidStatProperties.StatViewServlet config = properties.getStatViewServlet();<br mpa-from-tpl="t" /> // 提取common.js的配置路径<br mpa-from-tpl="t" /> String pattern = config.getUrlPattern() != null ? config.getUrlPattern() : "/druid/*";<br mpa-from-tpl="t" /> String commonJsPattern = pattern.replaceAll("\\*", "js/common.js");<br mpa-from-tpl="t" /><br mpa-from-tpl="t" /> final String filePath = "support/http/resources/js/common.js";<br mpa-from-tpl="t" /><br mpa-from-tpl="t" /> //创建filter进行过滤<br mpa-from-tpl="t" /> Filter filter = new Filter() {<br mpa-from-tpl="t" /> @Override<br mpa-from-tpl="t" /> public void init(FilterConfig filterConfig) throws ServletException {}<br mpa-from-tpl="t" /><br mpa-from-tpl="t" /> @Override<br mpa-from-tpl="t" /> public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {<br mpa-from-tpl="t" /> chain.doFilter(request, response);<br mpa-from-tpl="t" /> // 重置缓冲区,响应头不会被重置<br mpa-from-tpl="t" /> response.resetBuffer();<br mpa-from-tpl="t" /> // 获取common.js<br mpa-from-tpl="t" /> String text = Utils.readFromResource(filePath);<br mpa-from-tpl="t" /> // 正则替换banner, 除去底部的广告信息<br mpa-from-tpl="t" /> text = text.replaceAll("