diff --git a/Canal-prometheus.md b/Canal-prometheus.md index 9d536aa..825e567 100644 --- a/Canal-prometheus.md +++ b/Canal-prometheus.md @@ -13,18 +13,18 @@ Canal server 性能指标监控基于prometheus的实现。 | :---- | :---- | ----: |----: | |canal_instance_traffic_delay |instance延迟 | ms | ms | |canal_instance_transactions |instance接收transactions计数|-|-| -|canal_instance_row_events |instance接收rowData类型events计数|-|-| -|canal_instance_rows_counter |instance接收events包含变更行数计数|-|-| +|canal_instance_row_events |instance接收DML的binlog类型events计数|-|-| +|canal_instance_rows_counter |instance接收DML binlog中对应的变更行数计数(一个DML binlog event会包含1条或者多条变更行, 特别针对批量insert操作等)|-|-| |canal_instance |instance基本信息|-|-| |canal_instance_subscriptions |instance订阅数量|-|-| -|canal_instance_publish_blocking_time |instance dump线程publish阻塞时间(仅parallel解析模式)|ms|ns| +|canal_instance_publish_blocking_time |instance dump线程提交到异步解析队列过程中的阻塞时间(仅parallel解析模式)|ms|ns| |canal_instance_received_binlog_bytes |instance接收binlog字节数|byte|-| |canal_instance_parser_mode |instance解析模式(是否开启parallel解析)|-|-| -|canal_instance_client_packets |instance client请求packets计数|-|-| +|canal_instance_client_packets |instance client请求次数的计数|-|-| |canal_instance_client_bytes|向instance client发送数据包字节计数|byte|-| -|canal_instance_client_empty_batches|向instance client发送的空batch计数|-|-| +|canal_instance_client_empty_batches|向instance client发送get接口的空结果计数|-|-| |canal_instance_client_request_error|instance client请求失败计数|-|-| -|canal_instance_client_request_latency |instance client请求延迟概况|-|-| +|canal_instance_client_request_latency |instance client请求的响应时间概况|-|-| |canal_instance_sink_blocking_time |instance sink线程put数据至store的阻塞时间|ms|ns| |canal_instance_store_produce_seq |instance store接收到的events sequence number|-|-| |canal_instance_store_consume_seq |instance store成功消费的events sequence number|-|-| @@ -36,17 +36,17 @@ Canal server 性能指标监控基于prometheus的实现。 | 指标 | 简述 |多指标| | :---- | :---- | :----: | |[Basic](https://github.com/alibaba/canal/wiki/Canal-prometheus#%E7%8A%B6%E6%80%81%E4%BF%A1%E6%81%AF)|Canal instance 基本信息。|是| -|[Network bandwith](https://github.com/alibaba/canal/wiki/Canal-prometheus#%E7%BD%91%E7%BB%9C%E5%B8%A6%E5%AE%BDkbs)|网络带宽。包含inbound(binlog读取)和outbound(向client输出)|是| -|[Delay](https://github.com/alibaba/canal/wiki/Canal-prometheus#delayseconds)|Canal instance 相对于master的延时。|否| +|[Network bandwith](https://github.com/alibaba/canal/wiki/Canal-prometheus#%E7%BD%91%E7%BB%9C%E5%B8%A6%E5%AE%BDkbs)|网络带宽。包含inbound(canal server读取binlog的网络带宽)和outbound(canal server返回给canal client的网络带宽)|是| +|[Delay](https://github.com/alibaba/canal/wiki/Canal-prometheus#delayseconds)|Canal instance接受到binlog的对应延迟时间。|否| |[Idle](https://github.com/alibaba/canal/wiki/Canal-prometheus#idle)|sink线程idle占比;dump线程idle占比(仅parallel mode)。|是| -|[TPS](https://github.com/alibaba/canal/wiki/Canal-prometheus#tpsbinlog-events)|Canal client instance消费binlog的TPS, 以MySQL binlog events为单位计算。|否| +|[TPS](https://github.com/alibaba/canal/wiki/Canal-prometheus#tpsbinlog-events)|Canal client instance消费所有binlog事件的TPS, 以MySQL binlog events为单位计算(包含所有binlog事件)。|否| |[TPS(transaction)](https://github.com/alibaba/canal/wiki/Canal-prometheus#tpsmysql-transaction)|Canal instance 处理binlog的TPS,以MySQL transaction为单位计算。|否| -|[TPS(rows VS rowData)](https://github.com/alibaba/canal/wiki/Canal-prometheus#tpstable-row)|Canal instance处理binlog的TPS,table rows:以table变更行为单位。row data:rowData events为单位。|是| -|[Client requests](https://github.com/alibaba/canal/wiki/Canal-prometheus#client-requests)|Canal instance接收到的请求统计,结果按packet type分类。|否| -|[Latency](https://github.com/alibaba/canal/wiki/Canal-prometheus#client-latency)|Canal client 请求latency概况。|否| -|[Empty packets](https://github.com/alibaba/canal/wiki/Canal-prometheus#empty-packets)|server响应GET请求,但返回空包的占比。|是| -|[Store remain events](https://github.com/alibaba/canal/wiki/Canal-prometheus#event-store%E5%8D%A0%E7%94%A8)|Canal instance ringbuffer内未释放的events数量。|否| -|[Store remain mem](https://github.com/alibaba/canal/wiki/Canal-prometheus#event-store-memory%E5%8D%A0%E7%94%A8kb-%E4%BB%85memory-mode)|Canal instance ringbuffer 内未释放events占用内存。|否| +|[TPS(rows VS rowData)](https://github.com/alibaba/canal/wiki/Canal-prometheus#tpstable-row)|Canal instance处理DML类型的binlog的TPS,row data:对应DML binlog事件的计数统计, table rows:对应DML变更行的计数统计 (一个DML binlog事件会包含1条或者多条变更行, 针对DML批量操作)。|是| +|[Client requests](https://github.com/alibaba/canal/wiki/Canal-prometheus#client-requests)|Canal client请求server的请求数统计,结果按请求类型分类(比如get/ack/sub等)。|否| +|[Latency](https://github.com/alibaba/canal/wiki/Canal-prometheus#client-latency)|Canal client请求server对应的响应时间(rt)统计。|否| +|[Empty packets](https://github.com/alibaba/canal/wiki/Canal-prometheus#empty-packets)|Canal client请求server返回空结果集的占比。|是| +|[Store remain events](https://github.com/alibaba/canal/wiki/Canal-prometheus#event-store%E5%8D%A0%E7%94%A8)|Canal instance ringbuffer中堆积的events数量。|否| +|[Store remain mem](https://github.com/alibaba/canal/wiki/Canal-prometheus#event-store-memory%E5%8D%A0%E7%94%A8kb-%E4%BB%85memory-mode)|Canal instance ringbuffer中堆积的events内存使用量。|否| ## JVM 相关信息 > The Java client includes collectors for garbage collection, memory pools, JMX, classloading, and thread counts. These can be added individually or just use the DefaultExports to conveniently register them.