senzil/cabot

Cabot 镜像文档

镜像概述和主要用途

Cabot是一个免费、开源、自托管的基础设施监控平台，旨在提供PagerDuty、Server Density、Pingdom和Nagios等工具的核心功能，同时避免其成本和复杂性。该平台通过直观的Web界面实现服务监控，支持基于现有Graphite/statsd数据生成告警，无需编写代码即可配置监控规则和通知策略，适用于需要简单高效基础设施监控的团队。

核心功能和特性

• 多源监控支持：
  • Graphite指标监控
  • Web端点状态码及响应内容检查
  • Jenkins构建状态监控
• 多渠道告警：支持电话、短信、HipChat、邮件等通知方式
• 零代码配置：通过Web界面完成服务监控和告警规则设置，无需编写代码
• 数据复用：直接使用现有Graphite/statsd数据，无需额外部署数据收集系统
• 技术栈：基于Python开发，使用Django框架、Bootstrap和Font Awesome构建Web界面

使用场景和适用范围

• 中小型团队：需要低成本、易维护的基础设施监控解决方案
• Graphite用户：希望基于现有Graphite数据构建告警系统的团队
• 简化运维：替代复杂的Nagios配置，降低监控系统维护成本
• 多场景监控：需同时监控服务器指标、Web服务可用性和CI/CD构建状态的环境

使用方法和配置说明

快速部署

通过Docker可在5分钟内完成部署，参考官方快速启动指南：[***]

Docker运行示例

bash
docker run -d -p 8000:8000 cabotapp/cabot

Docker Compose配置示例

yaml
version: '3'
services:
  cabot:
    image: cabotapp/cabot
    ports:
      - "8000:8000"
    environment:
      - DATABASE_URL=postgres://user:password@db:5432/cabot
      - REDIS_URL=redis://redis:6379/0
      - SECRET_KEY=your_secret_key
    depends_on:
      - db
      - redis
  db:
    image: postgres:9.6
    environment:
      - POSTGRES_USER=user
      - POSTGRES_PASSWORD=password
      - POSTGRES_DB=cabot
    volumes:
      - postgres_data:/var/lib/postgresql/data
  redis:
    image: redis:3.2
    volumes:
      - redis_data:/data

volumes:
  postgres_data:
  redis_data:

详细配置文档

完整配置说明请参考官方文档：

• 配置
• 部署
• 服务管理
• Graphite检查
• Jenkins检查
• HTTP检查
• 告警配置

API说明

访问文档

API自动生成的文档可通过访问 https://cabot.yourcompany.com/api 查看，包含示例GET请求及支持的HTTP方法。

资源访问

查看单个资源需在URL后添加资源ID，例如查看ID为1的Graphite检查：

/api/graphite_checks/1/

认证方式

• HTTP基本认证：使用Django用户名和密码
• 会话认证：通过登录页面提交表单
• 权限控制：基于Django权限系统，所有认证用户可执行GET请求，POST/PUT等写操作需特定权限

权限配置示例

如需POST访问所有状态检查子类，需添加以下权限：

• cabotapp | status check | Can add graphite status check
• cabotapp | status check | Can add http status check
• cabotapp | status check | Can add icmp status check
• cabotapp | status check | Can add jenkins status check

排序和过滤

所有API可见字段支持排序和过滤：

• 过滤示例：获取debounce启用且重要性为CRITICAL的Jenkins检查

  /api/jenkins_checks/?debounce=1&importance=CRITICAL
  

• 排序示例：按名称升序排列Graphite检查

  /api/graphite_checks/?ordering=name
  

• 降序排序：在字段名前加 -

  /api/graphite_checks/?ordering=-name
  

许可证

采用MIT许可证，详见项目LICENSE文件。