EsRestClient Monitoring

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

Table 1 EsRestClient collection parameters

Parameter	Data Type	Application Type	Default	Supported Start Agent Version	Supported End Agent Version	Description
Index Normalization Configuration	obj_array	JAVA	-	2.0.0	-	Implement "regex" matching and normalize the URL index.

Table 2 EsRestClient metrics

Category	Metric	Name	Description	Unit	Data Type	Default Aggregation Mode
Exception (exception: exception statistics of EsRestClient calls)	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
Client information (clientInfo)	clientId	clientId	Client ID	-	ENUM	LAST
	RestClientVersion	RestClientVersion	RestClient version	-	STRING	LAST
	RestHighLevelClientVersion	RestHighLevelClientVersion	RestHighLevelClient version	-	STRING	LAST
	poolId	poolId	HttpAsyncClient Connection pool ID	-	STRING	LAST
	esNodes	esNodes	Cluster node information set on the client	-	STRING	LAST
	esDeadNodes	esDeadNodes	Disconnected node of the cluster	-	STRING	LAST
URL monitoring (esClient: APM counts URL call statistics by URL.)	clientId	clientId	RESTClient ID	-	ENUM	LAST
	url	url	Called URL	-	ENUM	LAST
	method	method	HTTP method of the URL	-	ENUM	LAST
	concurrentMax	concurrentMax	Maximum concurrency of the URL	-	INT	MAX
	errorCount	errorCount	Number of call errors of the URL	-	INT	SUM
	definitiveFailureCount	definitiveFailureCount	Number of request errors	-	INT	SUM
	errorTraceId	errorTraceId	ID of the trace that encounters an error in a collection period	-	STRING	LAST
	slowTraceId	slowTraceId	ID of the slowest trace in a collection period	-	STRING	LAST
	hostUri	hostUri	host uri	-	STRING	LAST
	invokeCount	invokeCount	Number of times that the URL is called	-	INT	SUM
	lastError	lastError	Error details	-	STRING	LAST
	maxTime	maxTime	Maximum response time of the called URL	-	INT	MAX
	totalTime	totalTime	Total response time of the called URL	-	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
	retryCount	retryCount	Request retry times	-	INT	SUM
Status code statistics (code: APM counts URL call statistics by status code.)	code	code	Status code	-	ENUM	LAST
	url	url	URL that returns the status code	-	STRING	LAST
	count	count	Number of times that the status code has occurred	-	INT	SUM
EsRestClient summary (total: summary of EsRestClient call statistics)	definitiveFailureCount	definitiveFailureCount	Total number of request errors	-	INT	SUM
	invokeCount	invokeCount	Total number of calls	-	INT	SUM
	totalTime	totalTime	Total response time	-	INT	SUM
	retryCount	retryCount	Total number of request retries	-	INT	SUM
EsRestClient node call monitoring (serverNode)	serverAddr	serverAddr	Server node information	-	ENUM	LAST
	concurrentMax	concurrentMax	Maximum concurrency	-	INT	MAX
	errorCount	errorCount	Number of errors	-	INT	SUM
	errorTraceId	errorTraceId	ID of the trace that encounters an error in a collection period	-	STRING	LAST
	slowTraceId	slowTraceId	ID of the slowest trace in a collection period	-	STRING	LAST
	invokeCount	invokeCount	Number of calls	-	INT	SUM
	lastError	lastError	Error message	-	STRING	LAST
	maxTime	maxTime	Maximum response time	-	INT	MAX
	totalTime	totalTime	Total response time	-	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
URL monitoring (invocation: APM counts URL call statistics by URL.)	url	url	Called URL	-	ENUM	LAST
	method	method	HTTP method of the URL	-	ENUM	LAST
	client	client	EsRestClient type	-	ENUM	LAST
	concurrentMax	concurrentMax	Maximum concurrency of the URL	-	INT	MAX
	errorCount	errorCount	Number of call errors of the URL	-	INT	SUM
	errorTraceId	errorTraceId	ID of the trace that encounters an error in a collection period	-	STRING	LAST
	slowTraceId	slowTraceId	ID of the slowest trace in a collection period	-	STRING	LAST
	hostUri	hostUri	Called URL address	-	STRING	LAST
	invokeCount	invokeCount	Number of times that the URL is called	-	INT	SUM
	lastError	lastError	Error details	-	STRING	LAST
	maxTime	maxTime	Maximum response time of the called URL	-	INT	MAX
	responseCloseCount	responseCloseCount	Number of closed responses when the URL is called	-	INT	SUM
	totalTime	totalTime	Total response time of the called URL	-	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
	envId	envId	Cluster ID corresponding to the called URL	-	STRING	LAST
EsRestClient cluster call (cluster)	esNodes	esNodes	Cluster node information	-	ENUM	LAST
	clientCount	clientCount	Number of RestClients that have been created	-	INT	LAST
	concurrentMax	concurrentMax	Maximum concurrency	-	INT	MAX
	errorCount	errorCount	Number of errors	-	INT	SUM
	errorTraceId	errorTraceId	ID of the trace that encounters an error in a collection period	-	STRING	LAST
	slowTraceId	slowTraceId	ID of the slowest trace in a collection period	-	STRING	LAST
	invokeCount	invokeCount	Number of calls	-	INT	SUM
	lastError	lastError	Error message	-	STRING	LAST
	maxTime	maxTime	Maximum response time	-	INT	MAX
	totalTime	totalTime	Total response time	-	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

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