Skip to content

Commit

Permalink
Add RDAM metrics
Browse files Browse the repository at this point in the history 
Signed-off-by: lou-lan <[email protected]>
  • Loading branch information
@lou-lan
lou-lan committed Oct 30, 2024
1 parent 0a14405 commit 34db29e
Show file tree
Hide file tree
Showing 21 changed files with 2,538 additions and 189 deletions.
1 change: 1 addition & 0 deletions charts/spiderpool/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,7 @@ helm install spiderpool spiderpool/spiderpool --wait --namespace kube-system \
| `spiderpoolAgent.healthChecking.readinessProbe.failureThreshold` | the failure threshold of startup probe for spiderpoolAgent health checking | `3` |
| `spiderpoolAgent.healthChecking.readinessProbe.periodSeconds` | the period seconds of startup probe for spiderpoolAgent health checking | `10` |
| `spiderpoolAgent.prometheus.enabled` | enable spiderpool agent to collect metrics | `false` |
| `spiderpoolAgent.prometheus.enabledRdmaMetric` | enable spiderpool agent to collect RDMA metrics | `false` |
| `spiderpoolAgent.prometheus.enabledDebugMetric` | enable spiderpool agent to collect debug level metrics | `false` |
| `spiderpoolAgent.prometheus.port` | the metrics port of spiderpool agent | `5711` |
| `spiderpoolAgent.prometheus.serviceMonitor.install` | install serviceMonitor for spiderpool agent. This requires the prometheus CRDs to be available | `false` |
Expand Down
337 changes: 173 additions & 164 deletions charts/spiderpool/templates/daemonset.yaml
View file

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions charts/spiderpool/values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -468,6 +468,9 @@ spiderpoolAgent:
## @param spiderpoolAgent.prometheus.enabled enable spiderpool agent to collect metrics
enabled: false

## @param spiderpoolAgent.prometheus.enabledRdmaMetric enable spiderpool agent to collect RDMA metrics
enabledRdmaMetric: false

## @param spiderpoolAgent.prometheus.enabledDebugMetric enable spiderpool agent to collect debug level metrics
enabledDebugMetric: false

