Flapjack 项目技术文档

1. 安装指南

1.1 Ubuntu Precise 64 (12.04) 安装

1. 添加 Flapjack 包签名密钥：

   gpg --keyserver keys.gnupg.net --recv-keys 803709B6
   gpg -a --export 803709B6 | sudo apt-key add -
   

2. 添加 Flapjack Debian 仓库：

   echo "deb http://packages.flapjack.io/deb/v2 precise main" | sudo tee /etc/apt/sources.list.d/flapjack.list
   

3. 安装 Flapjack 包：

   sudo apt-get update
   sudo apt-get install flapjack
   

   或者，您也可以下载 deb 包并使用以下命令安装：

   sudo dpkg -i <filename>
   

4. 启动 Flapjack 和 Redis： 安装完成后，Redis 和 Flapjack 会自动启动。您可以通过以下命令检查状态：

   sudo /etc/init.d/redis-flapjack status
   sudo /etc/init.d/flapjack status
   

1.2 其他操作系统安装

目前仅提供 Ubuntu Precise 64 的包。如果您使用其他操作系统，可以通过以下方式安装：

1. 使用 RubyGems 安装：

   gem install flapjack
   

2. 使用 rbenv 或 rvm 管理 Ruby 环境： 推荐使用 rbenv 或 rvm 来避免不同 Ruby 应用之间的冲突。

3. 安装 Redis： 确保安装了 Redis >= 2.6.12。

2. 项目使用说明

2.1 快速启动指南

您可以通过快速启动指南在本地使用 Vagrant 和 VirtualBox 快速启动 Flapjack。

2.2 核心功能

Flapjack 提供了处理系统状态变化事件的扩展方法，并根据需要向适当的人员发送警报。其核心功能包括：

• 警报路由：根据兴趣、时间、计划维护等确定谁应该接收警报。
• 警报汇总：根据每个用户和每种媒体的汇总阈值进行警报汇总。
• 标准操作任务：设置计划维护、确认等。

2.3 使用场景

Flapjack 适用于以下场景：

• 希望通过汇总多个监控系统的警报来更快地识别故障。
• 监控的基础设施由多个团队负责维护。
• 监控基础设施是多租户的，每个客户都有定制的警报策略。
• 希望尝试使用 Sensu、Icinga 或 cron 等替代检查执行引擎。

3. 项目 API 使用文档

3.1 REST API

Flapjack 提供了 REST API，您可以通过以下地址访问：

http://localhost:3081/

3.2 API 功能

• 事件处理：处理来自外部检查执行引擎的事件，如 Nagios。
• 警报路由：根据配置确定谁应该接收警报。
• 警报汇总：根据用户和媒体的汇总阈值进行警报汇总。

4. 项目安装方式

4.1 通过包管理器安装

• Ubuntu Precise 64：使用 apt-get 安装。
• 其他操作系统：使用 RubyGems 安装。

4.2 手动安装

• 下载 deb 包：从 Flapjack 官方网站下载 deb 包并手动安装。
• 使用 RubyGems：通过 gem 命令安装 Flapjack。

4.3 配置文件

安装完成后，您可以编辑配置文件 /etc/flapjack/flapjack_config.toml 进行自定义配置。

sudo vi /etc/flapjack/flapjack_config.toml
sudo /etc/init.d/flapjack reload

4.4 启动与操作

• 启动 Redis：

  sudo /etc/init.d/redis-flapjack start
  

• 操作 Flapjack：

  sudo /etc/init.d/flapjack start
  sudo /etc/init.d/flapjack reload
  sudo /etc/init.d/flapjack restart
  sudo /etc/init.d/flapjack stop
  

通过以上步骤，您可以顺利安装、配置并使用 Flapjack 项目。