Skip to content

Commit

Permalink
Fix a typo in tidb-monitoring-api.md (#6829) (#6995)
Browse files Browse the repository at this point in the history
  • Loading branch information
ti-chi-bot authored Nov 25, 2021
1 parent 4762643 commit aea3e56
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions tidb-monitoring-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,14 @@ summary: Learn the API of TiDB monitoring services.

# TiDB Monitoring API

You can use the following two types of interfaces to monitor the TiDB cluster state:
You can use the following types of interfaces to monitor the TiDB cluster status:

- [The state interface](#running-status): this interface uses the HTTP interface to get the component information.
- [Storage information](#storage-information): this interface uses the HTTP interface to get the storage information of data tables.
- [The status interface](#use-the-status-interface): this interface uses the HTTP interface to get the component information. Using this interface, you can get the [running status](#running-status) of the current TiDB server and the [storage information](#storage-information) of a table.
- [The metrics interface](#use-the-metrics-interface): this interface uses Prometheus to record the detailed information of the various operations in components and views these metrics using Grafana.

## Use the state interface
## Use the status interface

The state interface monitors the basic information of a specific component in the TiDB cluster. It can also act as the monitor interface for Keepalive messages. In addition, the state interface for the Placement Driver (PD) can get the details of the entire TiKV cluster.
The status interface monitors the basic information of a specific component in the TiDB cluster. It can also act as the monitor interface for Keepalive messages. In addition, the status interface for the Placement Driver (PD) can get the details of the entire TiKV cluster.

### TiDB server

Expand All @@ -22,7 +21,7 @@ The state interface monitors the basic information of a specific component in th

### Running status

The following example uses `http://${host}:${port}/status` to get the current state of the TiDB server and to determine whether the server is alive. The result is returned in **JSON** format.
The following example uses `http://${host}:${port}/status` to get the current status of the TiDB server and to determine whether the server is alive. The result is returned in **JSON** format.

```bash
curl http://127.0.0.1:10080/status
Expand Down Expand Up @@ -81,7 +80,7 @@ curl http://127.0.0.1:10080/schema_storage/test
- Default port: `2379`
- Details about API names: see [PD API doc](https://download.pingcap.com/pd-api-v1.html)

The PD interface provides the state of all the TiKV servers and the information about load balancing. See the following example for the information about a single-node TiKV cluster:
The PD interface provides the status of all the TiKV servers and the information about load balancing. See the following example for the information about a single-node TiKV cluster:

```bash
curl http://127.0.0.1:2379/pd/api/v1/stores
Expand Down Expand Up @@ -117,7 +116,7 @@ curl http://127.0.0.1:2379/pd/api/v1/stores
## Use the metrics interface
The metrics interface monitors the state and performance of the entire TiDB cluster.
The metrics interface monitors the status and performance of the entire TiDB cluster.
- If you use other deployment ways, [deploy Prometheus and Grafana](/deploy-monitoring-services.md) before using this interface.
Expand Down

0 comments on commit aea3e56

Please sign in to comment.