中文
文档
/
SphereEx-Console

了解

什么是 SphereEx-Console

SphereEx 企业数据服务平台,是在开源内核 ShardingSphere 基础上,增强部分企业级功能后封装而成。可为企业提供增强数据服务能力,包括但不限于数据分片、数据安全等。

SphereEx-Console,是应用于对 SphereEx 企业数据服务平台进行管理控制的可视化操作平台,提供更为易用的使用体验;同时,构建起以 ShardingSphere 为核心的整体解决方案,包括针对资源、实例、插件等多种功能封装,为用户带来一站式的使用体验。

SphereEx-Console 的功能全景图如下:

中文1.png

核心概念

  • 主机

部署安装计算节点、存储节点等实际的物理资源。

  • 数据库实例

对应数据库的实例即一个数据库服务。

  • 计算节点

一个计算节点是指一个 ShardingSphere 服务。

  • 存储节点

对应一个数据库实例下的一个 Database, 针对 ShardingSphere 来说就是承担数据存储的职能。

  • 集群

由若干计算节点和存储节点组成的分布式集群,是用户管理的单位。

  • 逻辑库

一个逻辑库对应 ShardingSphere 里面的一个 Schema,以集群级别进行管理;一个集群可以存在多个不同名的逻辑库。

  • 插件

ShardingSphere 采用可插拔架构设计,功能可以插件化的形式提供,包括但不限于数据分片、读写分离等等。

基础架构

SphereEx-Console 基于 B/S 架构,通过 Web 浏览器进行访问。其逻辑架构图如下:

中文2.png

用户通过浏览器登录系统,然后在 SphereEx-Console 中对 SphereEx 企业数据服务平台的集群进行管理。SphereEx-Console 查询的监控数据来自集群中主机、计算节点导出到 Prometheus 服务器的数据。

产品优势

功能易用

提高了用户体验,避免了配置错误,用户不需要通过配置和命令操作 SphereEx 企业数据服务平台,易用性得到极大提升,实现了平台使用的“零”瓶颈。

功能全面

完善了开源版本的管理能力,提供了对 SphereEx 企业数据服务平台从基础资源到插件能力的管控,形成了统一的解决方案。

功能可视

原生提供可视化的监控数据面板,可以实时在线查看 SphereEx 企业数据服务平台的集群、实例、主机的监控数据。

产品功能

一级模块二级模块功能描述
资源主机对物理主机进行管理
数据库实例对数据库实例进行管理
集群集群创建集群,对集群进行管理
计算节点注册计算节点,对计算节点进行管理
存储节点注册存储节点,对存储节点进行管理
逻辑库创建逻辑库,对逻辑库进行管理
插件数据分片对数据分片进行管理
监控主机展示主机监控信息
计算节点展示计算节点监控信息

应用场景

SphereEx-Console 主要用于对 SphereEx 企业数据服务平台的运维管控,在互联网、金融、政务行业均能够支持运维和开发人员常见的操作场景。

快速入门

本节介绍如何安装和使用 SphereEx-Console 系统。

运行环境

SphereEx-Console 是基于 Java 语言开发的,需要运行在支持 Java 的环境上。一般地,操作系统只要支持 Java 运行,均可以运行 SphereEx-Console。另外 SphereEx-Console 的监控是基于 Prometheus 系统,因此如果需要开启监控功能,需要运行 Prometheus。

版本要求
JDK 1.8 以上
Prometheus 2.8.1 以上

获取和安装

联系我们获取 SphereEx-Console 的软件包 sphereex-console-{x.x.x}-SNAPSHOT-bin-distribution.tar.gz 到本地。解压缩后,进入 SphereEx-Console 的目录,运行 bin 下的 start 脚本,即可启动 SphereEx-Console 。

YAML
bin/start.sh

打开浏览器,访问地址 http://localhost:8807。系统默认登录用户为 admin/admin。

示例场景

  1. 注册主机

    a. 在 资源 > 主机 菜单中点击 注册主机 按钮;

    b. 在弹出界面中录入主机数据;

    c. 点击 确定,新增一条主机信息。

注册主机.png

  1. 注册数据库实例

    a. 在 资源 > 数据库实例 菜单中点击 注册实例

    b. 在弹出界面内输入对应数据,如 IP: 127.0.0.1 、端口:3306、类型:MYSQL、连接用户:root、口令:123456;

    c. 点击 确定 按钮后数据库实例列表会新增一条对应的注册数据;

    d. 点击 探活 可以测试数据库实例是否可以连接成功。

