lnsp/crash-informer

k8s-crash-informer

https://github.com/lnsp/k8s-crash-informer/workflows/Go/badge.svg](https://github.com/lnsp/k8s-crash-informer/actions?workflow=Go) !https://img.shields.io/docker/cloud/build/lnsp/crash-informer

镜像概述和主要用途

k8s-crash-informer是一个Kubernetes控制器，用于监控集群中资源的运行状态。当带有特定注解的Pod、Deployment或ReplicaSet进入CrashLoopBackOff（反复崩溃）状态时，该控制器会向Mattermost或Slack频道发送通知，并提供退出码、日志等详细信息，帮助用户及时发现和处理应用故障。

注意：这是作者首次尝试编写Kubernetes控制器，如有反馈请通过GitHub issue提出。

核心功能和特性

• 崩溃状态监控：实时检测Kubernetes资源的CrashLoopBackOff状态
• 多平台通知：支持向Mattermost和Slack频道发送通知
• 注解控制：通过资源注解灵活指定需要监控的目标
• 详细信息提供：通知包含退出码、日志等有助于故障排查的信息
• 可配置退避间隔：支持自定义通知退避时间（单位：秒）

使用场景和适用范围

适用于需要实时监控Kubernetes集群中应用健康状态的团队，特别是使用Mattermost或Slack进行团队协作沟通的场景。可帮助运维人员和开发人员快速响应应用崩溃问题，缩短故障排查时间。

使用方法和配置说明

步骤1：创建Informer配置 ConfigMap

根据使用的通知平台（Mattermost或Slack）创建对应的ConfigMap。

Mattermost配置

yaml
apiVersion: v1
data:
  token: <机器人令牌>
  channel: <频道名称>
  team: <团队名称>
  url: <Mattermost服务器URL>
kind: ConfigMap
metadata:
  name: mattermost-informer-cfg

参数说明：

• token：Mattermost机器人令牌（可通过机器人账户文档创建）或用户个人访问令牌（通过个人访问令牌文档获取）
• channel：接收通知的频道名称
• team：Mattermost团队名称
• url：Mattermost服务器完整URL

Slack配置

yaml
apiVersion: v1
data:
  channel: <频道名称>
  token: <你的令牌>
kind: ConfigMap
metadata:
  name: slack-informer-cfg

参数说明：

• token：Slack机器人用户OAuth访问令牌，可在Slack应用管理界面（注册新Slack API应用并启用Bot功能后）获取
• channel：接收通知的频道名称

步骤2：部署Informer

根据通知平台执行对应的部署命令：

bash
# 若使用Mattermost
kubectl apply -f manifests/mattermost-informer.yaml

# 若使用Slack
kubectl apply -f manifests/slack-informer.yaml

注意：可根据需求修改部署文件中的namespace引用，Informer默认仅监控指定命名空间的资源。

步骤3：为资源添加注解

要开始监控Pod、Deployment或ReplicaSet，只需在资源的spec中添加以下注解：

yaml
annotations:
  espe.tech/crash-informer: "true"

可选配置：通过espe.tech/informer-backoff注解设置通知退避间隔（单位：秒）：

yaml
annotations:
  espe.tech/crash-informer: "true"
  espe.tech/informer-backoff: "300"  # 退避间隔300秒

步骤4：接收通知

配置完成后，当监控的资源进入CrashLoopBackOff状态时，指定的Mattermost或Slack频道将收到包含详细信息的通知。

!Mattermost通知示例