Expand Down
2 changes: 2 additions & 0 deletions cmd/spiderpool-agent/cmd/config.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ var envInfo = []envConf{

{"SPIDERPOOL_LOG_LEVEL", logutils.LogInfoLevelStr, true, &agentContext.Cfg.LogLevel, nil, nil},
{"SPIDERPOOL_ENABLED_METRIC", "false", false, nil, &agentContext.Cfg.EnableMetric, nil},
{"SPIDERPOOL_ENABLED_RDMA_METRIC", "false", false, nil, &agentContext.Cfg.EnableRDMAMetric, nil},
{"SPIDERPOOL_ENABLED_DEBUG_METRIC", "false", false, nil, &agentContext.Cfg.EnableDebugLevelMetric, nil},
{"SPIDERPOOL_POD_NAMESPACE", "", true, &agentContext.Cfg.AgentPodNamespace, nil, nil},
{"SPIDERPOOL_POD_NAME", "", true, &agentContext.Cfg.AgentPodName, nil, nil},
Expand All @@ -78,6 +79,7 @@ type Config struct {
// env
LogLevel string
EnableMetric bool
EnableRDMAMetric bool
EnableDebugLevelMetric bool
AgentPodNamespace string
AgentPodName string
Expand Down
6 changes: 3 additions & 3 deletions cmd/spiderpool-agent/cmd/daemon.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -140,16 +140,16 @@ func DaemonMain() {
logger.Fatal(err.Error())
}

logger.Info("Begin to initialize spiderpool-agent metrics HTTP server")
initAgentMetricsServer(agentContext.InnerCtx)

logger.Info("Begin to initialize spiderpool-agent runtime manager")
mgr, err := newCRDManager()
if nil != err {
logger.Fatal(err.Error())
}
agentContext.CRDManager = mgr

logger.Info("Begin to initialize spiderpool-agent metrics HTTP server")
initAgentMetricsServer(agentContext.InnerCtx)

// init managers...
initAgentServiceManagers(agentContext.InnerCtx)

Expand Down
9 changes: 6 additions & 3 deletions cmd/spiderpool-agent/cmd/metrics_server.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,16 @@ import (

// initAgentMetricsServer will start an opentelemetry http server for spiderpool agent.
func initAgentMetricsServer(ctx context.Context) {
metricController, err := metric.InitMetric(ctx, constant.SpiderpoolAgent,
agentContext.Cfg.EnableMetric, agentContext.Cfg.EnableDebugLevelMetric)
metricController, err := metric.InitMetric(ctx,
constant.SpiderpoolAgent,
agentContext.Cfg.EnableMetric,
agentContext.Cfg.EnableDebugLevelMetric,
)
if nil != err {
logger.Fatal(err.Error())
}

err = metric.InitSpiderpoolAgentMetrics(ctx)
err = metric.InitSpiderpoolAgentMetrics(ctx, agentContext.Cfg.EnableRDMAMetric, agentContext.CRDManager.GetClient())
if nil != err {
logger.Fatal(err.Error())
}
Expand Down
1 change: 1 addition & 0 deletions docs/mkdocs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ nav:
- Access Service for Underlay CNI: usage/underlay_cni_service.md
- Bandwidth Manage for IPVlan CNI: usage/ipvlan_bandwidth.md
- Kubevirt: usage/kubevirt.md
- Enable RDMA metrics: usage/rdma-metrics.md
- FAQ: usage/faq.md
- Reference:
- Annotations: reference/annotation.md
Expand Down
81 changes: 81 additions & 0 deletions docs/usage/rdma-metrics-zh-CN.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# RDMA 指标

RDMA 是一种高效的网络通信技术，允许一台计算机直接访问另一台计算机的内存，无需操作系统介入，从而减少延迟，提高数据传输速度和效率。RDMA 支持高速数据传输，减少 CPU 负载，非常适用于需要高速网络通信的场景。

在 Kubernetes 集群中，spiderpool CNI 支持 RoCE 和 IB 2 种 RDMA 场景，Pod 可以通过共享和独占的方式使用 RDMA 网卡，用户可以根据需求选择合适的方式来使用 RDMA 网卡。

spiderpool 同时提供了 RDMA exporter 功能和 grafana 监控面板，通过实时监控 Pod/Node RDMA 网络的性能，包括吞吐量、延迟、丢包率等，可以时发现问题并采取措施解决，提高网络的可靠性和性能。

## RDMA 指标的常见场景

1. **性能监控**:
- **吞吐量**: 测量通过网络传输的数据量。
- **延迟**: 测量数据从源到目的地的传输时间。
- **丢包率**: 监控传输过程中丢失的数据包数量。

2. **错误检测**:
- **传输错误**: 检测数据传输中的错误。
- **连接失败**: 监控失败的连接尝试和断开连接。

3. **网络健康状况**:
- **拥塞**: 检测网络拥塞和瓶颈。

## 如何开启

```shell
helm upgrade spiderpool spiderpool/spiderpool --reuse-values --wait --namespace kube-system \
--set spiderpoolAgent.prometheus.enabled \
--set spiderpoolAgent.prometheus.enabledRdmaMetric=true
```

- 通过设置 `--reuse-values` 重用现有的配置
- 通过设置 `--wait` 等待所有 Pod 运行
- 通过设置 `--namespace` 指定 Helm 安装的命名空间
- 通过设置 `--set spiderpoolAgent.prometheus.enabled` 启用 Prometheus 监控
- 通过设置 `spiderpoolAgent.prometheus.enabledRdmaMetric=true`，可以启用 RDMA 指标 exporter


## 指标列表

以下是经过整理后的表格，包含了"指标名称"、"指标类型"、"指标含义"和"备注"四列：

| 指标名称 | 指标类型 | 指标含义 | 备注 |
|---------------------------------|------|---------------------------------------------|----|
| rx_write_requests | 数量 | 接收到的写请求的数量 | |
| rx_read_requests | 数量 | 接收到的读请求的数量 | |
| rx_atomic_requests | 数量 | 接收到的原子请求的数量 | |
| rx_dct_connect | 数量 | 接收到的 DCT 连接请求的数量 | |
| out_of_buffer | 数量 | 缓冲区不足错误的数量 | |
| out_of_sequence | 数量 | 收到的乱序包数量 | |
| duplicate_request | 数量 | 重复请求的数量 | |
| rnr_nak_retry_err | 数量 | 收到的 RNR NAK 包未超过 QP 重试限制的数量 | |
| packet_seq_err | 数量 | 包序列错误的数量 | |
| implied_nak_seq_err | 数量 | 隐含 NAK 序列错误的数量 | |
| local_ack_timeout_err | 数量 | 发送端 QP 的 ack 计时器过期的次数（适用于 RC, XRC, DCT QPs） | |
| resp_local_length_error | 数量 | 响应者检测到本地长度错误的次数 | |
| resp_cqe_error | 数量 | 响应 CQE 错误的数量 | |
| req_cqe_error | 数量 | 请求者检测到 CQE 完成且带错误的次数 | |
| req_remote_invalid_request | 数量 | 请求者检测到远程无效请求错误的次数 | |
| req_remote_access_errors | 数量 | 请求的远程访问错误的数量 | |
| resp_remote_access_errors | 数量 | 响应的远程访问错误的数量 | |
| resp_cqe_flush_error | 数量 | 响应 CQE 刷新错误的数量 | |
| req_cqe_flush_error | 数量 | 请求 CQE 刷新错误的数量 | |
| roce_adp_retrans | 数量 | RoCE 自适应重传的次数 | |
| roce_adp_retrans_to | 数量 | RoCE 自适应重传超时的次数 | |
| roce_slow_restart | 数量 | RoCE 缓慢重启的次数 | |
| roce_slow_restart_cnps | 数量 | RoCE 缓慢重启产生的CNP包数 | |
| roce_slow_restart_trans | 数量 | RoCE 缓慢重启状态转换为缓慢重启的次数 | |
| rp_cnp_ignored | 数量 | Reaction Point HCA 接收到并忽略的 CNP 包数量 | |
| rp_cnp_handled | 数量 | Reaction Point HCA 处理以降低传输速率的 CNP 包数量 | |
| np_ecn_marked_roce_packets | 数量 | 进入 Pod/Node 的方向收到的 ECN，表示路径拥塞 | |
| np_cnp_sent | 数量 | 通知点在 RoCEv2 IP 头部注意到拥塞体验时发送的 CNP 包数 | |
| rx_icrc_encapsulated | 数量 | 具有 ICRC 错误的 RoCE 包数量 | |
| rx_vport_rdma_unicast_packets | 数量 | 单播 RDMA 包数量 | |
| tx_vport_rdma_unicast_packets | 数量 | 发送的单播 RDMA 包数量 | |
| rx_vport_rdma_multicast_packets | 数量 | 接收到的多播 RDMA 包数量 | |
| tx_vport_rdma_multicast_packets | 数量 | 发送的多播 RDMA 包数量 | |
| rx_vport_rdma_unicast_bytes | 数量 | 接收到的单播 RDMA 包的字节数 | |
| tx_vport_rdma_unicast_bytes | 数量 | 发送的单播 RDMA 包的字节数 | |
| rx_vport_rdma_multicast_bytes | 数量 | 接收到的多播 RDMA 包的字节数 | |
| tx_vport_rdma_multicast_bytes | 数量 | 发送的多播 RDMA 包的字节数 | |
| vport_speed_mbps | 速度 | 端口的速度，以兆位每秒（Mbps）表示 | |
Loading

0 comments on commit 34db29e

Please sign in to comment.