masahata/kube-event-watcher

kube-event-watcher

镜像概述和主要用途

kube-event-watcher是一款Kubernetes事件监控工具，用于将集群事件实时通知到Slack和AWS CloudWatch Logs。其功能类似于Kubernetes官方文档中提到的Stackdriver事件导出器，但专门针对Slack和CloudWatch Logs场景设计，帮助用户及时掌握集群运行状态。

核心功能和特性

• 多渠道通知：支持将Kubernetes事件同时发送到Slack和CloudWatch Logs
• 事件筛选：可按命名空间、事件类型（ADDED/MODIFIED/DELETED）及字段选择器进行事件过滤
• 自定义配置：支持自定义Slack通知渠道、CloudWatch日志流及事件过滤规则
• Prometheus集成：提供事件计数指标，便于监控和告警
• Kubernetes原生集成：支持通过ServiceAccount获取集群事件，无需额外kubeconfig配置

使用场景和适用范围

• Kubernetes集群事件实时监控
• 异常事件（如Warning类型）即时通知
• 集群事件集中日志管理（CloudWatch Logs）
• 多团队/项目事件分渠道通知（Slack多频道配置）
• 事件指标收集与分析（Prometheus）

使用方法和配置说明

环境变量配置

命令行参数

-config string
    配置文件路径（默认："~/.kube-event-watcher/config.yaml"）
-notifySlack bool
    是否发送通知到Slack（默认："true"）
-cwLogging bool
    是否记录事件到CloudWatch Logs（默认："false"）
-cwLogGroup string
    CloudWatch日志组名称（默认："kube-event-watcher"）
-cwLogStream string
    CloudWatch日志流名称（默认："event"）
-listen-address string
    Prometheus指标端点地址（默认：":9297"）
-kubeconfig string
    kubeconfig文件路径（默认："~/.kube/config"）
-logtostderr bool
    是否输出日志到标准错误（默认："false"）

可通过./bin/kube-event-watcher -h查看所有参数说明。

配置文件

使用YAML格式配置事件通知规则，支持多命名空间配置。

配置示例

yaml
- namespace: "default"
  watchEvent:
    ADDED: true
    MODIFIED: true
    DELETED: false
  fieldSelectors:
    - key: "reason"
      value: "Failed"
      type: "include"
    - key: "type"
      value: "Warning"
      type: "include"
  channel: "k8s-default-warnings"
  logStream: "default-events"
- namespace: ""  # 监控所有命名空间
  watchEvent:
    ADDED: true
    MODIFIED: false
    DELETED: false
  fieldSelectors:
    - key: "type"
      value: "Normal"
      type: "include"
  channel: "k8s-all-normal"

配置项说明

• namespace: 要监控的命名空间，空字符串表示所有命名空间
• watchEvent: 事件类型开关
  • ADDED: 是否监控新增事件（true/false）
  • MODIFIED: 是否监控更新事件（true/false）
  • DELETED: 是否监控删除事件（通常设为false）
• fieldSelectors: 事件字段筛选规则（AND条件）
  • key: 筛选字段（支持字段列表见下文）
  • value: 筛选值
  • type: 筛选类型（include：包含，exclude：排除，默认include）
• channel: 覆盖默认Slack通知频道（频道不存在时使用默认频道）
• logStream: 覆盖默认CloudWatch日志流（流不存在时使用默认流）

支持的fieldSelectors字段

involvedObject.kind
involvedObject.namespace
involvedObject.name
involvedObject.uid
involvedObject.apiVersion
involvedObject.resourceVersion
involvedObject.fieldPath
reason
source
type
metadata.namespace
metadata.name

Docker部署

镜像地址：masahata/kube-event-watcher

Docker Run示例

bash
docker run -d \
  -e SLACK_TOKEN=xoxb-1234567890-abcdefghijk \
  -e SLACK_CHANNEL=k8s-events \
  -v /path/to/config.yaml:/root/.kube-event-watcher/config.yaml \
  -v /path/to/kubeconfig:/root/.kube/config \  # 可选，本地测试时使用
  masahata/kube-event-watcher \
  -config /root/.kube-event-watcher/config.yaml \
  -cwLogging true \
  -cwLogGroup k8s-events

Kubernetes部署

所需权限

需配置RBAC权限以允许访问事件资源：

yaml
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: kube-event-watcher
rules:
- apiGroups: [""]
  resources: ["events"]
  verbs: ["get", "watch", "list"]

部署示例

详见官方示例：examples/deploy.yaml

通知示例

Slack通知根据事件类型显示不同颜色：Normal类型为绿色，Warning类型为黄色。

Prometheus指标

默认指标端点：http://<pod-ip>:9297/metrics

提供指标：

• ew_event_count: 事件计数指标，包含以下标签：
  • namespace: 事件命名空间
  • event_type: 事件类型（ADDED/MODIFIED/DELETED）
  • reason: 事件原因
  • source: 事件源

CloudWatch Logs配置

所需IAM策略

json
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "logs:CreateLogGroup",
        "logs:CreateLogStream",
        "logs:PutLogEvents",
        "logs:DescribeLogStreams",
        "logs:DescribeLogGroups"
      ],
      "Resource": "*"
    }
  ]
}

通过命令行参数（-cwLogging、-cwLogGroup等）或配置文件设置CloudWatch相关参数。