注册实例.png

  1. 注册计算节点

    a. 在 集群 > 计算节点 菜单中点击 注册计算节点;

    b. 在弹出界面中,输入对应的计算节点相关信息;

    c. 点击 确定,新增计算节点数据;

    d. 点击 探活 按钮可以测试计算节点是否可以连接成功。

    注册计算节点.png

  2. 注册存储节点

    a. 在 集群 > 存储节点 菜单中点击 注册存储节点 按钮;

    b. 在弹出界面中输入对应的存储节点信息;

    c. 点击 确定 新增一条存储节点信息;

    d. 点击 探活 按钮测试存储节点是否可以连接成功。

注册存储节点.png

  1. 创建集群

    a. 在 集群 > 集群 菜单中点击 创建集群 按钮;

    b. 在弹出界面中输入集群信息;

    c. 点击 确定 可以新增一个集群;

    创建集群.png

    d. 点击集群操作中 配置 按钮,可以对集群的计算节点和存储节点进行配置;

    e. 配置后可以点击集群操作中 信息 按钮查看集群中计算节点、存储节点、逻辑库相关信息。

  2. 创建逻辑库

    a. 在 集群 > 逻辑库 菜单中点击 创建逻辑库;

    b. 在弹出的界面中输入逻辑库名字,选择逻辑库需要的存储节点;

    说明: 计算节点是全部选中,不可修改。

    c. 点击存储节点和计算节点可以分别查看到该逻辑库应用到的存储节点和计算节点信息。

    创建逻辑库.png

  3. 插件 - 数据分片

    a. 在 插件 > 数据分片 菜单中,目前提供数据分片操作,未来会扩展支持更多插件功能;

    b. 选择对应的集群和集群下对应的逻辑库后,点击 创建分片表 后可以在对应的逻辑库下使用 DistSQL 创建分片表、广播表;

    c. 创建好后也可以使用 DistSQL 对表规则进行修改;

创建逻辑库-1.png

d. 在创建好分片规则后可以点击添加表结构使用正常建表语句创建实际数据库表。

添加表结构.png

操作指南

首页

确保资源、集群各页面有数据。另外逻辑库数据依赖计算节点,需要保证各集群的计算节点正常连接并且存在逻辑库。

资源概览

可以查看如下资源已使用未使用情况:

  • 主机数量
  • 数据库实例数量

组件概览

可以查看如下组件的已使用未使用情况:

  • 集群数量
  • 计算节点数量
  • 存储节点数量
  • 逻辑库数量

资源

主机

注册主机

适用场景

当用户需要对应用服务所在的主机进行监控时,可通过注册主机的方式,对单个或多个主机进行统一的监控管理,了解服务主机相关的各项指标信息。

注意事项

保证主机地址真实有效,可通过探活的方式来判断。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 资源 > 主机
  3. 单击右上角的 注册主机 按钮;
  4. 填写主机信息,具体参数见下表;
参数说明
主机名称必填,不能超过 50 个字符
IP必填,正常 IP 地址如:127.0.0.1
主机描述非必填,不能超过 500 个字符
监控端口非必填,正常端口地址 1~65535,如 3306,后续用于主机监控
主机用户名非必填,不能超过 50 个字符
用户口令非必填,不能超过 50 个字符
探活使用 ping 机制探测主机是否在线可用
  1. 点击 确定,完成主机的注册;

后续处理

  1. 添加数据成功后,关闭弹窗并刷新列表数据。
  2. 如果提示用户数据已经存在,请重新添加。

删除主机

适用场景

当用户不再对单个或多个主机进行统一监控管理时,可在主机管理中进行删除操作,删除后就无法在监控管理查看到相关的主机。

注意事项

删除前,请确认主机不再需要进行统一的监控管理。

删除主机对集群、逻辑库、计算节点、存储节点没有影响。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 资源 > 主机
  3. 选择某一台主机,单击右侧的 删除 按钮;
  4. 弹出 提示 对话框,确认是否删除主机;
  5. 点击 确定,将永久删除该主机。

修改主机

适用场景

当服务主机相关信息发生变化时,例如:主机名称、IP 地址,用户可在主机管理中,对主机进行相关信息修改操作。

