Provide proxy classes for JDBC API to intercept executing queries.
-
Query and Parameter Logging
You can log executing database queries and parameters with choice of your logging framework(commons, slf4j, java util logging, sysout, or your own). Output can be formatted as JSON. -
Slow Query Detector and Loggers
You can add callbacks for slow queries that take longer than threshold time you specified.
Slow query loggers are available out of the box. -
Connection ID Each connection is assigned unique ID that is a sequentially increasing number in default implementation.
The connection ID is included in logging entry. -
Query Metrics
You can collect statistics of executed query such as total time, number of select, insert, update, delete queries, etc. Output can be formatted as JSON. -
Custom Logic Injection for Query Execution
You can write ownQueryExecutionListenerand they can get called before/after query execution. -
Web Application Support
ProxyDataSourcecan be configured via JNDI.
Query metrics information are available per web request basis(request-response lifecycle).
For UI with JSP, custom tag to access metrics(<dsp:metrics/>) is available as well. -
Query and parameter replacement
QueryTransformerandParameterTransformerallows you to modify executing query and parameters right before calling the database.
Query execution(single line):
Name:MyProxy, Connection:1, Time:1, Success:True, Type:Statement, Batch:False, QuerySize:1, BatchSize:0, Query:["CREATE TABLE users(id INT, name VARCHAR(255))"], Params:[]
Name:MyProxy, Connection:2, Time:5, Success:True, Type:Prepared, Batch:True, QuerySize:1, BatchSize:2, Query:["INSERT INTO users (id, name) VALUES (?, ?)"], Params:[(1,foo),(2,bar)]Query execution(multiple lines):
Name:MyProxy, Connection:1, Time:3, Success:True
Type:Callable, Batch:True, QuerySize:1, BatchSize:2
Query:["{call getEmployer (?, ?)}"]
Params:[(id=100,name=foo),(id=200,name=bar)]JSON output:
{"name":"MyProxy", "connection":1, "time":1, "success":true, "type":"Statement", "batch":false, "querySize":1, "batchSize":0, "query":["CREATE TABLE users(id INT, name VARCHAR(255))"], "params":[]}
{"name":"MyProxy", "connection":2, "time":0, "success":true, "type":"Prepared", "batch":true, "querySize":1, "batchSize":3, "query":["INSERT INTO users (id, name) VALUES (?, ?)"], "params":[["1","foo"],["2","bar"],[3","baz"]]}Query metrics:
Name:"MyProxy", Time:6, Total:1, Success:1, Failure:0, Select:1, Insert:0, Update:0, Delete:0, Other:0// JSON output
{"name":"MyProxy", "time":10, "total":3, "success":3, "failure":0, "select":1, "insert":2, "update":0, "delete":0, "other":0}<dependency>
<groupId>net.ttddyy</groupId>
<artifactId>datasource-proxy</artifactId>
<version>[LATEST_VERSION]</version>
</dependency>-
latest version is:
-
No dependencies to other libraries, everything is optional.
- For example, if you want to use slf4j logger with
SLF4JQueryLoggingListener, then you need slf4j library.
- For example, if you want to use slf4j logger with
-
requires jdk1.6+
Available in maven central repo.
snapshot is available via oss sonatype snapshot repository.
To download snapshot jars, enable sonatype snapshot repository:
<repositories>
<repository>
<id>sonatype-snapshots-repo</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>Create ProxyDataSource class and pass it as a DataSource to your application.
Java based
DataSource dataSource =
ProxyDataSourceBuilder
.create(actualDataSource)
.logQueryByCommons(INFO) // logQueryBySlf4j(), logQueryByJUL(), logQueryToSysOut()
.countQuery()
.logSlowQueryByCommons(10, TimeUnit.MINUTES) // also by sl4j, jul, system out
.build();Spring (XML)
<bean id="dataSource" class="net.ttddyy.dsproxy.support.ProxyDataSource">
<property name="dataSource" ref="[ACTUAL DATASOURCE BEAN]"/>
<property name="listener" ref="listeners"/>
</bean>
<bean id="listeners" class="net.ttddyy.dsproxy.listener.ChainListener">
<property name="listeners">
<list>
<bean class="net.ttddyy.dsproxy.listener.logging.CommonsQueryLoggingListener">
<!-- <bean class="net.ttddyy.dsproxy.listener.logging.SLF4JQueryLoggingListener"> -->
<property name="logLevel" value="INFO"/> <!-- Default is DEBUG -->
</bean>
<bean class="net.ttddyy.dsproxy.listener.DataSourceQueryCountListener"/>
</list>
</property>
</bean>JNDI
<Resource name="jdbc/global/myProxy"
auth="Container"
type="net.ttddyy.dsproxy.support.ProxyDataSource"
factory="net.ttddyy.dsproxy.support.jndi.ProxyDataSourceObjectFactory"
description="ds"
listeners="commons,count"
proxyName="MyProxy"
dataSource="[REFERENCE_TO_ACTUAL_DATASOURCE_RESOURCE]" <!-- ex: java:jdbc/global/myDS -->
/>(optional) To log query metrics(not query execution), add one of the followings to your application:
By Servlet Filter (javax.servlet.Filter):
CommonsQueryCountLoggingServletFilterSLF4JQueryCountLoggingServletFilterJULQueryCountLoggingServletFilterSystemOutQueryCountLoggingServletFilter
By Servlet Request Listener (javax.servlet.ServletRequestListener):
CommonsQueryCountLoggingRequestListenerSLF4JQueryCountLoggingRequestListenerJULQueryCountLoggingRequestListenerSystemOutQueryCountLoggingRequestListener
By Spring HandlerInterceptor (org.springframework.web.servlet.HandlerInterceptor):
CommonsQueryCountLoggingHandlerInterceptorSLF4JQueryCountLoggingHandlerInterceptorJULQueryCountLoggingHandlerInterceptorSystemOutQueryCountLoggingHandlerInterceptor
<%@ taglib prefix="dsp" uri="http://www.ttddyy.net/dsproxy/tags" %>
<dsp:metrics metric="select"/> - Select
<dsp:metrics metric="update" dataSource="FOO" /> - Num of update queries for datasource FOO
<dsp:metrics metric="total"/> - Total Queries
<dsp:metrics metric="call"/> - Num of DB Call
<dsp:metrics metric="time"/> - Total TImeExample projects: https://github.com/ttddyy/datasource-proxy-examples
-
[Documentation] (https://github.com/ttddyy/datasource-proxy/wiki/_pages)