HoardD 技术文档

1. 安装指南

HoardD 是一个基于 Node.js 和 Coffee-Script 的工具，用于将服务器性能指标发送到 Graphite。以下是安装 HoardD 的步骤：

1. 确保您的系统已安装 Node.js。
2. 使用 npm 安装 HoardD：

   npm install hoardd
   

3. 创建一个配置文件（默认为 config.json），根据您的 Graphite 服务器地址进行配置。

2. 项目的使用说明

HoardD 通过读取配置文件来收集服务器性能指标，并将这些指标发送到 Graphite。以下是使用 HoardD 的基本步骤：

1. 将配置文件放置在 HoardD 的项目目录中。
2. 创建或添加新的 Coffee-Script 或 JavaScript 脚本来收集特定的性能指标。
3. 运行 HoardD：

   node hoardd.js
   

4. HoardD 会定时收集指标并发送到 Graphite。

3. 项目API使用文档

HoardD 提供了一些基本的 API 用于在脚本中添加和发送指标：

• push_metric(metric_name, value)：用于将指标名称和值添加到待发送队列中。
• cli：用于日志记录。
• fqdn：用于获取服务器的完全限定域名。

以下是一个示例脚本：

Fs = require 'fs'
Path = require 'path'

module.exports = (server) ->
  run = () ->
    metricPrefix = "#{server.fqdn}.load_average"
    server.cli.debug "Running load average script"

    procfile = '/proc/loadavg'
    if Path.existsSync procfile
      data = Fs.readFileSync(procfile, 'utf-8')
      [one, five, fifteen] = data.split(' ', 3)
      server.push_metric "#{metricPrefix}.short", one
      server.push_metric "#{metricPrefix}.medium", five
      server.push_metric "#{metricPrefix}.long", fifteen

4. 项目安装方式

HoardD 的安装方式如下：

1. 使用 npm 安装 HoardD：

   npm install hoardd
   

2. 创建配置文件 config.json，并根据您的 Graphite 服务器地址进行配置。
3. 将收集指标的脚本放置在 scriptPath 目录中。
4. 运行 HoardD：

   node hoardd.js
   

以上就是 HoardD 的技术文档，希望对您有所帮助。如果您有任何问题或建议，欢迎反馈。