dolphin

插件简介

dolphin是一款容器网络流量监控管理插件，当前版本可支持CCE Turbo集群安全容器和普通容器的流量统计。

当前支持流量统计信息IPv4发送公网报文数和字节数、IPv4接收报文数和字节数以及IPv4发送报文数和字节数，且支持通过PodSelector来对监控后端作选择，支持多监控任务、可选监控指标，且支持用户获取Pod的label标签信息。监控信息已适配Prometheus格式，可以通过调用Prometheus接口查看监控数据。

使用约束

• 仅支持在v1.19及以上版本的CCE Turbo集群中安装此插件，插件实例仅支持部署在操作系统为EulerOS的节点上，且不支持部署在ARM节点上。
• 支持节点使用Containerd或Docker容器引擎。其中Containerd节点可实时跟踪Pod更新，Docker节点以轮询方式查询，非实时更新。
• 仅支持统计CCE Turbo集群安全容器（容器运行时为kata）以及普通容器（容器运行时为runc）的流量。
• 安装插件后默认将不进行流量监控，用户需通过创建CR来配置监控任务进行流量监控。
• 安装时请确保节点有足够的资源安装本插件。
• 监控标签及用户标签的来源必须为新创建Pod时就具有的。

安装插件

1. 登录CCE控制台，单击CCE Turbo集群名称进入集群，单击左侧导航栏的“插件管理”，在右侧找到dolphin，单击“安装”。
2. 在安装插件页面，查看插件配置。

   当前该插件无可配置参数。

3. 单击“安装”。

   待插件安装完成后，选择对应的集群，然后单击左侧导航栏的“插件管理”，可在“已安装插件”页签中查看相应的插件。

组件说明

下发监控任务

当前用户可通过创建CR的方式下发监控任务，当前用户可以通过API或登录工作节点kubectl apply的方式创建CR，后续将支持前端界面的创建。一个CR代表着一个监控任务，提供selector、podLabel、ip4Tx等可选参数，具体参考以下CR的创建模板：

apiVersion: crd.dolphin.io/v1
kind: MonitorPolicy
metadata:
  name: example-task            #监控任务名
  namespace: kube-system        #必填，namespace必须为kube-system
spec:
  selector:                     #选填，配置dolphin插件监控的后端，形如labelSelector格式，默认将监控本节点所有容器
    matchLabels:
      app: nginx
    matchExpressions:
      - key: app
        operator: In
        values:
          - nginx
  podLabel: [app]               #选填，用户标签
  ip4Tx:                        #选填，ipv4发送报文数和发送字节数这两个指标的开关，默认不开
    enable: true
  ip4Rx:                        #选填，ipv4接收报文数和接收字节数这两个指标的开关，默认不开
    enable: true
  ip4TxInternet:                #选填，ipv4发送公网报文数和发送公网字节数这两个指标的开关，默认不开
    enable: true

用户标签PodLable：可输入多个Pod的label标签，以逗号分隔，如[app, version]。

标签需符合以下规则，对应正则表达式为(^[a-zA-Z_]$)|(^([a-zA-Z][a-zA-Z0-9_]|_[a-zA-Z0-9])([a-zA-Z0-9_]){0,254}$)：

• 支持输入最多5个标签，单个标签长度最长256个字符。
• 不能以数字和双下划线__开头。
• 单个标签格式需符合A-Za-z_0-9。

apiVersion: crd.dolphin.io/v1
kind: MonitorPolicy
metadata:
  name: example-task  
  namespace: kube-system        
spec:
  podLabel: [app]
  ip4Tx:
    enable: true

上述监控任务名为example-task，将监控节点上所有Pod，生成ipv4发送报文数和发送字节数这两个指标，若监控的容器携带app这个标签，将在监控指标上携带对应label的key-value信息，否则对应label的value为“not found”。

apiVersion: crd.dolphin.io/v1
kind: MonitorPolicy
metadata:
  name: example-task
  namespace: kube-system
spec:
  selector:
    matchLabels:
      app: nginx
  podLabel: [test, app]
  ip4Tx:
    enable: true
  ip4Rx:
    enable: true
  ip4TxInternet:      
    enable: true