注意事项

保证所修改 IP 地址与服务主机一致,否则会影响监控。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 资源 > 主机
  3. 选择某一台主机,单击右侧的 修改 按钮;
  4. 弹出 修改主机 对话框,根据对话框提示填写必填内容和可填内容。
参数说明
主机名称必填,不能超过 50 个字符
IP必填,正常 IP 地址如:127.0.0.1
主机描述非必填,不能超过 500 个字符
监控端口非必填,正常端口地址 1~65535,如 3306,后续用于主机监控
  1. 点击 确定,完成主机的修改。

探活

适用场景

当用户在不确定服务主机是否存活的情况下,可通过探活功能查看。

注意事项

保证服务主机的 IP 地址真实有效。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 资源 > 主机
  3. 选择某一台主机,单击右侧的 探活 按钮;
  4. 如果出现 探活成功 的消息,说明该主机在线。

后续处理

如果出现 探活失败,请检查配置的 IP 地址是否正确。

数据库实例

注册实例

适用场景

当用户需要管理多个数据库实例时,可通过注册实例的方式,对多个数据库实例进行统一的维护管理。

注意事项

确保所注册的实例 IP、端口、用户名及口令均正确,否则探活失败。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 资源 > 数据库实例
  3. 单击右上角的 注册实例 按钮;
  4. 填写实例信息,具体参数见下表;
参数说明
实例 IP必填,正常 IP 地址如:127.0.0.1
实例端口必填,正常端口地址 1~65535,如 3306
实例描述非必填,不能超过 500 个字符
实例类型必选,需要从下拉框选择 MySQL
连接用户必填,不能超过 50 个字符
用户口令非必填,不能超过 50 个字符
探活使用数据库连接机制检查数据是否正常可连接
  1. 点击 确定,完成主机的注册。

后续处理

  1. 添加数据成功后,关闭添加弹窗并刷新列表数据。
  2. 如果提示数据已经存在,请重新添加。

删除实例

适用场景

当单个或多个实例不再进行管理时,可通过删除实例的方式将其删除。

注意事项

删除前请确认,所删除的实例是否了注册存储节点。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 资源 > 数据库实例
  3. 选择某一台主机,单击右侧的 删除 按钮;
  4. 弹出 提示 对话框,确认是否删除实例;
  5. 点击 确定,将永久删除该实例。

修改实例

适用场景

当数据库实例信息发生变更时,例如:IP,端口,类型,用户名等,用户可通过修改功能对实例进行更新。

注意事项

确保修改的内容与实际变更的信息一致。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 资源 > 数据库实例
  3. 选择某一实例,单击右侧的 修改 按钮;
  4. 弹出 修改实例 对话框,根据对话框提示填写必填内容和可填内容;
参数说明
实例 IP必填,正常 IP 地址如:127.0.0.1
实例端口必填,正常端口地址 1~65535,如 3306
实例描述非必填,不能超过 500 个字符
实例类型必选,需要从下拉框选择 MySQL
连接用户非必填,不能超过 50 个字符
用户口令用于检查数据是否正常可连接
  1. 点击 确定,完成实例的修改。

探活

适用场景

当用户不确定某个数据库实例是否存活时,可通过探活功能进行查看。

注意事项

确保所注册的实例 IP、端口、类型、用户名及密码正确。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 资源 > 数据库实例
  3. 选择某一实例,单击右侧的 探活 按钮;
  4. 如果出现 探活成功 的消息,说明该数据库实例在线。

后续处理

如果出现 探活失败,证明数据库实例连接异常。请检查注册的实例 IP、端口、类型、用户名及密码正确。

集群

集群

创建集群

适用场景

当用户实际应用场景需要多个计算节点和存储节点时,可通过创建集群对计算节点和存储节点进行管理维护。

前提条件

  • 已注册计算节点,并且一个计算节点只能属于一个集群。
  • 已注册存储节点,并且一个存储节点只能属于一个集群。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 集群 > 集群
  3. 单击右侧的 创建集群 按钮;
  4. 填写集群信息,具体参数见下表;
参数说明
集群名称必填,不能超过 50 个字符
集群描述非必填,不能超过 500 个字符
  1. 点击 确定,完成集群的创建。

删除集群

适用场景

当用户不再对集群进行管理维护时,可通过删除集群的方式,将集群删除。

注意事项

