freno 项目使用教程

1. 项目介绍

freno 是一个协作式、高可用的限流服务，最初设计用于提供一个统一的、自适应的 MySQL 限流解决方案：在保持低复制延迟的同时控制写入。freno 通过收集后端存储（目前仅支持 MySQL）的数据，并根据预定义的阈值来决定是否允许客户端写入。它使用 Raft 共识协议来确保高可用性，并能够在节点之间传递用户事件。

2. 项目快速启动

2.1 环境准备

确保你已经安装了以下工具：

• Go (版本 >= 1.16)
• Docker (用于容器化部署)

2.2 克隆项目

首先，克隆 freno 项目到本地：

git clone https://github.com/github/freno.git
cd freno

2.3 构建项目

使用 Go 构建项目：

go build -o freno ./cmd/freno

2.4 配置文件

创建一个配置文件 freno.conf，参考项目中的示例配置文件进行配置。以下是一个简单的配置示例：

general:
  listen: ":8080"
  raft:
    data_dir: "/var/lib/freno/raft"
    bind: ":12000"
    advertise: ":12000"

mysql:
  clusters:
    - name: "cluster1"
      credentials: "user:password@tcp(127.0.0.1:3306)/"
      lag_query: "SHOW SLAVE STATUS"
      threshold: 1000

2.5 启动服务

使用以下命令启动 freno 服务：

./freno -config=freno.conf

2.6 验证服务

使用 curl 或其他 HTTP 客户端工具发送请求，验证服务是否正常运行：

curl -I http://localhost:8080/check/cluster1

如果返回状态码为 200，则表示服务正常运行。

3. 应用案例和最佳实践

3.1 批量操作

freno 特别适用于批量操作，如大规模加载/归档任务、模式迁移、大规模更新等。通过将这些任务分解为小任务（例如每次处理 100 行），并在每次执行前咨询 freno，可以避免对数据库和应用程序造成不良影响。

3.2 读写分离

在读写分离的场景中，freno 可以帮助确定实际的复制延迟，从而推断副本的有效性。这有助于缓解主库读取的写后读问题。

3.3 动态调整

freno 支持动态调整后端存储的探测列表，例如通过 haproxy 动态获取 MySQL 集群的可用服务器列表，并自动适应这些变化。

4. 典型生态项目

4.1 freno-client

freno-client 是 freno 的 Ruby 客户端，开源并作为 Ruby Gem 提供。它可以帮助 Ruby 应用程序与 freno 服务进行交互。

4.2 Vitess

Vitess 是一个用于 MySQL 水平扩展的集群系统，与 freno 结合使用可以更好地管理 MySQL 集群的写入流量。

4.3 ProxySQL

ProxySQL 是一个高性能的 MySQL 代理，可以与 freno 结合使用，通过代理层实现更细粒度的写入控制。

通过以上步骤，你可以快速启动并使用 freno 项目，结合实际应用场景和生态项目，实现高效的 MySQL 写入控制。