ClickHouse Database

This section describes the types, names, and meanings of ClickHouse database metrics collected by APM.

**Table 1** ClickHouse database collection parameters
Parameter	Data Type	Application Type	Default	Supported Start Agent Version	Supported End Agent Version	Description
Collect Original SQL Statement or Not	radio	JAVA	false	2.0.0	-	Whether to collect and report original SQL statements

**Table 2** ClickHouse database metrics
Category	Metric	Name	Description	Unit	Data Type	Default Aggregation Mode
Database connection (connection: APM counts SQL call statistics by database.)	db	Database	Database name	-	ENUM	LAST
	createdCount	Created Connections	Number of connections created by the database	-	INT	SUM
	currentCount	Current Connections	Current number of connections of the database	-	INT	SUM
	destroyedCount	Destroyed Connections	Number of the database's connections that have been destroyed	-	INT	SUM
	errorCount	Errors	Number of errors that the database encounters	-	INT	SUM
	invokeCount	Calls	Number of times that the database is called	-	INT	SUM
	maxTime	Max. RT	Maximum response time of the database	-	INT	MAX
	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–200 ms	Number of requests with 100–200 ms response time	-	INT	SUM
	range4	200–1000 ms	Number of requests with 200–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
	readRowCount	Read Rows	Number of rows read from the database	-	INT	SUM
	updatedRowCount	Updated Rows	Number of rows updated in the database	-	INT	SUM
	totalTime	Total RT	Total response time of the database	-	INT	SUM
	slowestSql	Slowest SQL	Slowest SQL statement of the database in the collection period	-	STRING	LAST
Exception (exception: exception statistics about SQL calls)	causeType	Class	Exception class	-	ENUM	LAST
	exceptionType	Exception Type	Exception type	-	ENUM	LAST
	count	Count	Number of exceptions	-	INT	SUM
	message	Message	Exception message	-	STRING	LAST
	sql	Exception SQL	SQL statement that encounters an exception	-	STRING	LAST
	stackTrace	Exception Stack	Exception stack information	-	CLOB	LAST
Version (version: ClickHouse package version)	version	Version	Driver package version	-	STRING	LAST
SQL monitoring (sql: APM counts call statistics by SQL.)	sql	SQL ID	Unique ID of the SQL statement, which is used for alarm configuration	-	ENUM	LAST
	concurrentMax	Max. Concurrency	Maximum concurrency of the SQL statement	-	INT	MAX
	errorCount	Errors	Number of errors that the SQL statement encounters	-	INT	SUM
	errorTraceId	Error Trace ID	ID of the trace that encounters an error in a collection period	-	STRING	LAST
	invokeCount	Calls	Number of times that the SQL statement is called	-	INT	SUM
	lastError	Error Message	SQL error information	-	STRING	LAST
	maxTime	Max. RT	Maximum response time of the SQL statement	-	INT	MAX
	readRowCount	Read Rows	Number of read rows of the SQL statement	-	INT	SUM
	runningCount	Ongoing Executions	Number of SQL statements that are being executed at the time of collection	-	INT	SUM
	slowTraceId	Slow Trace ID	ID of the slowest trace in a collection period	-	STRING	LAST
	sqlString	SQL Statement	SQL statement	-	STRING	LAST
	totalTime	Total RT	Total response time	-	INT	SUM
	updatedRowCount	Updated Rows	Number of updated rows of the SQL statement	-	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–200 ms	Number of requests with 100–200 ms response time	-	INT	SUM
	range4	200–1000 ms	Number of requests with 200–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
Summary (total: summary about SQL statement call statistics)	invokeCount	Calls	Total number of calls	-	INT	SUM
	errorCount	Errors	Total number of errors	-	INT	SUM
	readRowCount	Read Rows	Total number of read rows	-	INT	SUM
	totalTime	RT	Total response time	-	INT	SUM
	updatedRowCount	Updated Rows	Total number of updated rows	-	INT	SUM