root
/
spring-boot
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

Polish "Add metrics support for idle jdbc connections"

Browse Source 
See gh-17504
pull/17557/head
Stephane Nicoll 5 years ago
parent 9acc02b5cc
commit 56ce2b8e3f
10 changed files with 27 additions and 60 deletions
Show Stats Download Patch File Download Diff File

3
spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/jdbc/DataSourcePoolMetrics.java
Unescape Escape View File

@ -38,7 +38,6 @@ import org.springframework.util.ConcurrentReferenceHashMap;
*
* @author Jon Schneider
* @author Phillip Webb
* @author Artsiom Yudovin
* @since 2.0.0
*/
public class DataSourcePoolMetrics implements MeterBinder {
@ -67,9 +66,9 @@ public class DataSourcePoolMetrics implements MeterBinder {
public void bindTo(MeterRegistry registry) {
if (this.metadataProvider.getDataSourcePoolMetadata(this.dataSource) != null) {
bindPoolMetadata(registry, "active", DataSourcePoolMetadata::getActive);
bindPoolMetadata(registry, "idle", DataSourcePoolMetadata::getIdle);
bindPoolMetadata(registry, "max", DataSourcePoolMetadata::getMax);
bindPoolMetadata(registry, "min", DataSourcePoolMetadata::getMin);
bindPoolMetadata(registry, "idle", DataSourcePoolMetadata::getIdle);
}
}

4
spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
Unescape Escape View File

@ -2023,8 +2023,8 @@ is required. A `CacheMetricsRegistrar` bean is made available to make that proce
==== DataSource Metrics
Auto-configuration enables the instrumentation of all available `DataSource` objects with
a metric named `jdbc`. Data source instrumentation results in gauges representing the
currently active, maximum allowed, and minimum allowed connections in the pool. Each of
these gauges has a name that is prefixed by `jdbc`.
currently active, idle, maximum allowed, and minimum allowed connections in the pool. Each
of these gauges has a name that is prefixed by `jdbc`.
Metrics are also tagged by the name of the `DataSource` computed based on the bean name.

11
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/metadata/CommonsDbcp2DataSourcePoolMetadata.java
Unescape Escape View File

@ -24,7 +24,6 @@ import org.apache.commons.dbcp2.BasicDataSource;
* {@link DataSourcePoolMetadata} for an Apache Commons DBCP2 {@link DataSource}.
*
* @author Stephane Nicoll
* @author Artsiom Yudovin
* @since 2.0.0
*/
public class CommonsDbcp2DataSourcePoolMetadata extends AbstractDataSourcePoolMetadata<BasicDataSource> {
@ -38,6 +37,11 @@ public class CommonsDbcp2DataSourcePoolMetadata extends AbstractDataSourcePoolMe
return getDataSource().getNumActive();
}
@Override
public Integer getIdle() {
return getDataSource().getNumIdle();
}
@Override
public Integer getMax() {
return getDataSource().getMaxTotal();
@ -58,9 +62,4 @@ public class CommonsDbcp2DataSourcePoolMetadata extends AbstractDataSourcePoolMe
return getDataSource().getDefaultAutoCommit();
}
@Override
public Integer getIdle() {
return getDataSource().getNumIdle();
}
}

3
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/metadata/DataSourcePoolMetadata.java
Unescape Escape View File

@ -1,5 +1,5 @@
/*
* Copyright 2012-2017 the original author or authors.
* Copyright 2012-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -55,6 +55,7 @@ public interface DataSourcePoolMetadata {
* if that information is not available.
* @return the number of established but idle connections or {@code null}
* @since 2.2.0
* @see #getActive()
*/
default Integer getIdle() {
return null;

13
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/metadata/HikariDataSourcePoolMetadata.java
Unescape Escape View File

@ -16,8 +16,6 @@
package org.springframework.boot.jdbc.metadata;
import java.util.Objects;
import javax.sql.DataSource;
import com.zaxxer.hikari.HikariDataSource;
@ -29,7 +27,6 @@ import org.springframework.beans.DirectFieldAccessor;
* {@link DataSourcePoolMetadata} for a Hikari {@link DataSource}.
*
* @author Stephane Nicoll
* @author Artsiom Yudovin
* @since 2.0.0
*/
public class HikariDataSourcePoolMetadata extends AbstractDataSourcePoolMetadata<HikariDataSource> {
@ -50,12 +47,12 @@ public class HikariDataSourcePoolMetadata extends AbstractDataSourcePoolMetadata
@Override
public Integer getIdle() {
HikariPool pool = getHikariPool();
if (Objects.nonNull(pool)) {
return pool.getIdleConnections();
try {
return getHikariPool().getIdleConnections();
}
catch (Exception ex) {
return null;
}
return null;
}
private HikariPool getHikariPool() {

11
spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/metadata/TomcatDataSourcePoolMetadata.java
Unescape Escape View File

@ -23,7 +23,6 @@ import org.apache.tomcat.jdbc.pool.DataSource;
* {@link DataSourcePoolMetadata} for a Tomcat DataSource.
*
* @author Stephane Nicoll
* @author Artsiom Yudovin
* @since 2.0.0
*/
public class TomcatDataSourcePoolMetadata extends AbstractDataSourcePoolMetadata<DataSource> {
@ -38,6 +37,11 @@ public class TomcatDataSourcePoolMetadata extends AbstractDataSourcePoolMetadata
return (pool != null) ? pool.getActive() : 0;
}
@Override
public Integer getIdle() {
return getDataSource().getNumIdle();
}
@Override
public Integer getMax() {
return getDataSource().getMaxActive();
@ -58,9 +62,4 @@ public class TomcatDataSourcePoolMetadata extends AbstractDataSourcePoolMetadata
return getDataSource().isDefaultAutoCommit();
}
@Override
public Integer getIdle() {
return getDataSource().getNumIdle();
}
}

5
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jdbc/metadata/AbstractDataSourcePoolMetadataTests.java
Unescape Escape View File

@ -34,7 +34,8 @@ import static org.assertj.core.api.Assertions.assertThat;
abstract class AbstractDataSourcePoolMetadataTests<D extends AbstractDataSourcePoolMetadata<?>> {
/**
* Return a data source metadata instance with a min size of 0 and max size of 2.
* Return a data source metadata instance with a min size of 0 and max size of 2. Idle
* connections are not reclaimed immediately.
* @return the data source metadata
*/
protected abstract D getDataSourceMetadata();
@ -70,6 +71,8 @@ abstract class AbstractDataSourcePoolMetadataTests<D extends AbstractDataSourceP
@Test
void getIdle() {
JdbcTemplate jdbcTemplate = new JdbcTemplate(getDataSourceMetadata().getDataSource());
jdbcTemplate.execute((ConnectionCallback<Void>) (connection) -> null);
assertThat(getDataSourceMetadata().getIdle()).isEqualTo(Integer.valueOf(1));
}

12
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jdbc/metadata/CommonsDbcp2DataSourcePoolMetadataTests.java
Unescape Escape View File

@ -19,9 +19,6 @@ package org.springframework.boot.jdbc.metadata;
import org.apache.commons.dbcp2.BasicDataSource;
import org.junit.jupiter.api.Test;
import org.springframework.jdbc.core.ConnectionCallback;
import org.springframework.jdbc.core.JdbcTemplate;
import static org.assertj.core.api.Assertions.assertThat;
/**
@ -86,9 +83,7 @@ class CommonsDbcp2DataSourcePoolMetadataTests
BasicDataSource dataSource = createDataSource();
dataSource.setMinIdle(minSize);
dataSource.setMaxTotal(maxSize);
this.initPool(dataSource);
dataSource.setMinEvictableIdleTimeMillis(5000);
return new CommonsDbcp2DataSourcePoolMetadata(dataSource);
}
@ -96,9 +91,4 @@ class CommonsDbcp2DataSourcePoolMetadataTests
return initializeBuilder().type(BasicDataSource.class).build();
}
private void initPool(BasicDataSource dataSource) {
JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
jdbcTemplate.execute((ConnectionCallback<Void>) (connection) -> null);
}
}

13
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jdbc/metadata/HikariDataSourcePoolMetadataTests.java
Unescape Escape View File

@ -18,16 +18,12 @@ package org.springframework.boot.jdbc.metadata;
import com.zaxxer.hikari.HikariDataSource;
import org.springframework.jdbc.core.ConnectionCallback;
import org.springframework.jdbc.core.JdbcTemplate;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link HikariDataSourcePoolMetadata}.
*
* @author Stephane Nicoll
* @author Artsiom Yudovin
*/
public class HikariDataSourcePoolMetadataTests
extends AbstractDataSourcePoolMetadataTests<HikariDataSourcePoolMetadata> {
@ -58,15 +54,8 @@ public class HikariDataSourcePoolMetadataTests
HikariDataSource dataSource = initializeBuilder().type(HikariDataSource.class).build();
dataSource.setMinimumIdle(minSize);
dataSource.setMaximumPoolSize(maxSize);
this.initPool(dataSource);
dataSource.setIdleTimeout(5000);
return dataSource;
}
private void initPool(HikariDataSource dataSource) {
JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
jdbcTemplate.execute((ConnectionCallback<Void>) (connection) -> null);
}
}

12
spring-boot-project/spring-boot/src/test/java/org/springframework/boot/jdbc/metadata/TomcatDataSourcePoolMetadataTests.java
Unescape Escape View File

@ -18,9 +18,6 @@ package org.springframework.boot.jdbc.metadata;
import org.apache.tomcat.jdbc.pool.DataSource;
import org.springframework.jdbc.core.ConnectionCallback;
import org.springframework.jdbc.core.JdbcTemplate;
import static org.assertj.core.api.Assertions.assertThat;
/**
@ -57,19 +54,12 @@ public class TomcatDataSourcePoolMetadataTests
DataSource dataSource = initializeBuilder().type(DataSource.class).build();
dataSource.setMinIdle(minSize);
dataSource.setMaxActive(maxSize);
dataSource.setMinEvictableIdleTimeMillis(5000);
// Avoid warnings
dataSource.setInitialSize(minSize);
dataSource.setMaxIdle(maxSize);
this.initPool(dataSource);
return dataSource;
}
private void initPool(DataSource dataSource) {
JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
jdbcTemplate.execute((ConnectionCallback<Void>) (connection) -> null);
}
}

Write Preview
Loading…
Cancel
Save