Hummingbird 技术文档

1. 安装指南

环境要求

• Node.js 版本：v0.8.0 或更高

安装步骤

1. 克隆项目代码到本地：

   git clone git://github.com/mnutt/hummingbird.git
   cd hummingbird
   

2. 使用 npm 安装依赖：

   npm install
   

3. 下载 MaxMind 的 GeoIP 数据库并解压到项目根目录：

   wget http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz
   gunzip GeoLiteCity.dat.gz
   

2. 项目使用说明

启动分析服务器，运行以下命令：

node server.js

默认情况下，仪表板将运行在端口 8080 上。你可以在 config/config.js 中禁用生产环境中的仪表板。仪表板只是从 public/ 目录中提供 HTML，你可以使用任何 web 服务器来提供服务。

部署

确保仪表板的安全，如果你不希望外部人员访问它。通常这意味着将仪表板放在 nginx 或 apache 的基本认证后面。仪表板的 listen 函数接受第二个参数，即绑定接口；通常你会选择 "127.0.0.1" 仅允许从本地访问，或者 "0.0.0.0" 监听所有接口。然后你应该在不同的端口上运行跟踪像素，使其对外部世界可访问。

设置跟踪

文件 client/hummingbird.js 包含一个小的脚本来触发 Hummingbird 事件。你可以将文件内容直接粘贴到网页正文中，或者将其上传到服务器作为 .js 文件并通过 <script> 标签引用。一旦完成，你可以在页面底部调用：

HummingbirdTracker.track();

不带参数调用时，它将发送一些标准参数，如页面 URL。你还可以传递任意数据：

HummingbirdTracker.track({logged_in: true});

这些数据可以在 Hummingbird 的指标中用于后端过滤事件。

3. 项目 API 使用文档

Hummingbird 通过 Websockets、Flash sockets 或长轮询广播用户活动。客户端的 Hummingbird.WebSocket 对象接收来自服务器的 JSON 对象形式的 Websocket 事件。各个小部件订阅一个指标并注册处理函数，在指标出现时被调用。

4. 项目安装方式

请参考本文档的“安装指南”部分。

---

Hummingbird 是一款功能强大的站点跟踪和分析存储工具，通过本文档，用户可以快速安装和使用 Hummingbird，深入了解其工作原理和定制方法。