https://github.com/pingcap/tidb-dashboard

A Web UI for monitoring, diagnosing and managing the TiDB cluster.
https://github.com/pingcap/tidb-dashboard

dashboard tidb troubleshooting ui

Last synced: 1 day ago
JSON representation

A Web UI for monitoring, diagnosing and managing the TiDB cluster.

• Host: GitHub
• URL: https://github.com/pingcap/tidb-dashboard
• Owner: pingcap
• License: apache-2.0
• Created: 2019-12-30T04:24:19.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-12-18T15:22:54.000Z (9 days ago)
• Last Synced: 2024-12-18T16:35:18.191Z (9 days ago)
• Topics: dashboard, tidb, troubleshooting, ui
• Language: TypeScript
• Homepage: https://docs.pingcap.com/tidb/stable/dashboard-intro
• Size: 31.5 MB
• Stars: 179
• Watchers: 17
• Forks: 135
• Open Issues: 139
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# TiDB Dashboard

[![GitHub license](https://img.shields.io/github/license/pingcap/tidb-dashboard?style=flat-square)](https://github.com/pingcap/tidb-dashboard/blob/master/LICENSE)

TiDB Dashboard is a Web UI for monitoring, diagnosing and managing the TiDB cluster.

## Documentation

- [Product User Manual (English)](https://docs.pingcap.com/tidb/stable/dashboard-intro)

- [Product User Manual (Chinese)](https://docs.pingcap.com/zh/tidb/stable/dashboard-intro)

- [FAQ (English)](https://docs.pingcap.com/tidb/stable/dashboard-faq)

- [FAQ (Chinese)](https://docs.pingcap.com/zh/tidb/stable/dashboard-faq)

## Question, Suggestion

Feel free to [open GitHub issues](https://github.com/pingcap/tidb-dashboard/issues/new/choose)

for questions, support and suggestions.

You may also consider to reach out on the [TiDB Internals forum](https://internals.tidb.io/) 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]: . 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](https://github.com/pingcap/tidb-dashboard/issues?q=is%3Aopen+label%3Astatus%2Fhelp-wanted+sort%3Aupdated-desc)

for a list of recommended tasks, in which we have also marked the difficulty level.

See [CONTRIBUTING.md](./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](https://internals.tidb.io/).

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:

![](etc/arch_overview.svg)

## License

[Apache License](/LICENSE)

Copyright 2020 PingCAP, Inc.

[pd]: https://github.com/pingcap/pd

[asktug.com]: https://asktug.com/