From 8be0c83742272d5bda49acfd476a30c702f04e96 Mon Sep 17 00:00:00 2001 From: luzhihao Date: Sat, 26 Aug 2023 16:17:29 +0800 Subject: [PATCH] update endpoint docs --- gopher_tech.md | 44 ++++++++++++++++++++++------------------- gopher_tech_abnormal.md | 19 ++++++++---------- 2 files changed, 32 insertions(+), 31 deletions(-) diff --git a/gopher_tech.md b/gopher_tech.md index 5917e15..7a5eb0d 100644 --- a/gopher_tech.md +++ b/gopher_tech.md @@ -275,19 +275,21 @@ | metrics_name | table_name | metrics_type | unit | metrics description | | ------------------- | ------------ | ------------ | ---- | ------------------------------------------------------------ | | tgid | endpoint_tcp | key | | 进程ID | +| role | endpoint_tcp | key | | 客户端（0）/服务端（1） | | client_ip | endpoint_tcp | key | | 客户端：本地IP；服务端：对端IP | | server_ip | endpoint_tcp | key | | 客户端：对端IP；服务端：本地IP
备注：K8S场景支持Cluster IP转换成Backend IP | | server_port | endpoint_tcp | key | | 客户端：对端端口；服务端：本地端口
备注：K8S场景支持Cluster Port转换成Backend Port | | protocol | endpoint_tcp | key | | 协议族（IPv4、IPv6） | -| listendrop | endpoint_tcp | Gauge | | TCP accept丢弃次数（只有listen对象存在） | +| listendrop | endpoint_tcp | Gauge | | TCP accept丢弃次数 | | accept_overflow | endpoint_tcp | Gauge | | TCP accept队列溢出次数 | | syn_overflow | endpoint_tcp | Gauge | | TCP syn队列溢出次数 | -| passive_open | endpoint_tcp | Gauge | | tcp被动发起的建链次数（只有listen对象存在） | -| passive_open_failed | endpoint_tcp | Gauge | | tcp被动发起的建链失败次数（只有listen对象存在） | -| retran_synacks | endpoint_tcp | Gauge | | tcp synack重传报文数 | +| passive_open | endpoint_tcp | Gauge | | TCP被动发起的建链次数 | +| passive_open_failed | endpoint_tcp | Gauge | | TCP被动发起的建链失败次数 | +| retran_synacks | endpoint_tcp | Gauge | | TCP synack重传报文数 | | lost_synacks | endpoint_tcp | Gauge | | TCP synack报文丢失导致的建链失败次数 | -| active_open | endpoint_tcp | Gauge | | tcp主动发起的建链次数（只有connect对象存在） | -| active_open_failed | endpoint_tcp | Gauge | | tcp主动发起的建链失败次数（只有connect对象存在） | +| req_drops | endpoint_tcp | Gauge | | TCP request丢弃次数（因为服务端listen关闭） | +| active_open | endpoint_tcp | Gauge | | TCP主动发起的建链次数 | +| active_open_failed | endpoint_tcp | Gauge | | TCP主动发起的建链失败次数 | @@ -650,21 +652,21 @@ | metrics_name | table_name | metrics_type | unit | metrics description | | ------------------- | ------------ | ------------ | ---- | ------------------------------------------------------------ | | tgid | endpoint_tcp | key | | 进程ID | +| role | endpoint_tcp | key | | 客户端（0）/服务端（1） | | client_ip | endpoint_tcp | key | | 客户端：本地IP；服务端：对端IP | | server_ip | endpoint_tcp | key | | 客户端：对端IP；服务端：本地IP
备注：K8S场景支持Cluster IP转换成Backend IP | | server_port | endpoint_tcp | key | | 客户端：对端端口；服务端：本地端口
备注：K8S场景支持Cluster Port转换成Backend Port | | protocol | endpoint_tcp | key | | 协议族（IPv4、IPv6） | -| listendrop | endpoint_tcp | Gauge | | TCP accept丢弃次数（只有listen对象存在） | +| listendrop | endpoint_tcp | Gauge | | TCP accept丢弃次数 | | accept_overflow | endpoint_tcp | Gauge | | TCP accept队列溢出次数 | | syn_overflow | endpoint_tcp | Gauge | | TCP syn队列溢出次数 | -| passive_open | endpoint_tcp | Gauge | | tcp被动发起的建链次数（只有listen对象存在） | -| passive_open_failed | endpoint_tcp | Gauge | | tcp被动发起的建链失败次数（只有listen对象存在） | -| retran_synacks | endpoint_tcp | Gauge | | tcp synack重传报文数 | +| passive_open | endpoint_tcp | Gauge | | TCP被动发起的建链次数 | +| passive_open_failed | endpoint_tcp | Gauge | | TCP被动发起的建链失败次数 | +| retran_synacks | endpoint_tcp | Gauge | | TCP synack重传报文数 | | lost_synacks | endpoint_tcp | Gauge | | TCP synack报文丢失导致的建链失败次数 | -| active_open | endpoint_tcp | Gauge | | tcp主动发起的建链次数（只有connect对象存在） | -| active_open_failed | endpoint_tcp | Gauge | | tcp主动发起的建链失败次数（只有connect对象存在） | - - +| req_drops | endpoint_tcp | Gauge | | TCP request丢弃次数（因为服务端listen关闭） | +| active_open | endpoint_tcp | Gauge | | TCP主动发起的建链次数 | +| active_open_failed | endpoint_tcp | Gauge | | TCP主动发起的建链失败次数 | 实体名：endpoint_udp @@ -790,19 +792,21 @@ | metrics_name | table_name | metrics_type | unit | metrics description | | ------------------- | ------------ | ------------ | ---- | ------------------------------------------------------------ | | tgid | endpoint_tcp | key | | 进程ID | +| role | endpoint_tcp | key | | 客户端（0）/服务端（1） | | client_ip | endpoint_tcp | key | | 客户端：本地IP；服务端：对端IP | | server_ip | endpoint_tcp | key | | 客户端：对端IP；服务端：本地IP
备注：K8S场景支持Cluster IP转换成Backend IP | | server_port | endpoint_tcp | key | | 客户端：对端端口；服务端：本地端口
备注：K8S场景支持Cluster Port转换成Backend Port | | protocol | endpoint_tcp | key | | 协议族（IPv4、IPv6） | -| listendrop | endpoint_tcp | Gauge | | TCP accept丢弃次数（只有listen对象存在） | +| listendrop | endpoint_tcp | Gauge | | TCP accept丢弃次数 | | accept_overflow | endpoint_tcp | Gauge | | TCP accept队列溢出次数 | | syn_overflow | endpoint_tcp | Gauge | | TCP syn队列溢出次数 | -| passive_open | endpoint_tcp | Gauge | | tcp被动发起的建链次数（只有listen对象存在） | -| passive_open_failed | endpoint_tcp | Gauge | | tcp被动发起的建链失败次数（只有listen对象存在） | -| retran_synacks | endpoint_tcp | Gauge | | tcp synack重传报文数 | +| passive_open | endpoint_tcp | Gauge | | TCP被动发起的建链次数 | +| passive_open_failed | endpoint_tcp | Gauge | | TCP被动发起的建链失败次数 | +| retran_synacks | endpoint_tcp | Gauge | | TCP synack重传报文数 | | lost_synacks | endpoint_tcp | Gauge | | TCP synack报文丢失导致的建链失败次数 | -| active_open | endpoint_tcp | Gauge | | tcp主动发起的建链次数（只有connect对象存在） | -| active_open_failed | endpoint_tcp | Gauge | | tcp主动发起的建链失败次数（只有connect对象存在） | +| req_drops | endpoint_tcp | Gauge | | TCP request丢弃次数（因为服务端listen关闭） | +| active_open | endpoint_tcp | Gauge | | TCP主动发起的建链次数 | +| active_open_failed | endpoint_tcp | Gauge | | TCP主动发起的建链失败次数 | 实体名：endpoint_udp diff --git a/gopher_tech_abnormal.md b/gopher_tech_abnormal.md index 8e3bf90..4a3f6e3 100644 --- a/gopher_tech_abnormal.md +++ b/gopher_tech_abnormal.md @@ -202,17 +202,14 @@ gala-gopher如何开启异常事件 ### ENDPOINT -| 异常事件名 | 事件信息 | 输出参数 | 输入参数 | 异常等级 | -| ------------------- | --------------------------------------------------------- | ------------------ | -------- | -------- | -| listendrop | TCP listen drops(%lu). | P1: drops count | NA | WARN | -| accept_overflow | TCP accept queue overflow(%lu). | P1: overflow count | NA | WARN | -| syn_overflow | TCP syn queue overflow(%lu). | P1: overflow count | NA | WARN | -| passive_open_failed | TCP passive open failed(%lu). | P1: failed count | NA | WARN | -| active_open_failed | TCP active open failed(%lu). | P1: failed count | NA | WARN | -| bind_rcv_drops | UDP(S) queue drops(%lu). | P1: drops count | NA | WARN | -| udp_rcv_drops | UDP(C) queue drops(%lu). | P1: drops count | NA | WARN | -| lost_synacks | TCP connection setup failure due to loss of SYN/ACK(%lu). | P1: failed count | NA | WARN | -| retran_synacks | TCP SYN/ACK retransmission occurs.(%lu). | P1: failed count | NA | WARN | +| 异常事件名 | 事件信息 | 输出参数 | 输入参数 | 异常等级 | +| --------------- | --------------------------------------------------------- | ------------------ | -------- | -------- | +| listendrop | TCP listen drops(%lu). | P1: drops count | NA | WARN | +| accept_overflow | TCP accept queue overflow(%lu). | P1: overflow count | NA | WARN | +| syn_overflow | TCP syn queue overflow(%lu). | P1: overflow count | NA | WARN | +| lost_synacks | TCP connection setup failure due to loss of SYN/ACK(%lu). | P1: failed count | NA | WARN | +| retran_synacks | TCP SYN/ACK retransmission occurs.(%lu). | P1: failed count | NA | WARN | +| req_drops | TCP request drops(listen closed).(%llu). | P1: failed count | NA | WARN | #### 输出格式 -- Gitee