已使用集群不能删除,需先删除集群所关联的计算节点和存储节点再操作。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 集群 > 集群
  3. 选择某一集群,单击右侧的 删除 按钮;
  4. 弹出 提示 对话框,确认是否删除集群;
  5. 点击 确定,将永久删除该集群。

修改集群

适用场景

当用户需要对集群名称或集群描述进行变更时,可通过修改的方式进行相应的变更操作。

注意事项

根据实际变更进行修改即可。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 集群 > 集群
  3. 选择某一集群,单击右侧的 修改 按钮;
  4. 弹出 修改集群 对话框,根据对话框提示填写必填内容和可填内容;
参数说明
集群名称必填,不能超过 50 个字符
集群描述非必填,不能超过 500 个字符
  1. 点击 确定,完成集群的修改。

查看集群及组件信息

适用场景

当用户不确定集群关联的节点信息时,可通过查看信息功能进行查看。

注意事项

需先完成集群配置才可以看到相关的内容。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 集群 > 集群
  3. 选择某一集群,单击右侧的 信息 按钮;
  4. 弹出 集群及组件信息 对话框,对话框给出了计算节点、存储节点、逻辑库三方面的信息。

配置集群

适用场景

针对集群所关联的计算节点和存储节点,用户可通过配置功能,选择指定的计算节点和存储节点与集群绑定。

前提条件

  • 已创建计算节点
  • 已创建存储节点

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 集群 > 集群
  3. 选择某一集群,单击右侧的 配置 按钮;
  4. 弹出 集群配置 对话框,对计算节点和存储节点进行配置。

计算节点

注册计算节点

适用场景

当用户需要对计算节点统一管理时,可在计算节点中进行计算节点注册操作,节点注册后,可对节点进行监控管理。

注意事项

确保计算节点的 IP、端口正确,否则影响监控。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 集群 > 计算节点
  3. 单击右上角的 注册计算节点 按钮;
  4. 填写计算节点信息,具体参数见下表;
参数说明
IP必填,正常 IP 地址如:127.0.0.1
端口必填,正常端口地址 1~65535,如 3306
用户名必填,不能超过 50 个字符
口令非必填,不能超过 50 个字符
节点名称必填,不能超过 50 个字符
探活检查节点可用性
  1. 点击 确定,完成计算节点的注册。

后续处理

  1. 添加数据成功后,关闭添加弹窗并刷新列表数据。
  2. 如果提示数据已经存在,请重新添加。

删除计算节点

适用场景

当用户不再对计算节点管理维护或监控时,可通过计算节点中的删除功能将节点删除。

注意事项

不能删除已经关联集群的节点,如要删除需提前解除集群关联。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 集群 > 计算节点
  3. 选择某一计算节点,单击右侧的 删除 按钮;
  4. 弹出 提示 对话框,确认是否删除计算节点;
  5. 点击 确定,将永久删除该计算节点。

修改计算节点

适用场景

当计算节点信息需变更时,用户可通过计算节点中的修改功能对注册节点信息进行变更,例如:IP、端口、用户名、密码等。

注意事项

确保变更的内容与实际节点信息一致。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 集群 > 计算节点
  3. 选择某一计算节点,单击右侧的 修改 按钮;
  4. 弹出 修改计算节点 对话框,根据对话框提示填写必填内容和可填内容;
参数说明
IP必填,正常 IP 地址如:127.0.0.1
端口必填,正常端口地址 1~65535,如 3306
用户名必填,不能超过 50 个字符
口令非必填,不能超过 50 个字符
节点名称必填,不能超过 50 个字符
探活检查节点可用性
  1. 点击 确定,完成计算节点的修改。

探活

适用场景

当用户不确定某计算节点是否存活,可通过计算节点中的探活功能进行查看。

注意事项

确保节点的 IP、端口、用户名及密码正确。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 集群 > 计算节点
  3. 选择某一计算节点,单击右侧的 探活 按钮;
  4. 如果出现 探活成功 的消息,说明该计算节点在线。

后续处理

如果出现 探活失败,证明计算节点连接异常。请检查计算节点注册时,添加的 IP、端口是否正确。

节点参数

适用场景

当用户不了解某计算节点的执行的参数信息时,可通过计算节点中的参数功能进行查看。

注意事项

