@ProfileConnection - quick-perf/doc GitHub Wiki

The ProfileConnection annotation profiles the database connection.

The annotation profiles the calls to the java.sql.Connection methods and the calls to the javax.sql.DataSource.getConnection() method.

🔧 Elements

Name	Type	Meaning	Default value
level	Level	Allows defining the profiling level. The default value is `INFO`. With a `TRACE` level, the annotation profiles more java.sql.Connection methods: Connection.createStatement(), Connection.createStatement(int, int), Connection.createStatement(int, int, int), Connection.prepareStatement(String), Connection.prepareStatement(String, int[]), Connection.prepareStatement(String, String[]), Connection.prepareStatement(String, int), Connection.prepareStatement(String, int, int), Connection.prepareStatement(String, int, int, int), Connection.prepareCall(String), Connection.prepareCall(String, int, int), Connection.prepareCall(String, int, int, int), Connection.createBlb(), Connection.createClob(), Connection.createNClob(), Connection.createSQLXML(), Connection.createArrayOf(String, Object[]), Connection.createStruct(String, Object[])	Level.INFO
displayStackTrace	boolean	Allows displaying the stack traces of the profiled java.sql.Connection methods and the profiled javax.sql.DataSource.getConnection() method.	false
filterStackTrace	boolean	If the stack trace display is enabled, the `filterStackTrace` element allows removing elements from the stack traces coming from `QuickPerf`, `JUnit 4`, `JUnit 5`, and `TestNG`.	true
stackDepth	short	If the stack trace display is enabled, the `stackDepth` element allows configuring the number of elements to display on the stack traces. With a `-1` value, the annotation does not limit the stack depth.	-1
beforeAndAfterTestMethodExecution	boolean	Allows profiling the java.sql.Connection before and after the test method execution. The default behavior is not to profile the database connection before and after the test method execution.	false

🔎 Example

    @Test
    @ProfileConnection
    public void code() {
    ...
    }

On the console:

connection 657628458 - javax.sql.DataSource.getConnection()
connection 657628458 - java.sql.Connection.close()

🔎 Hibernate example with stack trace display

    @Test
    @ProfileConnection(displayStackTrace = true)
    public void example_with_hibernate_application() {
    ...
    }

connection 67985650 - javax.sql.DataSource.getConnection()
	org.hibernate.engine.jdbc.connections.internal.DatasourceConnectionProviderImpl.getConnection(DatasourceConnectionProviderImpl.java:122)
	org.hibernate.internal.NonContextualJdbcConnectionAccess.obtainConnection(NonContextualJdbcConnectionAccess.java:35)
	org.hibernate.resource.jdbc.internal.LogicalConnectionManagedImpl.acquireConnectionIfNeeded(LogicalConnectionManagedImpl.java:106)
	org.hibernate.resource.jdbc.internal.LogicalConnectionManagedImpl.getPhysicalConnection(LogicalConnectionManagedImpl.java:136)
	org.hibernate.internal.SessionImpl.connection(SessionImpl.java:544)
	SqlTestBase.getConnection(SqlTestBase.java:71)
	ProfileConnectionTest$ProfileConnectionClass.test(ProfileConnectionTest.java:60)
connection 67985650 - java.sql.Connection.prepareStatement(String sql) [sql: select isbn from Book]
	ProfileConnectionTest$ProfileConnectionClass.test(ProfileConnectionTest.java:61)
connection 67985650 - java.sql.Connection.close()
	ProfileConnectionTest$ProfileConnectionClass.test(ProfileConnectionTest.java:63)

🔎 Spring Boot example

    @Test
    @ProfileConnection(displayStackTrace = true)
    public void example_with_spring_boot_application() {
    ...
    }