Bucky 技术文档

1. 安装指南

Bucky 可以通过 easy_install 或 pip 进行安装：

$ easy_install bucky
# 或者
$ pip install bucky

安装后，您可以通过以下命令运行 Bucky：

$ bucky

默认情况下，Bucky 会在 127.0.0.1:25826 上打开一个用于 CollectD 的 UDP socket，在 127.0.0.1:8125 上打开一个用于 StatsD 的 socket，并尝试连接到本地的 Graphite（Carbon）守护进程，地址为 127.0.0.1:2003。这些设置都是可选的，您也可以完全禁用 CollectD 或 StatsD 服务器。

如果需要安装 py-setproctitle 模块以设置用户可读的进程名称，请运行以下命令：

$ easy_install setproctitle
# 或者
$ pip install setproctitle

2. 项目的使用说明

Bucky 是一个小型服务器，用于收集和转换 Graphite 的指标数据。它可以从前端的 CollectD 守护进程和 StatsD 客户端收集数据。

• CollectD: 它会在指定的 IP 和端口上打开一个 UDP socket 监听 CollectD 数据。
• StatsD: 类似地，它会在另一个指定的 IP 和端口上监听 StatsD 数据。
• Graphite: 收集的数据会被发送到 Graphite 服务器。

您可以通过命令行参数或配置文件来调整 Bucky 的运行参数。

3. 项目API使用文档

Bucky 的配置主要是通过命令行参数和配置文件来完成的。下面是一些重要的命令行参数：

Usage: main.py [OPTIONS] [CONFIG_FILE]

Options:
  --debug               将服务器置于干运行调试模式，输出到 stdout 而非 carbon/graphite。
  --metricsd-ip=IP      绑定 MetricsD UDP socket 的 IP 地址。
  --metricsd-port=INT   绑定 MetricsD UDP socket 的端口。
  --disable-metricsd    禁用 MetricsD UDP 服务器。
  ...
  --log-level=NAME      设置日志输出的详细程度。
  --version             显示程序的版本号并退出。
  -h, --help            显示帮助信息并退出。

配置文件是一个普通的 Python 文件，定义了一系列变量。大部分命令行参数也可以在配置文件中指定，但在两者都指定的情况下，命令行参数优先。

4. 项目安装方式

请参考上述 "安装指南" 部分进行安装。您可以使用 pip 或 easy_install 来安装 Bucky。安装后，通过简单的命令行指令即可运行该服务。

$ bucky

可以通过配置文件或命令行参数来调整服务的设置，以满足不同环境的需求。