确保计算节点注册信息正确,否则无法查看。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 集群 > 计算节点
  3. 选择某一计算节点,单击右侧的 参数 按钮;
  4. 弹出对话框 节点参数,可以查看该计算节点的参数名和参数值。

存储节点

注册存储节点

适用场景

当计算节点需关联某数据源时,用户可通过注册一个存储节点用于关联计算节点使用。

前提条件

首先需要在数据库实例管理中注册实例。

注意事项

不建议中文名称,创建逻辑库不支持中文存储节点名称。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 集群 > 存储节点
  3. 单击右上角的 注册存储节点 按钮;
  4. 填写存储节点信息,具体参数见下表;
参数说明
所属实例非必选,从数据库实例列表中拉取数据,选取后会自动填充实例 IP、实例端口、实例类型
实例 IP必填,正常 IP 地址如:127.0.0.1
实例端口必填,正常端口地址 1~65535,如 3306
实例类型必选,需要下拉框选择 MySQL
节点名称必填,不能超过 50 个字符
用户名必填,不能超过 50 个字符
口令非必填,不能超过 50 个字符
数据库必填,不能超过 50 个字符
扩展参数(&分割)非必填,不能超过 500 个字符
URL 连接串自动拼接生成
探活检查节点可用性
  1. 点击 确定,完成存储节点的注册。

后续处理

  1. 添加数据成功后,关闭添加弹窗并刷新列表数据
  2. 如果提示数据已经存在,请重新添加。

删除存储节点

适用场景

当计算节点不再需要指定单个或多个存储节点时,用户可通过存储节点中的删除功能将存储节点删除。

注意事项

  • 不能删除已经关联集群的节点,如要删除需提先解除集群关联。
  • 删除存储节点,对实际数据库没有影响。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 集群 > 存储节点
  3. 选择某一存储节点,单击右侧的 删除 按钮;
  4. 弹出 提示 对话框,确认是否删除存储节点;
  5. 点击 确定,将永久删除该存储节点。

修改存储节点

适用场景

当存储节点信息发生变更时,用户可通过存储节点中的修改功能对变更的节点进行信息更新。

注意事项

所变更的信息正确无误。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 集群 > 存储节点
  3. 选择某一存储节点,单击右侧的 修改 按钮;
  4. 弹出 修改存储节点 对话框,根据对话框提示填写必填内容和可填内容;
参数说明
所属实例非必选,从数据库实例列表中拉取数据,选取后会自动填充实例 IP、实例端口、实例类型
实例 IP必填,正常 IP 地址如:127.0.0.1
实例端口必填,正常端口地址 1~65535,如 3306
实例类型必选,需要从下拉框选择 MySQL
节点名称必填,不能超过 50 个字符
用户名必填,不能超过 50 个字符
口令非必填,不能超过 50 个字符
数据库必填,不能超过 50 个字符
扩展参数(&分割)非必填,不能超过 500 个字符
URL 连接串自动生成
  1. 点击 确定,完成存储节点的修改。

探活

适用场景

当用户不确定某个存储节点是否存活时,可通过存储节点中的探活功能进行查看。

注意事项

确保配置的 IP、端口、类型、用户名、密码及数据库信息正确。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 集群 > 存储节点
  3. 选择某一存储节点,单击右侧的 探活 按钮;
  4. 如果出现 探活成功 的消息,说明该存储节点在线。

后续处理

如果出现 探活失败,证明存储节点连接异常。请检查注册存储节点时所填写的 IP、端口、类型、用户名、密码及数据库信息是否正确。

逻辑库

创建逻辑库

适用场景

通过对逻辑库操作,实现对真实数据源操作,用户可创建逻辑库并关联真实数据源。

前提条件

  • 完成集群创建且完成配置
  • 确保选择集群有计算节点

注意事项

  • 逻辑库名称不支持中文。
  • 不支持中文存储节点名称。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 集群 > 逻辑库
  3. 单击右上角的 创建逻辑库 按钮;
  4. 填写逻辑库信息,具体参数见下表;
参数说明
逻辑库名称必填,不能超过 50 个字符
所属集群列表集群筛选项自动填充
计算节点不可操作,只是展示
存储节点可从可选节点选择添加
  1. 点击 确定,完成逻辑库的创建。

后续处理

创建逻辑库失败怎么办?

确认是否使用中文名称或中文名称的存储节点,另外需要确保选择的存储节点是可用的。

删除逻辑库

