Hikari Connection Pool Monitoring

This section describes the types, names, and meanings of Hikari connection pool metrics collected by APM.

Table 1 Hikari connection pool collection parameters

Parameter	Data Type	Application Type	Default	Supported Start Agent Version	Supported End Agent Version	Description
Threshold (ms) for Reporting Connection Trace	integer	JAVA	1	2.1.0	-	Threshold for reporting getConnection method traces. If the threshold is not exceeded, such traces will not be reported.
Obtain Pool Info or Not	radio	JAVA	false	2.1.0	-	Whether to obtain pool information when getting connections

Table 2 Hikari connection pool metrics

Category	Metric	Name	Description	Unit	Data Type	Default Aggregation Mode
Data source (dataSource)	url	url	url	-	ENUM	LAST
	maximumPoolSize	maximumPoolSize	Maximum number of connections that are allowed	-	INT	LAST
	leakDetectionThreshold	leakDetectionThreshold	Maximum connection pool size	-	INT	LAST
	validationTimeout	validationTimeout	Number of waiting threads	-	INT	LAST
	maxLifetime	maxLifetime	Maximum number of waiting threads	-	INT	LAST
	poolingCount	poolingCount	Number of connections in the pool	-	INT	LAST
	poolingPeak	poolingPeak	Maximum number of connections in the pool	-	INT	MAX
	activeCount	activeCount	Number of active connections	-	INT	LAST
	activePeak	activePeak	Maximum number of active connections	-	INT	MAX
	logicConnectCount	logicConnectCount	Total number of connections	-	INT	SUM
	maxWait	maxWait	Max. Waiting Time	ms	INT	LAST
	removeAbandoned	removeAbandoned	Whether to automatically reclaim timeout connections	-	STRING	LAST
	removeAbandonedCount	removeAbandonedCount	Number of times that timeout connections are reclaimed	-	INT	LAST
	removeAbandonedTimeoutMillis	removeAbandonedTimeoutMillis	If a connection in the pool is not returned within the specified duration, the connection will be reclaimed.	-	INT	LAST
	testWhileIdle	testWhileIdle	Whether to verify the validity of an idle connection when an application applies for it from the pool	-	STRING	LAST
	testOnBorrow	testOnBorrow	Check whether a connection is valid before obtaining it from the connection pool.	-	STRING	LAST
	testOnReturn	testOnReturn	Whether to verify the validity of a connection when it is returned	-	STRING	LAST
	minEvictableIdleTimeMillis	minEvictableIdleTimeMillis	Idle time that is allowed for connections in the pool	ms	INT	LAST
	timeBetweenEvictionRunsMillis	timeBetweenEvictionRunsMillis	Interval for checking the validity of idle connections	-	INT	LAST
	driverName	driverName	Driver	-	STRING	LAST
	totalConnections	totalConnections	Total number of connections	-	INT	LAST
	activeConnections	activeConnections	Number of active connections	-	INT	LAST
	idleConnections	idleConnections	Number of idle connections	-	INT	LAST
	threadsAwaitingConnection	threadsAwaitingConnection	Number of waiting connections	-	INT	LAST
Connection details (connection)	url	url	Connection address	-	ENUM	LAST
	concurrentMax	concurrentMax	Maximum concurrency	-	INT	MAX
	invokeCount	invokeCount	Number of calls	-	INT	SUM
	totalTime	totalTime	Total time	-	INT	SUM
	errorCount	errorCount	Number of errors	-	INT	SUM
	maxTime	maxTime	Maximum response time	ms	INT	SUM
	range1	range1	Number of requests with 0-10 ms response time	-	INT	SUM
	range2	range2	Number of requests with 10-100 ms response time	-	INT	SUM
	range3	range3	Number of requests with 100-500 ms response time	-	INT	SUM
	range4	range4	Number of requests with 500-1000 ms response time	-	INT	SUM
	range5	range5	Number of requests with 1-10s response time	-	INT	SUM
	range6	range6	Number of requests with response time longer than 10s	-	INT	SUM
Exception (exception: Hikari call exception statistics)	exceptionType	exceptionType	Exception type	-	ENUM	LAST
	causeType	causeType	Exception class	-	ENUM	LAST
	count	count	Number of times the exception has occurred	-	INT	SUM
	message	message	Message returned when the exception occurred	-	STRING	LAST
	stackTrace	stackTrace	Exception stack information	-	CLOB	LAST
Version (version)	version	version	Version	-	STRING	LAST

last updated: 2024-09-09 10:12 UTC - commit: b6d225b84799f22b12517259e0e7889c39465d9d