Redistat 技术文档

1. 安装指南

安装 Redistat

Redistat 是一个基于 Redis 的统计存储和查询库，使用 Ruby 编写。要安装 Redistat，请按照以下步骤操作：

1. 确保你已经安装了 Ruby 环境。

2. 打开终端并运行以下命令来安装 Redistat：

   gem install redistat
   

3. 如果你使用的是 Ruby 1.8.x 版本，建议同时安装 SystemTimer gem，以避免 Redis gem 的警告：

   gem install SystemTimer
   

2. 项目的使用说明

基本使用

Redistat 提供了一个简单的接口来存储和查询统计数据。以下是一个基本的使用示例：

存储数据

require 'redistat'

class ViewStats
  include Redistat::Model
end

# 如果使用 Redistat 在多个线程中，设置线程安全
Redistat.thread_safe = true

# 存储数据
ViewStats.store('hello', {:world => 4})
ViewStats.store('hello', {:world => 2}, 2.hours.ago)

查询数据

# 查询最近1小时的数据
ViewStats.find('hello', 1.hour.ago, 1.hour.from_now).all
  #=> [{'world' => 4}]

# 查询最近3小时的数据总和
ViewStats.find('hello', 3.hour.ago, 1.hour.from_now).total
  #=> {'world' => 6}

高级使用

存储页面浏览数据

# 存储产品 #44 的 Chrome 11 浏览数据
ViewStats.store('views/product/44', {'count/chrome/11' => 1})

查询产品 #44 的统计数据

ViewStats.find('views/product/44', 23.hours.ago, 1.hour.from_now).total
  #=> { 'count' => 1, 'count/chrome' => 1, 'count/chrome/11' => 1 }

查询所有产品的统计数据

ViewStats.find('views/product', 23.hours.ago, 1.hour.from_now).total
  #=> { 'count'           => 2,
  #     'count/chrome'    => 1,
  #     'count/chrome/11' => 1,
  #     'count/firefox'   => 1,
  #     'count/firefox/3' => 1 }

3. 项目API使用文档

store 方法

store 方法用于存储统计数据。它接受三个参数：

• label：标识符字符串，用于区分不同类型的统计数据。
• data：要存储的统计数据，通常是一个哈希。
• time：可选参数，指定数据的时间戳。

ViewStats.store('hello', {:world => 4})
ViewStats.store('hello', {:world => 2}, 2.hours.ago)

find 方法

find 方法用于查询统计数据。它接受三个参数：

• label：标识符字符串，用于指定要查询的统计数据。
• start_time：查询的起始时间。
• end_time：查询的结束时间。

ViewStats.find('hello', 1.hour.ago, 1.hour.from_now).all
  #=> [{'world' => 4}]

total 方法

total 方法返回查询结果的总和。

ViewStats.find('hello', 3.hour.ago, 1.hour.from_now).total
  #=> {'world' => 6}

4. 项目安装方式

Redistat 的安装非常简单，只需使用 RubyGems 进行安装：

gem install redistat

如果你使用的是 Ruby 1.8.x 版本，建议同时安装 SystemTimer gem：

gem install SystemTimer

安装完成后，你可以在 Ruby 项目中引入 Redistat 并开始使用它。

require 'redistat'

通过以上步骤，你可以轻松地将 Redistat 集成到你的项目中，并开始使用它来存储和查询统计数据。