跳至主要內容

可视化控制台部署

大约 7 分钟

可视化控制台部署

可视化控制台是IoTDB配套工具之一。它用于数据库部署实施、运维管理、应用开发各阶段的官方应用工具体系，让数据库的使用、运维和管理更加简单、高效，真正实现数据库低成本的管理和运维。本文档将帮助您安装Workbench。

安装准备

准备内容名称版本要求官方链接
操作系统Windows或Linux--
安装环境JDK需要 >= V1.8.0_162（推荐使用 11 或者 17，下载时请根据机器配置选择ARM或x64安装包）https://www.oracle.com/java/technologies/downloads/
相关软件Prometheus需要 >=V2.30.3https://prometheus.io/download/
数据库IoTDB需要>=V1.2.0企业版您可联系商务或技术支持获取
控制台IoTDB-Workbench-<version>-您可根据附录版本对照表进行选择后联系商务或技术支持获取

安装步骤

步骤一：IoTDB 开启监控指标采集

  1. 打开监控配置项。IoTDB中监控有关的配置项默认是关闭的，在部署监控面板前，您需要打开相关配置项（注意开启监控配置后需要重启服务）。

    配置项所在配置文件配置说明
    cn_metric_reporter_listconf/iotdb-confignode.properties将配置项取消注释，值设置为PROMETHEUS
    cn_metric_level将配置项取消注释，值设置为IMPORTANT
    cn_metric_prometheus_reporter_port将配置项取消注释，可保持默认设置9091，如设置其他端口，不与其他端口冲突即可
    dn_metric_reporter_listconf/iotdb-datanode.properties将配置项取消注释，值设置为PROMETHEUS
    dn_metric_level将配置项取消注释，值设置为IMPORTANT
    dn_metric_prometheus_reporter_port将配置项取消注释，可保持默认设置9092，如设置其他端口，不与其他端口冲突即可
    dn_metric_internal_reporter_type将配置项取消注释，值设置为IOTDB
    enable_audit_logconf/iotdb-common.properties将配置项取消注释，值设置为true
    audit_log_storage将配置项取消注释
    audit_log_operation将配置项取消注释

  2. 重启所有节点。修改3个节点的监控指标配置后，可重新启动所有节点的confignode和datanode服务：

    ./sbin/stop-standalone.sh      #先停止confignode和datanode
./sbin/start-confignode.sh  -d #启动confignode
./sbin/start-datanode.sh  -d   #启动datanode

  3. 重启后，通过客户端确认各节点的运行状态，若状态都为Running，则为配置成功：

