EsRestClient Monitoring
This section describes the types, names, and meanings of EsRestClient metrics collected by APM.
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. |
Category | Metric | Name | Description | Unit | Data Type | Default Aggregation Mode |
|---|---|---|---|---|---|---|
Exception (exception: exception statistics of EsRestClient calls) | 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 occurred | - | STRING | LAST | |
stackTrace | Exception Stack | Exception stack information | - | CLOB | LAST | |
Client information (clientInfo) | clientId | Client ID | Client ID | - | ENUM | LAST |
RestClientVersion | RestClient Version | RestClient version | - | STRING | LAST | |
RestHighLevelClientVersion | RestHighLevelClient Version | RestHighLevelClient version | - | STRING | LAST | |
poolId | HttpAsyncClient Connection Pool ID | HttpAsyncClient Connection pool ID | - | STRING | LAST | |
esNodes | Cluster Node Information Set on Client | Cluster node information set on the client | - | STRING | LAST | |
esDeadNodes | Disconnected Node | 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 | HTTP Method | HTTP method of the URL | - | ENUM | LAST | |
concurrentMax | Max. Concurrency | Maximum concurrency of the URL | - | INT | MAX | |
errorCount | Errors | Number of call errors of the URL | - | INT | SUM | |
definitiveFailureCount | Request Errors | Number of request errors | - | INT | SUM | |
errorTraceId | Error Trace ID | ID of the trace that encounters an error in a collection period | - | STRING | LAST | |
slowTraceId | Slow Trace ID | ID of the slowest trace in a collection period | - | STRING | LAST | |
hostUri | hostUri | host uri | - | STRING | LAST | |
invokeCount | Calls | Number of times that the URL is called | - | INT | SUM | |
lastError | Error Message | Error details | - | STRING | LAST | |
maxTime | Max. RT | Maximum response time of the called URL | - | INT | MAX | |
totalTime | Total RT | Total response time of the called URL | - | 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 | |
retryCount | Retries | Request retry times | - | INT | SUM | |
Status code statistics (code: APM counts URL call statistics by status code.) | code | Status 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 | Total Request Errors | Total number of request errors | - | INT | SUM |
invokeCount | Calls | Total number of calls | - | INT | SUM | |
totalTime | Total RT | Total response time | - | INT | SUM | |
retryCount | Total Request Retries | Total number of request retries | - | INT | SUM | |
EsRestClient node call monitoring (serverNode) | serverAddr | Server Node | Server node information | - | ENUM | LAST |
concurrentMax | Max. Concurrency | Maximum concurrency | - | INT | MAX | |
errorCount | Errors | Number of errors | - | INT | SUM | |
errorTraceId | Error Trace ID | ID of the trace that encounters an error in a collection period | - | STRING | LAST | |
slowTraceId | Slow Trace ID | ID of the slowest trace in a collection period | - | STRING | LAST | |
invokeCount | Calls | Number of calls | - | INT | SUM | |
lastError | Error Message | Error message | - | STRING | LAST | |
maxTime | Max. RT | Maximum response time | - | INT | MAX | |
totalTime | Total RT | Total 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 | |
URL monitoring (invocation: APM counts URL call statistics by URL.) | url | URL | Called URL | - | ENUM | LAST |
method | HTTP Method | HTTP method of the URL | - | ENUM | LAST | |
client | Client Type | EsRestClient type | - | ENUM | LAST | |
concurrentMax | Max. Concurrency | Maximum concurrency of the URL | - | INT | MAX | |
errorCount | Errors | Number of call errors of the URL | - | INT | SUM | |
errorTraceId | Error Trace ID | ID of the trace that encounters an error in a collection period | - | STRING | LAST | |
slowTraceId | Slow Trace ID | ID of the slowest trace in a collection period | - | STRING | LAST | |
hostUri | Call Address | Called URL address | - | STRING | LAST | |
invokeCount | Calls | Number of times that the URL is called | - | INT | SUM | |
lastError | Error Message | Error details | - | STRING | LAST | |
maxTime | Max. RT | Maximum response time of the called URL | - | INT | MAX | |
responseCloseCount | responseCloseCount | Number of closed responses when the URL is called | - | INT | SUM | |
totalTime | Total RT | Total response time of the called URL | - | 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 | |
envId | Cluster ID | Cluster ID corresponding to the called URL | - | STRING | LAST | |
EsRestClient cluster call (cluster) | esNodes | Cluster Node | Cluster node information | - | ENUM | LAST |
clientCount | Created RestClients | Number of RestClients that have been created | - | INT | LAST | |
concurrentMax | Max. Concurrency | Maximum concurrency | - | INT | MAX | |
errorCount | Errors | Number of errors | - | INT | SUM | |
errorTraceId | Error Trace ID | ID of the trace that encounters an error in a collection period | - | STRING | LAST | |
slowTraceId | Slow Trace ID | ID of the slowest trace in a collection period | - | STRING | LAST | |
invokeCount | Calls | Number of calls | - | INT | SUM | |
lastError | Error Message | Error message | - | STRING | LAST | |
maxTime | Max. RT | Maximum response time | - | INT | MAX | |
totalTime | Total RT | Total 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 |