README
¶
TiDB Dashboard
TiDB Dashboard is a Web UI for monitoring, diagnosing and managing the TiDB cluster.
Documentation
Question, Suggestion
Feel free to open GitHub issues for questions, support and suggestions.
You may also consider to reach out on the TiDB Internals forum if you encounter any problems about TiDB development.
For Chinese users, you can visit the PingCAP official user forum AskTUG.com to make life easier.
Getting Started
The most easy way to use TiDB Dashboard with an existing TiDB cluster is to use the one embedded into PD: http://127.0.0.1:2379/dashboard. You need PD master branch or 4.0+ version to use TiDB Dashboard.
Note: The TiDB Dashboard inside PD may be not up to date. To play with latest TiDB Dashboard, build it from source (see next section).
Contributing & Developing
Checkout our help wanted issues for a list of recommended tasks, in which we have also marked the difficulty level.
See CONTRIBUTING.md for a detailed step-by-step contributing guide, or steps to build TiDB Dashboard from source.
If you need any help, feel free to reach out on the TiDB Internals forum.
Thank you to all the people who already contributed to TiDB Dashboard!
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
Architecture
This repository contains both Dashboard HTTP API and Dashboard UI. Dashboard HTTP API is placed in
pkg/ directory, written in Golang. Dashboard UI is placed in ui/ directory, powered by React.
TiDB Dashboard can also be integrated into PD, as follows:
License
Copyright 2020 PingCAP, Inc.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
pkg
|
|
|
apiserver/conprof
conprof is short for continuous profiling
|
conprof is short for continuous profiling |
|
keyvisual/decorator
Package decorator contains all implementations of LabelStrategy.
|
Package decorator contains all implementations of LabelStrategy. |
|
keyvisual/input
Package input defines several different data inputs.
|
Package input defines several different data inputs. |
|
keyvisual/matrix
Package matrix abstracts the source data as Plane, and then pixelates it into a matrix for display on the front end.
|
Package matrix abstracts the source data as Plane, and then pixelates it into a matrix for display on the front end. |
|
keyvisual/storage
Package storage stores the input axes in order, and can get a Plane by time interval.
|
Package storage stores the input axes in order, and can get a Plane by time interval. |
|
scripts
module
|
|
|
tests
|
|
|
ui
module
|
|
|
util
module
|
|
|
client/pdclient
Package pdclient provides a flexible PD API access to any PD instance.
|
Package pdclient provides a flexible PD API access to any PD instance. |
|
client/schedulingclient
Package schedulingclient provides a flexible Scheduling API access to any Scheduling instance.
|
Package schedulingclient provides a flexible Scheduling API access to any Scheduling instance. |
|
client/ticdcclient
Package ticdcclient provides a flexible TiCDC API access to any TiCDC instance.
|
Package ticdcclient provides a flexible TiCDC API access to any TiCDC instance. |
|
client/tidbclient
Package tidbclient provides a flexible TiDB API access to any TiDB instance.
|
Package tidbclient provides a flexible TiDB API access to any TiDB instance. |
|
client/tidbclient/tidbproxy
Package tidbproxy provides a TiDB cluster proxy service.
|
Package tidbproxy provides a TiDB cluster proxy service. |
|
client/tiflashclient
Package tiflashclient provides a flexible TiFlash API access to any TiFlash instance.
|
Package tiflashclient provides a flexible TiFlash API access to any TiFlash instance. |
|
client/tikvclient
Package tikvclient provides a flexible TiKV API access to any TiKV instance.
|
Package tikvclient provides a flexible TiKV API access to any TiKV instance. |
|
client/tiproxyclient
Package tiproxyclient provides a flexible TiProxy API access to any TiProxy instance.
|
Package tiproxyclient provides a flexible TiProxy API access to any TiProxy instance. |
|
client/tsoclient
Package tsoclient provides a flexible TSO API access to any TSO instance.
|
Package tsoclient provides a flexible TSO API access to any TSO instance. |
|
distro
Package distro provides a type-safe distribution resource framework.
|
Package distro provides a type-safe distribution resource framework. |
|
israce
Package israce reports if the Go race detector is enabled.
|
Package israce reports if the Go race detector is enabled. |
|
jsonserde
Package jsonserde sets default config for json-iterator.
|
Package jsonserde sets default config for json-iterator. |
|
proxy
Package proxy provides a TCP reverse proxy.
|
Package proxy provides a TCP reverse proxy. |