1 Star 4 Fork 1

小菜鸟 / tubing

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
GPL-2.0

Tubing

集中式代理后端数据库的小型读写分离中间件, 功能比较少,只有读写分离以及连接池功能。 在读写分离场景下,多个业务DB组需要多个读写分离中间件才能完成,而使用该中间件则可以一个同时代理多个后端DB组。

功能

  1. 可以集中管理后端数据库,根据不同的业务(platform)进行区分
  2. 每个后端节点独立的连接池管理
  3. 可以动态修改连接池大小
  4. 可以和我开发的高可用MysqlMp进行兼容,自动获取主从关系并维护对应连接池, 如果后端数据库宕机或者主从切换无需做任何操作,对客户端完全透明,如果单独使用不会检测后端存活以及动态修改主从关系,也没有命令行修改的方式
  5. 不同的后端业务可通过set platfrom来设置连接
  6. 支持多用户连接, 用户权限同步后端mysql已存在的用户信息
  7. 支持单主模式mgr集群, 自动发现主从关系
  8. 支持记录sql操作记录
  9. 可动态重载用户权限、配置信息

获取方式:

获取源码进行编译运行 RUST_LOG=debug ./tubing --defaults-file test.toml 日志方式可以选择info或者debug,退出则使用kill pid的方式,程序会平滑关闭

部分配置:

配置文件为标准的toml格式, 可参考test.toml,全局配置为基本信息

  1. mode: 可配置mp或者file, mp既通过高可用进行获取,默认都是file,file的方式没有实现动态获取路由关系,可以使用rload config的方式进行路有关系修改
  2. user/password: 为管理用户及密码
  3. server_url: 高可用获取路由信息的接口
  4. hook_id: 用于高可用验证的id
  5. cluster: 从高可用获取路由的名称列表

platform(既为业务组, 如果多个业务组则需要写多个):

  1. platform: 该业务组名称,如果使用高可用获取的方式则同高可用业务集群名称
  2. platform_sublist: 子列表,代表该套业务db下存在的子业务,也是客户端set platform时的值
  3. user/password: 连接后端mysql所使用的用户密码,需要对应操作所有的权限
  4. min/max: 后端到mysql连接池最小/最大值

user_info(配置用户信息,多个则配置多个)

  • user/password: 客户端连接使用的账号密码,该账号密码必须存在于后端mysql, 会对该用户进行权限判断
  • platform: 代表该用户操作的是那个platform, 一个用户只能有一个platform且该platform必须存在于上面的platform_sublist

管理命令:

没有专用的管理端或者管理端口,直接使用mysql命令行工具进行连接并通过set platform=admin命令设置就可以。

MySQL [(none)]> set platform=admin;   
Query OK, 0 rows affected (0.00 sec)

MySQL [(none)]> show questions;                          
+----------+-------------------+------------+------------+------------+------------+--------------------+
| platform | host_info         | com_select | com_update | com_insert | com_delete | platform_questions |
+----------+-------------------+------------+------------+------------+------------+--------------------+
| test001 | 192.168.1.80:3306 |          1 |          0 |          0 |          0 | 3                  |
| test001 | 192.168.1.81:3306 |          0 |          0 |          0 |          0 | 3                  |
+----------+-------------------+------------+------------+------------+------------+--------------------+
2 rows in set (0.00 sec)

MySQL [(none)]> show connections;
+----------+-------------------+------------+------------+---------------+------------+
| platform | host_info         | min_thread | max_thread | active_thread | pool_count |
+----------+-------------------+------------+------------+---------------+------------+
| test001 | 192.168.1.80:3306 |         10 |        100 |             0 |         10 |
| test001 | 192.168.1.81:3306 |         10 |        100 |             0 |         10 |
+----------+-------------------+------------+------------+---------------+------------+
2 rows in set (0.00 sec)

查询状态目前只支持show connections/questions/status/fuse四个操作,可以看到连接池使用情况以及qps,都可以通过命令where platform='' 添加条件查询。

MySQL [(none)]> set min_thread=1 where platform="test001" and host_info="192.168.1.80:3306";
Query OK, 0 rows affected (0.00 sec)