步骤二：安装、配置Prometheus监控

  1. 确保Prometheus安装完成(官方安装说明可参考：https://prometheus.io/docs/introduction/first_steps/)

  2. 解压安装包，进入解压后的文件夹：

    tar xvfz prometheus-*.tar.gz
cd prometheus-*

  3. 修改配置。修改配置文件prometheus.yml如下

    1. 新增confignode任务收集ConfigNode的监控数据
    2. 新增datanode任务收集DataNode的监控数据
    global:
scrape_interval: 15s 
evaluation_interval: 15s 
scrape_configs:
- job_name: "prometheus"
    static_configs:
    - targets: ["localhost:9090"]
- job_name: "confignode"
    static_configs:
    - targets: ["iotdb-1:9091","iotdb-2:9091","iotdb-3:9091"]
    honor_labels: true
- job_name: "datanode"
    static_configs:
    - targets: ["iotdb-1:9092","iotdb-2:9092","iotdb-3:9092"]
    honor_labels: true

  4. 启动Prometheus。Prometheus 监控数据的默认过期时间为15天，在生产环境中，建议将其调整为180天以上，以对更长时间的历史监控数据进行追踪，启动命令如下所示：

    ./prometheus --config.file=prometheus.yml --storage.tsdb.retention.time=180d

  5. 确认启动成功。在浏览器中输入 http://IP:port，进入Prometheus，点击进入Status下的Target界面，当看到State均为Up时表示配置成功并已经联通。

步骤三：安装Workbench

Windows版：

  1. 进入iotdb-Workbench-<version>的config目录

  2. 修改Workbench配置文件：进入config文件夹下修改配置文件application-prod.properties。若您是在本机安装则无需修改，若是部署在服务器上则需修改IP地址

    Workbench可以部署在本地或者云服务器，只要能与 IoTDB 连接即可

    配置项修改前修改后
    pipe.callbackUrlpipe.callbackUrl=http://127.0.0.1pipe.callbackUrl=http://<部署Workbench的IP地址>

  3. 启动程序：请在IoTDB-Workbench-<version>的sbin文件夹下执行启动命令

    # 后台启动Workbench
start.bat -d

  4. 可以通过jps命令进行启动是否成功，如图所示即为启动成功：

  5. 验证是否成功：浏览器中打开:"http://服务器ip:配置文件中端口"进行访问，例如:"http://127.0.0.1:9190"，当出现登录界面时即为成功

Linux版：

  1. 进入IoTDB-Workbench-<version>目录

  2. 修改Workbench配置：进入config文件夹下修改配置文件application-prod.properties。若您是在本机安装则无需修改，若是部署在服务器上则需修改IP地址

    Workbench可以部署在本地或者云服务器，只要能与 IoTDB 连接即可

    配置项修改前修改后
    pipe.callbackUrlpipe.callbackUrl=http://127.0.0.1pipe.callbackUrl=http://<部署Workbench的IP地址>

  3. 启动程序：请在IoTDB-Workbench-<version>的sbin文件夹下执行启动命令

    # 后台启动Workbench
./start.sh -d

  4. 可以通过jps命令进行启动是否成功,如图所示即为启动成功：

  5. 验证是否成功：浏览器中打开 "http://服务器ip:配置文件中端口"进行访问，例如:"http://127.0.0.1:9190"，当出现登录界面时即为成功

步骤四：配置实例信息

  1. 配置实例信息：您只需要填写以下信息即可连接到实例
字段名称是否为必填项字段含义默认值
连接类型是不同连接类型连接所填内容不同，支持选择“单机、集群、双活”-
实例名称是您可根据名称对不同实例进行区分，最多输入 50 个字符-
实例信息是填写数据库的地址（iotdb/conf/iotdb-datanode.properties 文件中 dn_rpc_address 字段）以及端口号（dn_rpc_port字段）注：对于集群和双活点击“+”支持输入多个实例信息-
Prometheus 信息否填写“http://<Prometheus的IP地址>:<Prometheus的端口号>/api/v1/query”即可通过首页查看部分监控信息，推荐您进行配置使用-
用户名是填写IoTDB的用户名，支持输入 4～32 个字符，可使用英文大小写字母、数字、特殊字符（!@#$%^&*()_+-=）root
密码否填写IoTDB的密码，为了保证数据库的安全我们不会对密码进行保存，请您在每次连接实例或测试时自行填写root
  1. 测试所填信息的准确性：您可以通过点击“测试”按钮对实例信息进行连接测试

附录：IoTDB与控制台版本对照表

控制台版本号版本说明可支持IoTDB版本
V1.4.0新增树模型展示及国际化V1.3.2及以上版本
V1.3.1分析功能新增分析方式，优化导入模版等功能V1.3.2及以上版本
V1.3.0新增数据库配置功能，优化部分版本细节V1.3.2及以上版本
V1.2.6优化各模块权限控制功能V1.3.1及以上版本
V1.2.5可视化功能新增“常用模版”概念，所有界面优化补充页面缓存等功能V1.3.0及以上版本
V1.2.4计算功能新增“导入、导出”功能，测点列表新增“时间对齐”字段V1.2.2及以上版本
V1.2.3首页新增“激活详情”，新增分析等功能V1.2.2及以上版本
V1.2.2优化“测点描述”展示内容等功能V1.2.2及以上版本
V1.2.1数据同步界面新增“监控面板”，优化Prometheus提示信息V1.2.2及以上版本
V1.2.0全新Workbench版本升级V1.2.0及以上版本
上次编辑于:

Copyright © 2024 Timecho Limited All rights reserved.