similarweb/statusbay

StatusBay

镜像概述

StatusBay是一款开源工具，旨在解决K8S部署过程中的可见性缺失问题。它通过订阅K8S集群事件流，收集部署相关事件并提供逐步的细节视图，帮助团队简化故障排查、增强变更信心。工具支持动态扩展，可集成多种指标提供商监控部署质量，同时提供API与UI访问数据。

核心功能

• 实时监控K8S部署的每一步骤
• 自动发送Slack部署进度报告
• 开箱即用的质量度量集成
• 通过Helm快速在K8S上部署
• 高度可扩展的架构设计
• 简化K8S环境下的故障排查流程

使用场景

1. K8S部署监控：跟踪应用部署的全生命周期状态，及时发现失败或超时问题。
2. 多集群管理：对多个K8S集群进行集中监控，获取统一的部署视图。
3. 团队协作：通过Slack等渠道向相关人员推送部署结果，提升协作效率。
4. 质量分析：集成外部指标工具，持续度量部署质量与稳定性。
5. 日志与指标集成：将工具日志发送至集中式系统，或通过遥测指标监控运行状态。

配置说明

快速部署

1. Helm安装（推荐）：
   参考https://github.com/similarweb/statusbay-helm%E8%BF%9B%E8%A1%8C%E9%83%A8%E7%BD%B2%EF%BC%9A

   bash
   helm repo add statusbay https://similarweb.github.io/statusbay-helm
   helm install statusbay statusbay/statusbay
   

2. 应用配置：为K8S部署添加注释以启用功能，示例：

   yaml
   metadata:
     annotations:
       statusbay.io/notifications: "slack"  # 启用Slack通知
       statusbay.io/slack-channels: "#deployment-alerts"  # 指定通知频道
   

   更多配置见https://github.com/similarweb/statusbay/blob/master/docs/how-to-use.md%E3%80%82

工作原理

StatusBay的watcher组件订阅K8S集群事件流，监控资源变化（CREATE/UPDATE/DELETE）。当检测到新部署时，它会跟踪相关资源（Deployment、StatefulSet等）的进度，通过配置的渠道推送状态报告，并在UI中展示详细流程。

示例场景：
部署Nginx应用后，Watcher立即监控my-nginx部署：

bash
kubectl create deployment --image nginx my-nginx

技术栈

• 开发语言：GO
• 依赖库：K8S Client Library
• 部署方式：Helm

文档与贡献

• https://github.com/similarweb/statusbay/blob/master/docs/developers/README.md
• https://github.com/similarweb/statusbay/blob/master/docs/clusters/README.md
• https://github.com/similarweb/statusbay/blob/master/docs/integrations.md
• 贡献请参考https://github.com/similarweb/statusbay/blob/master/CONTRIBUTING.md