README

一、简介
    Atlas是由奇虎360公司Web平台部基础架构组开发维护的一个基于MySQL协议的数据中间层项目。它在MySQL官方推出的MySQL-Proxy 0.8.2版本的基础上，修改了大量bug，添加了很多功能特性。目前该项目在360公司内部得到了广泛应用，3/4以上的MySQL业务已经接入了Atlas平台，每天承载的读写请求数达20亿条以上。

主要功能特性：
1.  自动读写分离，对应用透明
2.  自动分表
3.  IP过滤，包括指定具体IP和网段IP
4.  SQL语句黑白名单
5.  字符集和默认数据库的自动修正
6.  可强制读主库，避免从库的同步延迟
7.  主库宕机的情况下读操作不受影响
8.  在挂接LVS的情况下可平滑重启，应用不感知
9.  自动检测DB状态，故障或连接不上的DB自动摘除，不再导入请求，在故障或网络恢复后自动重新导入请求
10. 可在线手动将某台DB设置为上线或下线状态
11. 可在线手动增加或减少一台DB
12. 从库间加权的负载均衡

附名字来源：
    Atlas['?tl?s]，希腊神话中双肩撑天的巨人，普罗米修斯的兄弟，最高大强壮的神之一，因反抗宙斯失败而被罚顶天。我们期望这个系统能够脚踏后端DB，为前端应用撑起一片天。

二、配置文件示例
[mysql-proxy]	#不需要改
plugins = admin, proxy	#Atlas加载的模块名称，不需要改

admin-username = user	#管理接口的用户名
admin-password = pwd	#管理接口的密码
admin-lua-script = /usr/local/mysql-proxy/lib/mysql-proxy/lua/admin.lua	#实现管理接口的Lua脚本所在路径

proxy-backend-addresses = 127.0.0.1:3306	#Atlas后端连接的MySQL主库的IP和端口，可设置多项，用逗号分隔
proxy-read-only-backend-addresses = 220.181.127.222:3306	#Atlas后端连接的MySQL从库的IP和端口，可设置多项，用逗号分隔

daemon = false	#设置Atlas的运行方式，设为true时为守护进程方式，设为false时为前台方式，一般开发调试时设为false，线上运行时设为true
keepalive = false	#设置Atlas的运行方式，设为true时Atlas会启动两个进程，一个为monitor，一个为worker，monitor在worker意外退出后会自动将其重启，设为false时只有worker，没有monitor，一般开发调试时设为false，线上运行时设为true

event-threads = 4	#工作线程数，推荐设置与系统的CPU核数相等
log-level = message	#日志级别，分为message、warning、critical、error、debug五个级别
log-path = /usr/local/mysql-proxy/log	#日志存放的路径
instance = test	#实例名称，用于同一台机器上多个Atlas实例间的区分

proxy-address = 0.0.0.0:1234	#Atlas监听的工作接口IP和端口
admin-address = 0.0.0.0:2345	#Atlas监听的管理接口IP和端口

min-idle-connections = 128	#连接池的最小空闲连接数，可根据业务请求量大小适当调大或调小
tables = person.mt.id.3	#分表设置，此例中person为库名，mt为表名，id为分表字段，3为子表数量，可设置多项，以逗号分隔
pwds = user1:+jKsgB3YAG8=, user2:GS+tr4TPgqc=	#用户名与其对应的加密过的密码，密码使用加密程序encrypt加密，此设置项用于多个用户名同时访问同一个Atlas实例的情况，若只有一个用户名则不需要设置该项
charset = utf8	#默认字符集，若不设置该项，则默认字符集为latin1

三、编译安装
依赖：glib、libevent、Lua、OpenSSL

./bootstrap.sh	#可能需要修改其中的路径
make
sudo make install

四、启动与停止
进入PREFIX/conf目录，编辑instance.conf，此处instance的实际名称应与其中instance设置项相同，其他设置项含义见第二节。

启动：
PREFIX/bin/mysql-proxyd instance start

停止：
PREFIX/bin/mysql-proxyd instance stop

重启：
PREFIX/bin/mysql-proxyd instance restart

查看运行状态：
PREFIX/bin/mysql-proxyd instance status