Druid监控踩坑指南

概述

最近项目组在预备接入各种指标监控系统，笔者负责的部分刚好涉及到了 Druid，故记载一下在过程中遇到的各种情况和坑。
1. 直接使用 Druid

直接使用 Druid 的监控功能，需要直接将它提供的 Servlet 设置到 Web 容器中。具体可以直接参照官方文档。

• 设置信息采集：https://github.com/alibaba/druid/wiki/设置_StatFilter；
  
• 打开监控：https://github.com/alibaba/druid/wiki/设置_StatViewServlet设置；
  

此外，在这个过程中大部分问题官方文档中也有解答https://github.com/alibaba/druid/wiki/常见问题。
2. 使用 starter

2.1. 启用监控

如果使用 spring-boot-starter ，则可以基于 springboot 集成。
参照：SpringBoot——开启Druid监控统计功能
2.2. SQL监控无数据问题

开启设置后，虽然可用访问监控页面了，但是发现 SQL 监控依然没有数据。
参照：SpringBoot中使用 Druid 数据库连接池, 后台SQL监控无效
不外笔者在实行过上述两种方案后，在 SQL 监控依然无法获取相应的监控数据，在查找 issues 后发现了解决方案：SQL监控无数据--DataSource注入问题导致没有数据。
如果用 javaConf 或者 xml 的方式手动设置 Bean，需要指定开启的 Filters。

1. @Bean("druidDataSource")
2. public DataSource dataSource(Environment env) throws SQLException {
3.   DruidDataSource dataSource = new DruidDataSource();
4.   dataSource.setFilters("stat");
5.   ......
6.   return dataSource;
7. }

复制代码

如果不手动指定 Bean，使用设置指定 Druid 数据，会主动开启 statFilter

1. spring.datasource.url=your_url
2. spring.datasource.username=username
3. spring.datasource.password=password
4. pring.datasource.driver-class-name=com.mysql.jdbc.Driver
5. spring.datasource.type=com.alibaba.druid.pool.DruidDataSource

复制代码

实际上，笔者的项目就是第一种情况，我们的数据源是在设置类中单独设置的，因此需要通过 dataSource.setFilters("stat") 手动开启状态采集器，其余设置保持不变，重启项目后正常。
3. 手动采集

如果不依靠 Druid 的监控页面，也可以本身获取线程池举行采集，Druid 已经提供好的响应的 API，我们只需要将相应的指标收集任务注册好即可。
这里以 Metrics 为例：

