homework-jianmu/docs/zh/17-operation/08-web.md

10 KiB
Raw Blame History

title description
Web 管理工具 基于 Web 的系统管理工具

简介

为了易于企业版用户更容易使用和管理数据库TDengine 3.0 企业版提供了一个全新的可视化组件 taosExplorer。用户能够在其中方便地管理数据库管理系统中中各元素数据库、超级表、子表的生命周期执行查询监控系统状态管理用户和授权完成数据备份和恢复与其它集群之间进行数据同步导出数据管理主题和流计算。

欲体验基于 Web 的 TDengine 系统管理能力,请联系 TDengine 市场或销售团队

部署服务

准备工作

  1. taosExplorer 没有独立的安装包,请使用 taosX 安装包进行安装。
  2. 在启动 taosExplorer 之前,请先确认 TDengine 集群已经正确设置并运行(即 taosd 服务taosAdapter 也已经正确设置和运行并与 TDengine 集群保持连接状态。如果想要使用数据备份和恢复或者数据同步功能,请确保 taosX 服务和 Agent 服务也已经正确设置和运行。

配置

在启动 taosExplorer 之前,请确保配置文件中的内容正确。

listen = "0.0.0.0:6060"
log_level = "info"
cluster = "http://localhost:6041"
x_api = "http://localhost:6050"

说明:

  • listen - taosExplorer 对外提供服务的地址
  • log_level - 日志级别,可选值为 "debug", "info", "warn", "error", "fatal"
  • cluster - TDengine集群的 taosadapter 地址
  • x_api - taosX 的服务地址

启动

然后启动 taosExplorer可以直接在命令行执行 taos-explorer 或者使用下面的 systemctl 脚本用 systemctl 来启动 taosExplorer 服务

[Unit]
Description=Explorer for TDengine
After=network-online.target
Wants=network-online.target

[Service]
Type=simple
ExecStart=/usr/bin/taos-explorer
Restart=always

[Install]
WantedBy=multi-user.target

问题排查

  1. 当通过浏览器打开taosExplorer站点遇到“无法访问此网站”的错误信息时请通过命令行登录taosExplorer所在机器并使用命令systemctl status taos-explorer.service检查服务的状态如果返回的状态是inactive请使用命令systemctl start taos-explorer.service启动服务。
  2. 如果需要获取taosExplorer的详细日志可通过命令journalctl -u taos-explorer

登录

在 TDengine 管理系统的登录页面,输入正确的用户名和密码后,点击登录按钮,即可登录。

说明:

  • 这里的用户,需要在所连接的 TDengine 中创建TDengine 默认的用户名和密码为root/taosdata;
  • 在 TDengine 中创建用户时,默认会设置用户的 SYSINFO 属性值为1, 表示该用户可以查看系统信息,只有 SYSINFO 属性为 1 的用户才能正常登录 TDengine 管理系统。

面板

taosExplorer 内置了一个简单的仪表盘展示以下集群信息,点击左侧功能列表中的 "面板" 可以启用此功能。

  • 默认的仪表盘会返回对应 Grafana 的安装配置向导
  • 配置过 Grafana 的仪表盘在点击' 面板' 时会跳转到对应的配置地址(该地址来源于 /profile 接口的返回值)

数据浏览器

点击功能列表的“数据浏览器”入口在“数据浏览器”中可以创建和删除数据库、创建和删除超级表和子表执行SQL语句查看SQL语句的执行结果。此外超级管理员还有对数据库的管理权限其他用户不提供该功能。

具体权限有:

1.查看(提供数据库/超级表/普通表的基本信息)

2.编辑 (编辑数据库/超级表/普通表的信息)

3.数据库管理权限 (仅限超级管理员,该操作可以给指定用户配置数据库管理权限)

4.删除 (删除数据库/超级表/普通表)

5.追加 (选择对应的数据库/超级表/普通表名称直接追加到右侧sql输入区域避免了手工输入

系统管理

点击功能列表中的“系统管理”入口,可以创建用户、对用户进行访问授权、以及删除用户。还能够对当前所管理的集群中的数据进行备份和恢复。也可以配置一个远程 TDengine 的地址进行数据同步。同时也提供了集群信息和许可证的信息以及代理信息以供查看。系统管理 菜单只有 root 用户才有权限看到

用户管理

点击“系统管理”后,默认会进入“用户”标签页。 在用户列表,可以查看系统中已存在的用户及其创建时间,并可以对用户进行启用、禁用,编辑(包括修改密码,数据库的读写权限等),删除等操作。 点击用户列表右上方的“+新增”按钮,即可打开“新增用户”对话框:

  1. 输入新增用户的用户名称,必填
  2. 输入新增用户的登录密码必填密码长度要求为8-16个字符且至少要满足以下4个条件中的3个大写字母小写字母数字特殊字符
  3. 选择新增用户对系统中已存在的数据库的读写权限,非必填,默认情况下,新增用户对所有已存在的数据库无读写权限
  4. 提写完成后,点击确定按钮,即可新增用户。

系统信息

点击“集群”标签后可以查看DNodes, MNodes和QNodes的状态、创建时间等信息并可以对以上节点进行新增和删除操作。

许可证管理

点击“许可证”标签后,可以查看系统和系统和各连接器的许可证信息。 点击位于“许可证”标签页右上角的“激活许可证”按钮,输入“激活码”和“连接器激活码”后,点击“确定”按钮,即可激活,激活码请联系 TDengine 客户成功团队获取。

数据订阅

本章节,将介绍如何在 TDengine 集群中,创建主题,并将其分享给其他用户,以及如何查看一个主题的消费者信息。

通过 Explorer, 您可以轻松地完成对数据订阅的管理,从而更好地利用 TDengine 提供的数据订阅能力。 点击左侧导航栏中的“数据订阅”,即可跳转至数据订阅配置管理页面。 您可以通过以下两种方式创建主题:使用向导和自定义 SQL 语句。通过自定义 SQL 创建主题时,您需要了解 TDengine 提供的数据订阅 SQL 语句的语法,并保证其正确性。

注: 对于数据订阅的详细说明可参考官方文档中关于“数据订阅”章节创建数据订阅之前需要先准备源数据库或源数据库包含相应的超级表或者表其中源数据库需配置wal_retention_period > 0 。

包括主题,消费者,共享主题和示例代码

创建主题

  1. 在“主题”标签页,点击“新增新主题”按钮以后,选择向导窗格,然后输入“主题名称”;
  2. 在“数据库”下拉列表中,选择相应的数据库;
  3. 在“类型”标签下,选择“数据库” 或 “超级表” 或 “子查询”,这里以默认值“数据库”为例;
  4. 然后点击“创建” 按钮,即可创建对应的主题。

分享主题

  1. 在“共享主题”标签页,在“主题“下拉列表中,选择将要分享的主题;
  2. 点击“添加可消费该主题的用户”按钮,然后在“用户名”下拉列表中选择相应的用户,然后点击“新增”,即可将该主题分享给此用户。

查看消费者信息

  1. 通过执行下一节“示例代码”所述的“完整实例”,即可消费共享主题
  2. 在“消费者”标签页,可查看到消费者的有关信息

示例代码

  1. 在“示例代码”标签页,在“主题“下拉列表中,选择相应的主题;
  2. 选择您熟悉的语言,然后您可以阅读以及使用这部分示例代码用来”创建消费“,”订阅主题“,通过执行 “完整实例”中的程序即可消费共享主题

流计算

通过 Explorer, 您可以轻松地完成对流的管理,从而更好地利用 TDengine 提供的流计算能力。 点击左侧导航栏中的“流计算”,即可跳转至流计算配置管理页面。 您可以通过以下两种方式创建流:流计算向导和自定义 SQL 语句。当前,通过流计算向导创建流时,暂不支持分组功能。通过自定义 SQL 创建流时,您需要了解 TDengine 提供的流计算 SQL 语句的语法,并保证其正确性。

注: 对于流计算的详细说明,可参考官方文档中关于“流式计算”章节,创建流计算之前需要先准备源数据库以及相应的超级表或表、输出的数据库。

流计算向导

  1. 点击“创建流计算”按钮以后,选择流计算向导窗格,然后输入“流名称”;
  2. 在“输出”部分,输入相应的“数据库”,“超级表”以及“子表前缀”;
  3. 在“源”部分,选择相应的“数据库”,然后根据具体情况,选择使用“超级表”或“表”:
  4. 如果使用“超级表“,请从“超级表”下拉列表中选择相应的超级表, 并在“字段设置”区域,选择相应的字段
  5. 如果使用“表“,请从“表”下拉列表中选择相应的表, 并在“字段设置”区域,选择相应的字段
  6. 对于窗口设置根据需要选择”SESSION“, "STATE"或"INTERVAL", 并配置相应的值;
  7. 对于”执行“部分选择相应的”触发器“类型并设置“Watermark”, "Ignore Expired", "DELETE_MARK", "FILL_HISTORY", "IGNORE UPDATE"
  8. 然后点击“创建” 按钮,即可创建对应的流计算。

使用 SQL 语句建流

  1. 点击“创建流计算”按钮以后选择流计算SQL窗格然后输入类似如下的SQL语句(反引号内为源数据库以及相应的超级表或表、输出的数据库,请按您的环境更新反引号内的内容)
CREATE STREAM `test_stream` TRIGGER WINDOW_CLOSE IGNORE EXPIRED 1 INTO `db_name`.`stable1` SUBTABLE(CONCAT('table1',tbname)) AS SELECT count(*) FROM `test_db`.`stable_name` PARTITION BY tbname INTERVAL(1m)
  1. 点击“创建”按钮,即可创建对应的流计算。