MySQL [(none)]> show connections;
+----------+-------------------+------------+------------+---------------+------------+
| platform | host_info         | min_thread | max_thread | active_thread | pool_count |
+----------+-------------------+------------+------------+---------------+------------+
| test001 | 192.168.1.80:3306 |          1 |        100 |             0 |         10 |
| test001 | 192.168.1.81:3306 |         10 |        100 |             0 |         10 |
+----------+-------------------+------------+------------+---------------+------------+
2 rows in set (0.00 sec)

可以通过set命令修改连接池大小情况以及开关日志记录(set auth=1/0 whre ....), sql记录可供临时开启排查问题作用,不建议一直使用, 由于sql语句需要写入文件,所有比较损耗性能,set命令必须带where条件,防止误操作, set 命令支持:

  • set min_thread 修改连接池最小值
  • set max_thread 修改连接池最大值
  • set aut 打开/关闭sql审计
  • set fuse 打开/关闭限流功能,如果打开则限制单个platform最多只能获取连接池中80%的连接,只限于sublist中的paltform名称, 业务db集群的paltform不受限制。

重载配置、用户权限说明:

使用命令行执行的方式, 当更新了用户权限、或者主从关系变更等情况下可以直接使用命令行执行对应命令就可以。

重载用户权限

reload user [where platform=''] : where条件可选, 当带有platform则只更新对应的user权限, 如果没有where条件则全部重载

重载配置

reload config: 重新读取配置文件并修改, 需要注意的是只有部分配置项会重载,全局配置项、连接池大小配置、创建连接池使用的用户不会重载, 在使用mode='file'时,该功能可结合高可用进行读写关系变化, 增加、删除业务时也可以使用, 重载配置也会重载所有用户权限。

内部原理:

enter image description here

  1. 连接池每分钟进行心跳检测、每十分钟进行连接池状态维护、每50ms从高可用获取一次节点状态,如变化则修改, 空闲连接超过十分钟同时连接池数量大于最小值则会关闭。
  2. 每个mysql业务组读流量连接通过最小连接算法进行获取,数据库操作基本都是长连接,通过最小算法获取比轮询能更好的均衡流量。
  3. 客户端连接获取到的连接空闲超过200ms才归还到连接池,像插入/更新之后立马需要查询的不会路由到从节点,同时也支持对select语句强制走主库, 例如select /*force_master*/ a,b,c from t1。
  4. 每个客户端连接创建之后首先需要set platfrom才可以进行操作,因为不设置的话不知道该把操作语句路由到那个业务组,所以该中间件不支持像navicat这些界面工具。
  5. set命令只支持设置names、autocommit、platfrom
  6. 中间件只做流量路由及连接池管理,且内部都是异步处理,如果需要kill线程,需直接在后端进行操作。
  7. 启动时会加载配置所有用户的权限信息, 业务端操作时权限由中间件完成,如果后端mysql用户权限变动需重启中间件

限制条件

  1. set命令仅支持set names/autocommit/platform三个命令
  2. 仅支持单条sql语句,如果以; 分隔传入多条语句会引发不可知问题
  3. 连接成功后首先要执行set platform命令才能正常运作
  4. mgr仅支持单主模式
  5. 后端服务器必须设置统一的character,tubing使用的连接池,连接池链接如果空闲会归还,其他活跃链接会获取该链接到并使用,这样会导致使用的链接字符集状态未知, 每次执行sql都会执行一次set操作,将产生很多不必要的开销,因此tubing在字符集这块没有设计任何操作
  6. 客户端使用的user_info, 多个platform下不能使用相同的用户名

特别提醒

该工具已在我司生产环境中的主业务上使用很长一段时间,但仅适配好golang、python、java的mysql框架,而且jdbc也仅适配了8.0版本。rust暂时没有完全兼容mysql的语法解析包,tubing中使用的是我用sqlparse-rs修改支持的mysql, 可能有语法未涉及到,如在使用或测试中遇到问题欢迎提issues

GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. <signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License.

简介

mysql读写分离中间件 展开 收起
Rust
GPL-2.0
取消

发行版 (1)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
Rust
1
https://gitee.com/wwbjqcom/tubing.git
git@gitee.com:wwbjqcom/tubing.git
wwbjqcom
tubing
tubing
master

搜索帮助