-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Create monitor-deploy.md and tidb-monitoring-api.md #3196
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
1fe6ceb
Create monitor-deploy.md
xiaoyangwang5 90a39ee
Update TOC.md
xiaoyangwang5 40de1eb
Update monitor-deploy.md
xiaoyangwang5 f8b50e4
Delete monitor-a-tidb-cluster.md
xiaoyangwang5 1879b02
Update monitor-deploy.md
xiaoyangwang5 e9f7b3c
Rename monitor-deploy.md to deploy-monitoring-services.md
xiaoyangwang5 8b85ef0
Update TOC.md
xiaoyangwang5 27514eb
add #3186 document
TomShawn 991888b
add alias
TomShawn c227132
Update mysql-compatibility.md
TomShawn d9fc3bd
Merge branch 'docs-special-week' into xiaoyangwang5-patch-2
TomShawn 2ffb700
Update deploy-monitoring-services.md
kissmydb 126d58c
整理监控报警相关 TOC
kissmydb ec14751
Update deploy-monitoring-services.md
TomShawn 0625113
Update tidb-monitoring-api.md
kissmydb 6bdd0f0
Update tidb-monitoring-api.md
TomShawn 4e80465
Merge branch 'docs-special-week' into xiaoyangwang5-patch-2
kissmydb File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| --- | ||
| title: TiDB 集群监控 API | ||
| category: how-to | ||
| aliases: ['/docs-cn/dev/monitor-a-tidb-cluster/','/docs-cn/dev/how-to/monitor/monitor-a-cluster/'] | ||
| --- | ||
|
|
||
| # TiDB 集群监控 API | ||
|
|
||
| TiDB 提供了以下两种接口来监控集群状态: | ||
|
|
||
| - [状态接口](#使用状态接口):通过 HTTP 接口对外汇报组件的信息。 | ||
| - [Metrics 接口](#使用-metrics-接口):使用 Prometheus 记录组件中各种操作的详细信息,使用 Grafana 进行可视化展示。 | ||
|
|
||
| ## 使用状态接口 | ||
|
|
||
| 状态接口用于监控组件的一些基本信息,并且可以作为 keepalive 的监测接口。另外,通过 PD 的状态接口可以看到整个 TiKV 集群的详细信息。 | ||
|
|
||
| ### TiDB Server | ||
|
|
||
| - TiDB API 地址:`http://${host}:${port}` | ||
| - 默认端口:10080 | ||
|
|
||
| 以下示例中,通过访问 `http://${host}:${port}/status` 获取当前 TiDB Server 的状态,并判断该 TiDB Server 是否存活。结果以 **JSON** 格式返回: | ||
|
|
||
| {{< copyable "shell-regular" >}} | ||
|
|
||
| ```bash | ||
| curl http://127.0.0.1:10080/status | ||
| ``` | ||
|
|
||
| ``` | ||
| { | ||
| connections: 0, # 当前 TiDB Server 上的客户端连接数 | ||
| version: "5.7.25-TiDB-v4.0.0-rc-141-g7267747ae", # TiDB 版本号 | ||
| git_hash: "7267747ae0ec624dffc3fdedb00f1ed36e10284b" # TiDB 当前代码的 Git Hash | ||
| } | ||
| ``` | ||
|
|
||
| ### PD Server | ||
|
|
||
| - PD API 地址:`http://${host}:${port}/pd/api/v1/${api_name}` | ||
| - 默认端口:2379 | ||
| - 各类 `api_name` 详细信息:参见 [PD API Doc](https://download.pingcap.com/pd-api-doc.html) | ||
|
|
||
| 通过该接口可以获取当前所有 TiKV 节点的状态以及负载均衡信息。下面以一个单节点的 TiKV 集群为例,说明用户需要了解的信息: | ||
|
|
||
| {{< copyable "shell-regular" >}} | ||
|
|
||
| ```bash | ||
| curl http://127.0.0.1:2379/pd/api/v1/stores | ||
| ``` | ||
|
|
||
| ``` | ||
| { | ||
| "count": 1, # TiKV 节点数量 | ||
| "stores": [ # TiKV 节点的列表 | ||
| # 集群中单个 TiKV 节点的信息 | ||
| { | ||
| "store": { | ||
| "id": 1, | ||
| "address": "127.0.0.1:20160", | ||
| "version": "4.0.0-rc.2", | ||
| "status_address": "172.16.5.90:20382", | ||
| "git_hash": "2fdb2804bf8ffaab4b18c4996970e19906296497", | ||
| "start_timestamp": 1590029618, | ||
| "deploy_path": "/data2/tidb_test/v4.0.rc.2/tikv-20372/bin", | ||
| "last_heartbeat": 1590030038949235439, | ||
| "state_name": "Up" | ||
| }, | ||
| "status": { | ||
| "capacity": "3.581TiB", # 存储总容量 | ||
| "available": "3.552TiB", # 存储剩余容量 | ||
| "used_size": "31.77MiB", | ||
| "leader_count": 174, | ||
| "leader_weight": 1, | ||
| "leader_score": 174, | ||
| "leader_size": 174, | ||
| "region_count": 531, | ||
| "region_weight": 1, | ||
| "region_score": 531, | ||
| "region_size": 531, | ||
| "start_ts": "2020-05-21T10:53:38+08:00", | ||
| "last_heartbeat_ts": "2020-05-21T11:00:38.949235439+08:00", | ||
| "uptime": "7m0.949235439s" | ||
| } | ||
| } | ||
| ] | ||
| ``` | ||
|
|
||
| ## 使用 metrics 接口 | ||
|
|
||
| Metrics 接口用于监控整个集群的状态和性能。 | ||
|
|
||
| - 如果使用 TiDB Ansible 部署 TiDB 集群,监控系统(Prometheus 和 Grafana)会同时部署。 | ||
| - 如果使用其他方式部署 TiDB 集群,在使用 metrics 接口前,需先[部署 Prometheus 和 Grafana](/deploy-monitoring-services.md)。 | ||
|
|
||
| 成功部署 Prometheus 和 Grafana 之后,[配置 Grafana](/deploy-monitoring-services.md)。 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.