Updated on 2023-08-02 GMT+08:00

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

Max. Connections Allowed

Maximum number of connections that are allowed

-

INT

LAST

leakDetectionThreshold

Max. Pool Size

Maximum connection pool size

-

INT

LAST

validationTimeout

Waiting Threads

Number of waiting threads

-

INT

LAST

maxLifetime

Maximum Waiting Threads

Maximum number of waiting threads

-

INT

LAST

poolingCount

Pool Connections

Number of connections in the pool

-

INT

LAST

poolingPeak

Max. Connections

Maximum number of connections in the pool

-

INT

MAX

activeCount

Active Connections

Number of active connections

-

INT

LAST

activePeak

Max. Active Connections

Maximum number of active connections

-

INT

MAX

logicConnectCount

Total Connections

Total number of connections

-

INT

SUM

maxWait

Max. Waiting Time

Max. Waiting Time

-

INT

LAST

removeAbandoned

Automatically Reclaim Timeout Connections

Whether to automatically reclaim timeout connections

-

STRING

LAST

removeAbandonedCount

Timeout Connection Reclaims

Number of times that timeout connections are reclaimed

-

INT

LAST

removeAbandonedTimeoutMillis

Max. Connection Usage Duration

If a connection in the pool is not returned within the specified duration, the connection will be reclaimed.

-

INT

LAST

testWhileIdle

Idle Connection Validity Check

Whether to verify the validity of an idle connection when an application applies for it from the pool

-

STRING

LAST

testOnBorrow

Validity Check Before Obtaining Connection

Check whether a connection is valid before obtaining it from the connection pool.

-

STRING

LAST

testOnReturn

Validity Check Upon Connection Return

Whether to verify the validity of a connection when it is returned

-

STRING

LAST

minEvictableIdleTimeMillis

Allowed Connection Idle Time

Idle time that is allowed for connections in the pool

-

INT

LAST

timeBetweenEvictionRunsMillis

Interval for Checking Idle Connection Validity

Interval for checking the validity of idle connections

-

INT

LAST

driverName

Driver

Driver

-

STRING

LAST

totalConnections

Total Connections

Total number of connections

-

INT

LAST

activeConnections

Active Connections

Number of active connections

-

INT

LAST

idleConnections

Idle Connections

Number of idle connections

-

INT

LAST

threadsAwaitingConnection

Waiting Connections

Number of waiting connections

-

INT

LAST

Connection details (connection)

url

Connection Address

Connection address

-

ENUM

LAST

concurrentMax

Max. Concurrency

Maximum concurrency

-

INT

MAX

invokeCount

Calls

Number of calls

-

INT

SUM

totalTime

Total Time

Total time

-

INT

SUM

errorCount

Errors

Number of errors

-

INT

SUM

maxTime

Max. RT

Maximum response time

-

INT

SUM

range1

0–10 ms

Number of requests with 0–10 ms response time

-

INT

SUM

range2

10–100 ms

Number of requests with 10–100 ms response time

-

INT

SUM

range3

100–500 ms

Number of requests with 100–500 ms response time

-

INT

SUM

range4

500–1000 ms

Number of requests with 500–1000 ms response time

-

INT

SUM

range5

1–10s

Number of requests with 1–10s response time

-

INT

SUM

range6

> 10s

Number of requests with response time longer than 10s

-

INT

SUM

Exception (exception: Hikari call exception statistics)

exceptionType

Exception Type

Exception type

-

ENUM

LAST

causeType

Exception Class

Exception class

-

ENUM

LAST

count

Count

Number of times the exception has occurred

-

INT

SUM

message

Exception Message

Message returned when the exception has occurred

-

STRING

LAST

stackTrace

Exception Stack

Exception stack information

-

CLOB

LAST

Version (version)

version

Version

Version

-

STRING

LAST