pingcap/tidb-vision

TiDB集群可视化工具镜像文档

镜像概述

本镜像提供TiDB分布式数据库集群的可视化监控与管理能力，通过图形化界面直观呈现集群状态，助力用户高效掌握TiDB集群运行情况。

核心功能与特性

• 集群拓扑可视化：以图形化方式展示TiDB集群中TiDB Server、TiKV、PD等组件的分布及关联关系。
• 性能指标监控：实时采集并展示关键性能指标，如查询延迟、吞吐量、资源使用率等。
• 状态告警机制：支持自定义阈值告警，异常状态实时提醒。
• 数据可视化：通过图表（折线图、柱状图等）直观展示集群历史运行数据趋势。
• 集群配置管理：部分版本支持通过界面查看或修改TiDB集群基础配置。

使用场景

• TiDB集群日常运维监控
• 开发环境中TiDB集群调试与问题定位
• 生产环境集群性能优化分析
• 团队协作下的集群状态共享

使用方法

基础使用（Docker Run）

bash
docker run -d \
  --name tidb-visualization \
  -p 8080:8080 \
  -e TIDB_CLUSTER_ADDR="http://tidb-cluster-pd:2379" \
  -e TIDB_USER="root" \
  -e TIDB_PASSWORD="password" \
  tidb-visualization-tool:latest

说明：

• -p 8080:8080：映射容器内默认Web服务端口8080到主机
• TIDB_CLUSTER_ADDR：TiDB集群PD（Placement Driver）服务地址（必填）
• TIDB_USER/TIDB_PASSWORD：TiDB集群访问凭证（若集群开启认证）

环境变量配置

访问界面

启动容器后，通过浏览器访问 http://<主机IP>:8080 即可打开可视化界面，默认无需额外登录（部分版本支持配置界面访问密码）。

数据持久化（可选）

若需保留监控历史数据，可挂载数据卷：

bash
docker run -d \
  --name tidb-visualization \
  -p 8080:8080 \
  -v /host/path/data:/app/data \
  -e TIDB_CLUSTER_ADDR="http://tidb-cluster-pd:2379" \
  tidb-visualization-tool:latest

注：/app/data 为容器内默认数据存储路径。