15 Star 69 Fork 15

He3DB / He3Proxy

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

LICENSE

Go Report Card

He3Proxy

简介

He3Proxy是中移(苏州)软件技术有限公司基于PG协议 专为He3DB 打造的高性能数据库代理项目,采用Go语言开发, He3Proxy为He3DB 提供读写分离、负载均衡、连接池管理、 读一致性等基础能力,让用户像使用单机一样使用He3DB 集群,并提升集群整体吞吐量、提高节点资源利用率, 同时兼具He3DB 集群管理功能,如集群监控、灰度升级、数据分层存储、动态扩缩容等,助力He3DB 实现serverless。

同时He3Proxy也兼容其他基于PG协议 的主从架构数据库,可作为其数据库中间件使用。

架构图

架构图

集群部署图

集群部署图

功能介绍

  • 支持PG协议连接。
  • 支持SQL读写分离。
  • 支持连接池管理,可复用已有后端数据库链接,减少建立链接时的性能损耗。
  • 支持多个slave,slave之间通过权值进行负载均衡。
  • 支持多个slave,slave之间通过节点负载情况进行负载均衡。
  • 支持显式事务内先读操作的负载均衡。
  • 支持强制读主库。
  • 支持所有请求均主库执行。
  • 支持配置proxy到后端数据库的最大连接数限制。
  • 支持SQL黑名单机制。
  • 支持通过配置hba文件,实现数据库安全访问权限控制。
  • 支持热加载配置文件,动态修改He3Proxy配置项。
  • 支持session读一致性,并根据节点负载情况进行负载均衡。
  • 支持客户端链接维度的tracing数据采集(jaeger)。

功能演示

功能演示

安装部署

	1. 安装Go语言环境(请使用最新版)
	2. git clone https://gitee.com/he3db/he3proxy.git $GOPATH/src/gitee.com/he3db/he3proxy
	3. cd $GOPATH/src/gitee.com/he3db/he3proxy
	4. source ./dev.sh
	5. make
	6. 设置配置文件
	7. 运行he3proxy
	   ./bin/he3proxy -config=./etc/he3proxy.yaml -hba=./etc/hba.conf -log-level=info

Goland打包Linux二进制文件配置可参考下图

Goland打包配置

配置文件说明

配置文件说明

启动参数说明

postgres@he3db:~/he3proxy$ ./bin/he3proxy -h
    __  __    _____       ____
   / / / /__ |__  /      / __ \_________  _  ____  __
  / /_/ / _ \ /_ <______/ /_/ / ___/ __ \| |/_/ / / /
 / __  /  __/__/ /_____/ ____/ /  / /_/ />  </ /_/ /
/_/ /_/\___/____/     /_/   /_/   \____/_/|_|\__, /
                                            /____/
Usage of ./he3proxy:
  -cancel-request [启用后支持ctrl+c终止异常链接,默认false]
        the flag of save connection id and secret for cancel request
  -config string [He3Proxy配置文件路径]
        He3Proxy config file (default "./etc/he3proxy.yaml")
  -conn-pool [是否使用连接池,默认 true]
        the switch of connection pool, if true means use backend connection pool (default true)
  -cpu-profile [是否使用连接池,默认 true]
        analysis cpu profile
  -db-mode string [后端数据库类型,保留kingshard的MySQL数据库链接功能,默认 postgresql]
        switch proxy work mode [mysql|postgresql], default postgresql (default "postgresql")
  -hba string [He3Proxy hba 配置文件路径]
        He3Proxy hba config file (default "./etc/hba.conf")
  -he3proxy [He3Proxy中间件标识,若使用读一致性功能,需要开启此配置,默认 false]
        the flag of he3proxy, if true means tell backend current connection is by he3proxy
  -keep-conn [始终使用当前链接处理,适用于高性能读需求,读写混和场景不适用,默认 false]
        keep use current conn, and not release util conn release
  -log-level string [日志级别设置]
        log level [debug|info|warn|error], default set by configuration
  -max-cpu int [程序最大使用cpu数]
        the GO MAX PROCS, default sys logical cpu nums
  -metrics [是否开启prometheus采集指标,默认 false]
        the flag of collection metrics, if true means work with prometheus
  -opentracing [是否开启opentracing指标采集,默认 false]
        switch of opentracing
  -pprof [debug使用,用于开启pprof,默认 false]
        the switch of pprof
  -pyroscope [debug使用,是否开启pyroscope监控,默认false]
        the switch of pyroscope
  -readonly [高性能读场景使用,读写场景不适用,默认 false]
        improve read performance by not release conn
  -server-version string [设置后端数据库版本]
        set backend server version for pg, default 14.2 (default "14.2")
  -simple-parse [解析器使用选择,true使用CRDB的语法书解析(读一致性功能必须设置为true),false使用简单分词,默认true]
        the flag of use simple parse (lex), if false means will use crdb parse (AST) (default true)
  -single-session [单链接模式,不使用负载均衡,默认 false]
        the switch of single session, if true means proxy work without loadbalance
  -tracer-provider-url string [设置jaeger指标采集地址,opentracing为true时此参数有效]
        jaeger collector url (default "http://localhost:14268/api/traces")
  -v    the version of He3Proxy [输出He3Proxy版本信息]

鸣谢

  • 感谢kingshard 作者Fei Chen,He3Proxy以kingshard作为基础框架,在其之上进行定制化改造开发。
  • 感谢CockroachDB 团队及postgresql-parser 的作者auxten, He3Proxy在SQL解析层参考使用了项目postgresql-parser,在hba登录鉴权管理等方面参考了CockroachDB的实现。
  • 感谢TiDB for PostgreSQL 作者神州数码团队,He3Proxy在前后端握手、协议处理方面参考了TiDB for PostgreSQL的实现。
  • 感谢PG Go语言驱动pgx 团队,He3Proxy在前后端链接管理、协议等方面使用了pgx团队提供的pgconnpgproto3 等工具。
  • 感谢其他第三方依赖包对He3Proxy提供的帮助,有你们使开发更高效。
  • 感谢以下开源爱好者 为He3Proxy做出的贡献。

贡献说明

欢迎参与并贡献He3Proxy, 请查看Contribute 了解详细信息。CLA提供更多贡献信息。

RoadMap

  • 支持根据冷热数据分布情况进行读节点选择
  • 整体性能调优,目标性能损耗15%以内
  • 支持注册中心(优先etcd)
  • 支持性能监控,如SQL执行时长、节点负载等
  • 支持对He3DB的管理功能,如节点扩缩容、故障切换等
  • 支持He3DB集群灰度升级
  • 支持流量管控,愿景DB订购参数不再是CPU、Mem、Disk而是所需的TPS、QPS
  • 支持Web页面管理中间件功能

He3Proxy用户列表

注意: 当前为非release版本,不建议生产使用!

社区

项目地址https://gitee.com/he3db/he3proxy

欢迎加入slack 进行沟通交流~

更多技术细节欢迎查阅技术文章专栏

License

He3Proxy采用Apache 2.0协议,相关协议请参看目录

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

He3Proxy是中移(苏州)软件技术有限公司基于PG协议专为He3DB打造的高性能数据库代理项目。 展开 收起
Apache-2.0
取消

发行版 (1)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/he3db/he3proxy.git
git@gitee.com:he3db/he3proxy.git
he3db
he3proxy
He3Proxy
master

搜索帮助