上述监控任务名为example-task，将监控节点上满足app=nginx的labelselector的所有Pod，生成全部六个指标，若监控的容器携带test及app这两个标签，将在监控指标上携带对应label的key-value信息，否则对应label的value为“not found”。

用户可以按照上述格式对监控任务进行创建、修改、及删除，当前仅支持最多10个监控任务的创建，且多个监控任务匹配到同一个监控后端时，每一个监控后端将会产生监控任务数量的监控指标。

• 修改或删除监控任务，都将导致丢失原有监控任务所采集的监控数据，请谨慎操作。
• 用户卸载插件后，用户之前配置的监控任务CR将随着插件卸载一并销毁。

查看流量统计

dolphin插件的监控信息以普罗米修斯exporter格式输出，有两种方式获取dolphin插件的监控信息：

• 安装prometheus插件，prometheus插件会自动对接dolphin插件并周期性采集监控信息。
• 直接访问dolphin插件提供的服务端口10001，形如http://{POD_IP}:10001/metrics

注意，如果在节点上访问dolphin服务端口，需要放通节点和Pod的安全组限制。

您可以通过安装Prometheus插件查看监控信息，Prometheus插件的使用方法请参见使用Prometheus监控自定义指标。

• 示例1（ipv4发送公网报文数）：

  dolphin_ip4_send_pkt_internet{app="nginx",pod="default/nginx-66c9c65dbf-zjg24",task="kube-system/example-task "} 241

  如上示例中，Pod所在命名空间为default，Pod名称为nginx-66c9c65dbf-zjg24，用户指定label为app，其值对应为nginx，该监控指标由名称为example-task的监控任务创建，该Pod的发送公网报文数为241。

• 示例2（ipv4发送公网字节数）：

  dolphin_ip4_send_byte_internet{app="nginx",pod="default/nginx-66c9c65dbf-zjg24",task="kube-system/example-task" } 23618

  如上示例中，Pod所在命名空间为default，Pod名称为nginx-66c9c65dbf-zjg24，用户指定label为app，其值对应为nginx，该监控指标由名称为example-task的监控任务创建，该Pod的发送公网字节数为23618。

• 示例3（ipv4发送报文数）：

  dolphin_ip4_send_pkt{app="nginx",pod="default/nginx-66c9c65dbf-zjg24",task="kube-system/example-task "} 379

  如上示例中，Pod所在命名空间为default，Pod名称为nginx-66c9c65dbf-zjg24，用户指定label为app，其值对应为nginx，该监控指标由名称为example-task的监控任务创建，该Pod的发送报文数为379。

• 示例4（ipv4发送字节数）：

  dolphin_ip4_send_byte{app="nginx",pod="default/nginx-66c9c65dbf-zjg24",task="kube-system/example-task "} 33129

  如上示例中，Pod所在命名空间为default，Pod名称为nginx-66c9c65dbf-zjg24，用户指定label为app，其值对应为nginx，该监控指标由名称为example-task的监控任务创建，该Pod的发送字节数为33129。

• 示例5（ipv4接收报文数）：

  dolphin_ip4_rcv_pkt{app="nginx",pod="default/nginx-66c9c65dbf-zjg24",task="kube-system/example-task "} 464

  如上示例中，Pod所在命名空间为default，Pod名称为nginx-66c9c65dbf-zjg24，用户指定label为app，其值对应为nginx，该监控指标由名称为example-task的监控任务创建，该Pod的接收报文数为464。

• 示例6（ipv4接收字节数）：

  dolphin_ip4_rcv_byte{app="nginx",pod="default/nginx-66c9c65dbf-zjg24",task="kube-system/example-task "} 34654

  如上示例中，Pod所在命名空间为default，Pod名称为nginx-66c9c65dbf-zjg24，用户指定label为app，其值对应为nginx，该监控指标由名称为example-task的监控任务创建，该Pod的接收字节数为34654。

若容器无用户指定的标签，返回体中标签值为not found。形如：

dolphin_ip4_send_byte_internet{test="not found", pod="default/nginx-66c9c65dbf-zjg24",task="default" } 23618