Updated on 2024-07-04 GMT+08:00

Communication Protocol

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

Table 1 WebSocket metrics

Category

Metric

Name

Description

Unit

Data Type

Default Aggregation Mode

Exception (exception: WebSocket 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 occurred

-

STRING

LAST

stackTrace

Exception Stack

Exception stack information

-

CLOB

LAST

WebSocket message monitoring (message: WebSocket message processing information)

url

url

URL corresponding to WebSocket

-

ENUM

LAST

errorCount

Errors

Number of message processing 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 times that the message processing method is called

-

INT

SUM

traffic

Traffic

Traffic

-

INT

SUM

createSessionCount

Created Connections

Number of connections that have been created

-

INT

SUM

closeSessionCount

Closed Connections

Number of closed connections

-

INT

SUM

closeReason

Close Reason

Cause of the connection closure

-

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

WebSocket summary (total: summary statistics)

errorCount

Errors

Total number of errors

-

INT

SUM

invokeCount

Calls

Total number of calls

-

INT

SUM

createSessionCount

Created Connections

Number of connections that have been created

-

INT

SUM

closeSessionCount

Closed Connections

Number of closed connections

-

INT

SUM

traffic

Traffic

Traffic

-

INT

SUM

totalTime

Total RT

Total response time

-

INT

SUM