1. /**
2. * DruidMetricsCollector
3. *
4. * @author huangchengxing
5. */
6. @ConditionalOnClass({DruidDataSource.class, MeterRegistry.class})
7. @Component
8. @Slf4j
9. @RequiredArgsConstructor
10. public class DruidMetricsCollector implements ApplicationContextAware, InitializingBean {
12.     private static final String LABEL_NAME = "druid-data-source";
13.     private final MeterRegistry registry;
14.     @Setter
15.     private ApplicationContext applicationContext;
17.     @Override
18.     public void afterPropertiesSet() throws Exception {
19.         log.info("Metrics components: druid register finish");
20.         Map<String, DataSource> dataSourceMap = applicationContext.getBeansOfType(DataSource.class);
21.         dataSourceMap.forEach((name, ds) -> {
22.             DruidDataSource druidDataSource = null;
23.             try {
24.                 druidDataSource = ds.unwrap(DruidDataSource.class);
25.             } catch (SQLException e) {
26.                 log.warn("Failed to unwrap DruidDataSource from DataSource: {}", name, e);
27.             }
28.             if (druidDataSource != null) {
29.                 log.info("Registering metrics for DruidDataSource: {}", name);
30.                 registerMetrics(druidDataSource);
31.             }
32.         });
33.     }
35.     private void registerMetrics(DruidDataSource druidDataSource) {
36.         registerGauge(druidDataSource, "druid_initial_size", "Initial size", (datasource) -> (double) druidDataSource.getInitialSize());
37.         registerGauge(druidDataSource, "druid_min_idle", "Min idle", datasource -> (double) druidDataSource.getMinIdle());
38.         registerGauge(druidDataSource, "druid_max_active", "Max active", datasource -> (double) druidDataSource.getMaxActive());
40.         registerGauge(druidDataSource, "druid_active_count", "Active count", datasource -> (double) druidDataSource.getActiveCount());
41.         registerGauge(druidDataSource, "druid_active_peak", "Active peak", datasource -> (double) druidDataSource.getActivePeak());
42.         registerGauge(druidDataSource, "druid_pooling_peak", "Pooling peak", datasource -> (double) druidDataSource.getPoolingPeak());
43.         registerGauge(druidDataSource, "druid_pooling_count", "Pooling count", datasource -> (double) druidDataSource.getPoolingCount());
44.         registerGauge(druidDataSource, "druid_wait_thread_count", "Wait thread count", datasource -> (double) druidDataSource.getWaitThreadCount());
46.         registerGauge(druidDataSource, "druid_not_empty_wait_count", "Not empty wait count", datasource -> (double) druidDataSource.getNotEmptyWaitCount());
47.         registerGauge(druidDataSource, "druid_not_empty_wait_millis", "Not empty wait millis", datasource -> (double) druidDataSource.getNotEmptyWaitMillis());
48.         registerGauge(druidDataSource, "druid_not_empty_thread_count", "Not empty thread count", datasource -> (double) druidDataSource.getNotEmptyWaitThreadCount());
50.         registerGauge(druidDataSource, "druid_logic_connect_count", "Logic connect count", datasource -> (double) druidDataSource.getConnectCount());
51.         registerGauge(druidDataSource, "druid_logic_close_count", "Logic close count", datasource -> (double) druidDataSource.getCloseCount());
52.         registerGauge(druidDataSource, "druid_logic_connect_error_count", "Logic connect error count", datasource -> (double) druidDataSource.getConnectErrorCount());
53.         registerGauge(druidDataSource, "druid_physical_connect_count", "Physical connect count", datasource -> (double) druidDataSource.getCreateCount());
54.         registerGauge(druidDataSource, "druid_physical_close_count", "Physical close count", datasource -> (double) druidDataSource.getDestroyCount());
55.         registerGauge(druidDataSource, "druid_physical_connect_error_count", "Physical connect error count", datasource -> (double) druidDataSource.getCreateErrorCount());
57.         registerGauge(druidDataSource, "druid_error_count", "Error count", datasource -> (double) druidDataSource.getErrorCount());
58.         registerGauge(druidDataSource, "druid_execute_count", "Execute count", datasource -> (double) druidDataSource.getExecuteCount());
59.         registerGauge(druidDataSource, "druid_start_transaction_count", "Start transaction count", datasource -> (double) druidDataSource.getStartTransactionCount());
60.         registerGauge(druidDataSource, "druid_commit_count", "Commit count", datasource -> (double) druidDataSource.getCommitCount());
61.         registerGauge(druidDataSource, "druid_rollback_count", "Rollback count", datasource -> (double) druidDataSource.getRollbackCount());
63.         registerGauge(druidDataSource, "druid_prepared_statement_open_count", "Prepared statement open count", datasource -> (double) druidDataSource.getPreparedStatementCount());
64.         registerGauge(druidDataSource, "druid_prepared_statement_closed_count", "Prepared statement closed count", datasource -> (double) druidDataSource.getClosedPreparedStatementCount());
65.         registerGauge(druidDataSource, "druid_ps_cache_access_count", "PS cache access count", datasource -> (double) druidDataSource.getCachedPreparedStatementAccessCount());
66.         registerGauge(druidDataSource, "druid_ps_cache_hit_count", "PS cache hit count", datasource -> (double) druidDataSource.getCachedPreparedStatementHitCount());
67.         registerGauge(druidDataSource, "druid_ps_cache_miss_count", "PS cache miss count", datasource -> (double) druidDataSource.getCachedPreparedStatementMissCount());
68.         registerGauge(druidDataSource, "druid_execute_query_count", "Execute query count", datasource -> (double) druidDataSource.getExecuteQueryCount());
69.         registerGauge(druidDataSource, "druid_execute_update_count", "Execute update count", datasource -> (double) druidDataSource.getExecuteUpdateCount());
70.         registerGauge(druidDataSource, "druid_execute_batch_count", "Execute batch count", datasource -> (double) druidDataSource.getExecuteBatchCount());
72.         registerGauge(druidDataSource, "druid_max_wait", "Max wait", datasource -> (double) druidDataSource.getMaxWait());
73.         registerGauge(druidDataSource, "druid_max_wait_thread_count", "Max wait thread count", datasource -> (double) druidDataSource.getMaxWaitThreadCount());
74.         registerGauge(druidDataSource, "druid_login_timeout", "Login timeout", datasource -> (double) druidDataSource.getLoginTimeout());
75.         registerGauge(druidDataSource, "druid_query_timeout", "Query timeout", datasource -> (double) druidDataSource.getQueryTimeout());
76.         registerGauge(druidDataSource, "druid_transaction_query_timeout", "Transaction query timeout", datasource -> (double) druidDataSource.getTransactionQueryTimeout());
77.     }
79.     private void registerGauge(DruidDataSource weakRef, String metric, String help, ToDoubleFunction<DruidDataSource> measure) {
80.         Gauge.builder(metric, weakRef, measure)
81.             .description(help)
82.             .tag(LABEL_NAME, weakRef.getName())
83.             .register(this.registry);
84.     }
85. }

复制代码

项目启动后，确保该组件被 Spring 管理即可。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。