适用场景

当用户不再使用逻辑库时,可通过逻辑库中的删除功能,将逻辑库删除,并不会删除数据源。

注意事项

当逻辑库被删除后无法恢复,只能重新创建。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 集群 > 逻辑库
  3. 选择某一逻辑库,单击右侧的 删除 按钮;
  4. 弹出 提示 对话框,确认是否删除逻辑库;
  5. 点击 确定,将永久删除该逻辑库。

管理存储节点

适用场景

当逻辑库关联的存储节点发生变更时,用户可通过逻辑库中的存储节点功能,对存储节点进行更新。

注意事项

确保要变更的数据源与实际保持一致。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 集群 > 逻辑库
  3. 选择某一逻辑库,单击右侧的 存储节点 按钮;
  4. 弹出 存储节点管理 对话框,选择相关信息;
  5. 点击 确定,将完成对存储节点的更新。

管理计算节点

适用场景

当逻辑库关联的计算节点发生变更时,用户可通过逻辑库中的计算节点功能,对计算节点进行更新。

注意事项

确保要变更的计算节点与实际保持一致。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 集群 > 逻辑库
  3. 选择某一逻辑库,单击右侧的 计算节点 按钮;
  4. 弹出 计算节点管理 对话框,确认并选择相关计算节点;
  5. 点击 确定,将完成对计算节点的更新。

插件

数据分片

新建分片表

适用场景

当用户的实际场景需要对数据库进行分片时,可在分片管理中创建分片规则,实现对真实数据源进行分片操作。

注意事项

  • 分片表不支持中文命名。
  • 创建分片表时不可以同时创建多个分片表。

前提条件

  • 需要已创建集群
  • 需要已创建逻辑库

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 插件 > 数据分片
  3. 单击右上角的 新建分片表 按钮;
  4. 填写分片表信息,具体参数见下表;
参数说明
集群从列表筛选中带过来进行填充
逻辑库从列表筛选中带过来进行填充
表类型必选,从表类型中选一项:- 分片表 - 广播表 - 绑定表
表语句必填,填写创建表语句
示例查看表语句示例
  1. 点击 确定,完成分片表的创建。

删除分片表

适用场景

当逻辑库中不再需要某一分片表时,可通过数据分片中删除功能,将分片表删除。

注意事项

逻辑库中删除分片表,实际库中并不会删除。

说明: 重复创建分片表,并不会影响实际库。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 插件 > 数据分片
  3. 选择某一分片表,单击右侧的 删除 按钮;
  4. 弹出 提示 对话框,确认是否删除分片表;
  5. 点击 确定,将永久删除该分片表。

修改分片表

适用场景

当用户的实际场景中需要对数据库分片表进行变更时,可通过数据分片中的修改功能,对指定表进行分片规则变更。

注意事项

变更前确保变更表与实际表一致。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 插件 > 数据分片
  3. 选择某一分片表,单击右侧的 修改 按钮;
  4. 弹出 修改分片表 对话框,根据对话框提示填写必填内容和可填内容;
参数说明
集群不能修改,从列表筛选中带过来进行填充
逻辑库不能修改,从列表筛选中带过来进行填充
表类型不能修改
必填,填写修改表语句
示例查看表语句示例
  1. 点击 确定,完成分片表的修改。

添加表结构

适用场景

用户创建分片表规则后,可针对该规则创建表结构。

注意事项

  • 所要创建的表结构与关联规则保持统一。
  • 不可以在广播表类型中添加分片表逻辑,必须按照对应的类型添加表结构。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 插件 > 数据分片
  3. 选择某一分片表,单击右侧的 添加表结构 按钮;
  4. 弹出 添加表结构 对话框,根据对话框提示填写必填内容和可填内容;
参数说明
集群不能修改,从列表筛选中带过来进行填充
逻辑库不能修改,从列表筛选中带过来进行填充
表类型不能修改
表语句必填,填写表结构语句
示例查看表结构示例
  1. 点击 确定,完成表结构的添加。

监控

使用须知

配置说明

SphereEx-Console 的配置文件在 conf 目录下。application.properties 文件是系统配置文件,users.yaml 是用户配置文件,logback.xml 是日志配置文件。

application.properties

常规配置:

  • server.port:运行端口
  • jwt.secret:JWT 认证密钥
  • jwt.expiration:JWT 认证超时时间
  • prometheus.server.address:Prometheus 地址

