Vanity 项目技术文档

安装指南

1. 添加 Gem

首先，在项目的 Gemfile 中添加 vanity 依赖：

gem "vanity"

2. 安装 Gem

运行以下命令安装 Gem：

bundle install

3. 配置数据存储

Vanity 支持多种数据存储方式，包括 Redis、MongoDB 和 SQL 数据库。根据你的需求选择合适的数据存储方式，并在 config/vanity.yml 中进行配置。

Redis 配置

在 Gemfile 中添加 Redis 依赖：

gem "redis", ">= 3.2"
gem "redis-namespace", ">= 1.1.0"

示例 config/vanity.yml 配置：

production:
  adapter: redis
  url: redis://<%= ENV["REDIS_USER"] %>:<%= ENV["REDIS_PASSWORD"] %>@<%= ENV["REDIS_HOST"] %>:<%= ENV["REDIS_PORT"] %>/0

MongoDB 配置

在 Gemfile 中添加 MongoDB 依赖：

gem "mongo", "~> 2.0"

示例 config/vanity.yml 配置：

production:
  adapter: mongodb
  database: analytics

SQL 数据库配置

Vanity 支持多种 SQL 数据库，如 MySQL、PostgreSQL 等。示例 config/vanity.yml 配置：

production:
  adapter: active_record
  active_record_adapter: postgresql
  host: <%= uri.host %>
  username: <%= uri.user %>
  password: <%= uri.password %>
  port: <%= uri.port %>
  database: <%= uri.path.sub('/', '') %>

4. 初始化

如果使用的是 Rails，Vanity 会自动初始化。否则，需要在应用启动时手动初始化：

Vanity.configure do |config|
  # 配置项
end
Vanity.connect!(
  adapter: :redis,
  redis: $redis
)
Vanity.load!

项目使用说明

1. 用户识别

Vanity 需要识别用户以进行 A/B 测试。在 Rails 中，可以通过以下方式配置：

class ApplicationController < ActionController::Base
  use_vanity :current_user
end

2. 定义 A/B 测试

在 experiments/price_options.rb 文件中定义 A/B 测试：

ab_test "Price options" do
  description "Mirror, mirror on the wall, who's the better price of all?"
  alternatives 19, 25, 29
  metrics :signups
end

3. 展示不同选项

在 Rails 模板中展示不同的选项：

<h2>Get started for only $<%= ab_test :price_options %> a month!</h2>

4. 测量转化

使用 Vanity.track! 方法记录转化：

class SignupController < ApplicationController
  def signup
    @account = Account.new(params[:account])
    if @account.save
      Vanity.track!(:signups)
      redirect_to @account
    else
      render action: :offer
    end
  end
end

5. 查看报告

生成报告并查看结果：

vanity report --output vanity.html

项目 API 使用文档

1. Vanity.ab_test

用于在模板或代码中展示 A/B 测试的不同选项。

Vanity.ab_test(:price_options)

2. Vanity.track!

用于记录用户转化。

Vanity.track!(:signups)

3. Vanity.connect!

用于连接到 Vanity 的数据存储。

Vanity.connect!(
  adapter: :redis,
  redis: $redis
)

4. Vanity.reconnect!

用于在分叉服务器（如 Passenger 或 Unicorn）中重新连接。

after_fork do |server, worker|
  defined?(Vanity) && Vanity.reconnect!
end

项目安装方式

1. 通过 Gemfile 安装

在 Gemfile 中添加 vanity 依赖，并运行 bundle install 进行安装。

2. 配置数据存储

根据需求选择 Redis、MongoDB 或 SQL 数据库，并在 config/vanity.yml 中进行配置。

3. 初始化

在应用启动时手动初始化 Vanity，或使用 Rails 自动初始化。

通过以上步骤，你可以成功安装并使用 Vanity 进行 A/B 测试。