参数 #
集群生态工具参数 #
SphereEx-Boot 命令行参数列表 #
集群
| 命令 | 含义 | 参数 |
|---|---|---|
| download | 下载 ShardingSphere-Proxy, Zookeeper, Database driver 安装包 | –type [proxy|zk|driver] Option proxy or zk or driver –proxy-url TEXT Proxy download url –zk-url TEXT Zookeeper download url –driver-url TEXT Database driver download url –output-dir TEXT Output dir, Default current directory –help |
| init | 快速初始化集群操作的配置文件 | -n, –name TEXT name of cluster [required] –user TEXT install user –password TEXT install password –proxy-file PATH package file of proxy –proxy-conf-dir PATH config file directory of proxy –proxy-agent-conf-file PATH config file of agent –proxy-depend-file PATH depend file of proxy，for example, database driver. for example: –proxy-depend-file /root/mysql-connector-java-5.1.47.jar –proxy-install-dir TEXT install directory of proxy –proxy-port INTEGER start port of proxy –proxy-overwrite TEXT overwrite if install directory already exists –proxy-host TEXT proxy host ip,can be entered multiple times，for example: –proxy-host 10.0.1.1 –proxy-host 10.0.1.2 –zk-file PATH package file of ZooKeeper –zk-conf-file PATH zoo.cfg file of zookeeper –zk-install-dir TEXT install directory of zookeeper –zk-data-dir TEXT data directory of zookeeper –zk-port INTEGER clientPort of zookeeper –zk-overwrite TEXT overwrite if install directory already exists –zk-host TEXT ZooKeeper host ip, can be entered multiple times, for example: –zk-host 10.0.1.1 –zk-host 10.0.1.2 –download [all |
| install | 根据配置文件安装集群(proxy 或者 zk) | n, –name TEXT Cluster name [required] –host TEXT Host and port value. For example: 127.0.0.1 Specify the machine for this IP, 127.0.0.1:3307 Specify the node for this IP port –force The existing installation directory will be overwritten –type [proxy |
| list | 展示已经被安装过的集群 | |
| scale | 通过文件或者参数对集群的proxy做扩容 | -n, –name TEXT Name of cluster to be expanded, Required -f, –file PATH Configuration file of cluster –host TEXT Deployment machine IP –port INTEGER Start port of proxy or zookeeper –install-dir TEXT Install directory of proxy or zookeeper –agent-conf-file PATH Proxy agent config file –overwrite [yes |
| start | 启动集群的proxy或zk | -n, –name TEXT Cluster name [required] –with-agent Is Flag, Start with agent –host TEXT Host and port value, For example 127.0.0.1 or 127.0.0.1:3307 –type [proxy |
| status | 查看集群proxy或者zk的状态 | -n, –name TEXT Cluster name [required] –host TEXT Host and port value, For example 127.0.0.1 or 27.0.0.1:3307 –type [proxy |
| stop | 停止集群或者zk | -n, –name TEXT Cluster name [required] –host TEXT Host and port value, For example 127.0.0.1 or 27.0.0.1:3307 –type [proxy |
| uninstall | 卸载集群或者zk | -n, –name TEXT Cluster name [required] –host TEXT Host and port value, For example 127.0.0.1 or 27.0.0.1:3307 –type [proxy |
集群组件
| 命令 | 含义 | 参数 |
|---|---|---|
| install | 目前仅能安装prometheus | –type [prometheus] Specify component type, default prometheus -f, –file PATH Specify profile -t, –template Export configuration template –user TEXT Install user –password TEXT Install password –install-dir TEXT Install directory –package PATH Installation package –host TEXT Host ip –help Show this message and exit. |
| uninstall | 目前仅能卸载prometheus | –type [prometheus] Specify component type, default prometheus –user TEXT Install user –password TEXT Install password –install-dir TEXT Installed directory –host TEXT Host ip –help Show this message and exit. |
集群配置文件
| 命令 | 含义 | 参数 |
|---|---|---|
| add | 添加cluster配置文件 | -f, –file PATH Cluster configuration file [required] –force If a cluster with the same name exists, do you want to overwrite the configuration –help Show this message and exit. |
| check | 校验cluster配置文件 可以选择-f或者-n | -f, –file PATH Cluster configuration file -n, –name TEXT Cluster name –help Show this message and exit. |
| delete | 删除cluster配置文件 | –force Force delete configuration of cluster! –help Show this message and exit. |
| info | 展示配置文件内容 | -n, –name TEXT Cluster name [required] –detail flag, detail info of the cluster configuration –help Show this message and exit. |
| template | 导出全部配置模板或者扩容配置模板 | –type [full |
镜像
| 命令 | 含义 | 参数 |
|---|---|---|
| clone | 下载依赖 | -r, –requirement Output spex dependent. -o, –output-dir PATH Output directory, Default current directory. –help Show this message and exit. |
管理 SphereEx-Console
| 命令 | 含义 | 参数 |
|---|---|---|
| install | 安装console | -c, –config PATH Console configuration file [required] -n, –name TEXT Console name [required] –help Show this message and exit. |
| uninstall | 卸载console | -n, –name TEXT Console name [required] –help Show this message and exit. |
| list | 列出已经安装的console列表 | |
| export | 导出安装配置文件模板 | –output TEXT Output to the path –help Show this message and exit. |
| backup | 备份console使用的mysql库数据 保存到console同级安装目录下 在console安装的上一层 不会因为卸载console被删除 | -n, –name TEXT Console name [required] –help Show this message and exit. |
集群组件参数列表 #
使用组件过程中的配置的参数
- 监控中心启动参数
--web.listen-address=:9090 # 监听端口
--web.enable-lifecycle # 开启热加载 可以通过命令热加载新建监控
- 监控插件 mysql-exporter 启动参数
--web.listen-address=":{listen_port}" # 监听端口
--config.my-cnf="{conf}" # 上面内容的配置文件
- 监控插件 zookeeper-exporter启动参数
-bind-addr=":{listen_port}" # 监听端口
-zookeeper="{zk_host}" # 监控的zk host:port
- 监控插件 Node_exporter 启动参数
--web.listen-address=":{listen_port} # 监听端口
集群参数列表 #
| 名称 | 数据类型 | 说明 | 默认值 | 动态生效 |
|---|---|---|---|---|
| sql_federation_type | String | 联邦查询执行器类型，包括：NONE，ORIGINAL，ADVANCED。 | NONE | 是 |
| sql_federation_enabled | boolean | 是否启用 sql federation。 | FALSE | TRUE/FALSE |
| show_process_list_enabled | boolean | 是否启用显示进程列表。 | FALSE | TRUE/FALSE |
| agent_plugins_enabled | boolean | TRUE | 是否启用 agent plugin 插件。 | TRUE/FALSE |
| transaction_type | String | LOCAL | 事务类型。 | LOCAL/XA/BASE/MANUALXA |
| kernel_executor_size | int | 用于设置任务处理线程池的大小。每个 ShardingSphereDataSource 使用一个独立的线程池，同一个 JVM 的不同数据源不共享线程池。 | infinite | 否 |
| max_connections_size_per_query | int | 一次查询请求在每个数据库实例中所能使用的最大连接数。 | 1 | 是 |
| check_table_metadata_enabled | boolean | 在程序启动和更新时，是否检查分片元数据的结构一致性。 | false | 是 |
| proxy_frontend_flush_threshold | int | 在 ShardingSphere-Proxy 中设置传输数据条数的 IO 刷新阈值。 | 128 | 是 |
| proxy_hint_enabled | boolean | 是否允许在 ShardingSphere-Proxy 中使用 Hint。使用 Hint 会将 Proxy 的线程处理模型由 IO 多路复用变更为每个请求一个独立的线程，会降低 Proxy 的吞吐量。 | false | 是 |
| proxy_backend_query_fetch_size | int | Proxy 后端与数据库交互的每次获取数据行数（使用游标的情况下）。数值增大可能会增加 ShardingSphere Proxy 的内存使用。默认值为 -1，代表设置为 JDBC 驱动的最小值。 | -1 | 是 |
| proxy_frontend_executor_size | int | Proxy 前端 Netty 线程池线程数量，默认值 0 代表使用 Netty 默认值。 | 0 | 否 |
| proxy_backend_executor_suitable | String | 可选选项：OLAP、OLTP。OLTP 选项可能会减少向客户端写入数据包的时间开销，但如果客户端连接数超过 proxy-frontend-executor-size，尤其是执行慢 SQL 时，它可能会增加 SQL 执行的延迟甚至阻塞其他客户端的连接。 | OLAP | 是 |
| proxy_frontend_max_connections | int | 允许连接 Proxy 的最大客户端数量，默认值 0 代表不限制。 | 0 | 是 |
| proxy_mysql_default_version | String | Proxy 通过配置文件指定 MySQL 的版本号,默认版本：5.7.22。 只有 MySQL 需要配置，客户端识别数据库的协议版本。 | 5.7.22 | 否 |
| proxy_default_port | String | Proxy 通过配置文件指定默认端口。 | 3307 | 否 |
| proxy_netty_backlog | int | Proxy 通过配置文件指定默认netty back_log参数。 | 1024 | 否 |
| proxy_frontend_database_protocol_type | String | Proxy 前端协议类型，支持 MySQL, PostgreSQL, openGauss | "” | 否 |
| proxy_instance_type | String | Proxy 实例类型，可选项：Proxy、SphereEx:Proxy，Proxy 表示云上部署类型，SphereEx:Proxy 表示本地部署类型 | Proxy | 否 |
| system_log_level | String | 系统日志级别，非内置 logger 均使用该配置，系统日志级别，支持 DEBUG、INFO、WARN、ERROR | INFO | 是 |
| system_log_pattern | String | 系统日志格式，全局通用，日志格式可参考Logback Layouts | [%-5level] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %logger{36} - %msg%n | 是 |
| sql_show | boolean | 是否在系统日志中打印 SQL。 打印 SQL 可以帮助开发者快速定位系统问题。日志内容包含：逻辑 SQL，真实 SQL 和 SQL 解析结果。 如果开启配置，日志将使用 Topic ShardingSphere-SQL，系统日志级别是 INFO。 | false | 是 |
| sql_simple | boolean | 是否在系统日志中打印简单风格的 SQL。 | false | 是 |
| slow_query_log | boolean | 是否开启慢查询 TRUE/FALSE | false | 是 |
| long_query_time | int | 慢查询阈值单位ms | 10 | 是 |
| general_query_log | boolean | 是否开启全量日志（审计日志） TRUE/FALSE | false | 是 |
特殊说明 支持动态修改的属性可以立即生效，不支持动态修改的属性需要重启后生效。 参数配置可以通过修改计算节点的 yaml 文件配置重启生效，其中参数的下划线”_“需要换成中横线”-";