users.yaml

修改 users.yaml 文件来增加、删除、禁用用户。

如何启用监控功能

监控功能需要通过 Prometheus 的 node_exporter 来实现主机监控,以及通过 SphereEx 企业数据服务平台的 agent 模块来实现计算节点监控。

前提条件

启用监控功能前:

  • 请确认在监控主机上已经运行 node_exporter。

a. 使用者根据实际的操作系统下载对应的 node_exporter 组件,下载地址:https://prometheus.io/download/

b. 解压 node_exporter 安装包,执行 ./node_exporter 命令启动。

操作步骤

  1. 安装并启动 Prometheus, 假设运行地址为 192.168.1.100,端口 9090;
  2. 配置监控目标;

注意: 修改 Prometheus 的配置文件 prometheus.yml,在 scrape_configs 节点下的 static_configs.targets 中添加监控目标的主机、计算节点 IP 及端口。需要使用主机及计算节点实际的 IP 地址,不建议使用 127.0.0.1、localhost 等本地地址。

假设监控主机的 node_exporter 访问地址为 192.168.1.100:9100,计算节点的 agent 模块中 Prometheus 插件运行地址为 192.168.1.100:9000。

YAML
static_configs: - targets: ["192.168.1.100:9100", "192.168.1.100:9000"]
  1. 配置 application.properties 中 Prometheus 的地址。 prometheus.server.address=http://192.168.1.100:9090

主机

适用场景

用户对应用服务所在的主机进行监控,了解服务主机相关的各项指标信息。

前提条件

  • 被监控的主机已经安装了 node_exporter 采集主机监控数据,并且 Prometheus 服务需要配置收集该主机监控数据。
  • 主机中需要填写 node_exporter 监控端口。
  • SphereEx-Console 的 application.properties 配置文件配置了 Prometheus 服务地址。
  • Prometheus 服务已启动。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 监控 > 主机
  3. 单击主机列表中选定主机的 监控 按钮,进入该主机监控信息界面;
  4. 监控界面的右上角第一个下拉选项可以限定指定时间范围内的监控数据,第二个下拉选项可以指定波形图变化值计算的时间间隔大小。

计算节点

适用场景

用户对计算节点服务进行监控,了解计算节点相关的各项指标信息。

前提条件

  • 被监控的计算节点的 agent 开启了 Prometheus 监控,并且 Prometheus 服务的配置文件中需要使用计算节点的 IP 值和 agent 中开启的 Prometheus 监控端口值组成的配置数据采集计算节点监控数据。
  • 配置了计算节点信息,并且计算节点可用。
  • ShpereEx-Console 的 application.properties 配置文件配置了 Prometheus 服务地址。
  • Prometheus 服务已启动。

操作步骤

  1. 登录【SphereEx-Console】;
  2. 在控制台左上角选择 监控 > 计算节点
  3. 单击计算节点列表中 监控 按钮进入监控界面;
  4. 监控界面的右上角第一个下拉选项可以限定指定时间范围内的监控数据,第二个下拉选项可以指定变化率图表的计算时间间隔大小。

FAQ

问:Prometheus 中可以查看到监控数据,SphereEx-Console 没有监控数据,怎么办?

答:

  1. 请确认配置文件 conf/application.properties 中的 Prometheus 地址是否正确并且可以正常访问。
  2. 确保注册主机时填写了正确的监控端口。
  3. 确保计算节点探针开启了 Prometheus 监控。

问:SphereEx-Console 监控数据出现多条重复数据?

答:请检查 Prometheus 服务是否存在多个作业采集同一个监控地址数据配置。

400-900-2828 GitHub
产品
数据库增强引擎
SphereEx-DBPlusEngine
一键部署工具
SphereEx-Boot
可视化运维管理工具
SphereEx-Console
服务
ShardingSphere 商业服务
Pisanix 商业服务
产品
数据库增强引擎
SphereEx-DBPlusEngine
一键部署工具
SphereEx-Boot
可视化运维管理工具
SphereEx-Console
服务
ShardingSphere 商业服务
Pisanix 商业服务
关注我们
咨询专家
合作伙伴:中国信通院重庆大学ShardingSphere
Privacy PolicyTerms Of UseDisclaimerCookie PolicyDo Not Sell My Personal Information
wechat qrcode

扫码关注
微信公众号