TiDBクラスタの監視サービスをデプロイ

このドキュメントは、TiDB の監視およびアラート サービスを手動で展開したいユーザーを対象としています。

TiUP を使用して TiDB クラスターをデプロイすると、監視サービスとアラート サービスが自動的にデプロイされるため、手動でデプロイする必要はありません。

Prometheus と Grafana をデプロイ

TiDB クラスターのトポロジーが次のようになっているとします。

ステップ 1: バイナリ パッケージをダウンロードする

# Downloads the package.
wget https://download.pingcap.org/prometheus-2.27.1.linux-amd64.tar.gz
wget https://download.pingcap.org/node_exporter-v1.3.1-linux-amd64.tar.gz
wget https://download.pingcap.org/grafana-6.1.6.linux-amd64.tar.gz

# Extracts the package.
tar -xzf prometheus-2.27.1.linux-amd64.tar.gz
tar -xzf node_exporter-v1.3.1-linux-amd64.tar.gz
tar -xzf grafana-6.1.6.linux-amd64.tar.gz

ステップ 2: Node1、Node2、Node3、および Node4 でnode_exporterを開始する

cd node_exporter-v1.3.1-linux-amd64

# Starts the node_exporter service.
$ ./node_exporter --web.listen-address=":9100" \
    --log.level="info" &

ステップ 3: Node1 で Prometheus を開始する

Prometheus 構成ファイルを編集します。

cd prometheus-2.27.1.linux-amd64 &&
vi prometheus.yml

...

global:
  scrape_interval:     15s  # By default, scrape targets every 15 seconds.
  evaluation_interval: 15s  # By default, scrape targets every 15 seconds.
  # scrape_timeout is set to the global default value (10s).
  external_labels:
    cluster: 'test-cluster'
    monitor: "prometheus"

scrape_configs:
  - job_name: 'overwritten-nodes'
    honor_labels: true  # Do not overwrite job & instance labels.
    static_configs:
    - targets:
      - '192.168.199.113:9100'
      - '192.168.199.114:9100'
      - '192.168.199.115:9100'
      - '192.168.199.116:9100'
      - '192.168.199.117:9100'
      - '192.168.199.118:9100'

  - job_name: 'tidb'
    honor_labels: true  # Do not overwrite job & instance labels.
    static_configs:
    - targets:
      - '192.168.199.113:10080'

  - job_name: 'pd'
    honor_labels: true  # Do not overwrite job & instance labels.
    static_configs:
    - targets:
      - '192.168.199.113:2379'
      - '192.168.199.114:2379'
      - '192.168.199.115:2379'

  - job_name: 'tikv'
    honor_labels: true  # Do not overwrite job & instance labels.
    static_configs:
    - targets:
      - '192.168.199.116:20180'
      - '192.168.199.117:20180'
      - '192.168.199.118:20180'

...

プロメテウス サービスを開始します。

$ ./prometheus \
    --config.file="./prometheus.yml" \
    --web.listen-address=":9090" \
    --web.external-url="http://192.168.199.113:9090/" \
    --web.enable-admin-api \
    --log.level="info" \
    --storage.tsdb.path="./data.metrics" \
    --storage.tsdb.retention="15d" &

ステップ 4: Node1 で Grafana を開始する

Grafana 構成ファイルを編集します。

cd grafana-6.1.6 &&
vi conf/grafana.ini

...

[paths]
data = ./data
logs = ./data/log
plugins = ./data/plugins
[server]
http_port = 3000
domain = 192.168.199.113
[database]
[session]
[analytics]
check_for_updates = true
[security]
admin_user = admin
admin_password = admin
[snapshots]
[users]
[auth.anonymous]
[auth.basic]
[auth.ldap]
[smtp]
[emails]
[log]
mode = file
[log.console]
[log.file]
level = info
format = text
[log.syslog]
[event_publisher]
[dashboards.json]
enabled = false
path = ./data/dashboards
[metrics]
[grafana_net]
url = https://grafana.net

...

Grafana サービスを開始します。

./bin/grafana-server \
    --config="./conf/grafana.ini" &

Grafana の構成

このセクションでは、Grafana を構成する方法について説明します。

ステップ 1: Prometheus データ ソースを追加する

1. Grafana Web インターフェイスにログインします。

   • デフォルトのアドレス: http://localhost:3000

   • デフォルトのアカウント: 管理者

   • デフォルトのパスワード: 管理者

   ノート：

   [**パスワードの変更]**ステップでは、[スキップ]を選択できます。

2. Grafana サイドバー メニューで、[Configuration / コンフィグレーション] 内の [データ ソース] をクリックします。

3. [**データ ソースの追加] を**クリックします。

4. データ ソース情報を指定します。

   • データ ソースの名前を指定します。
   • [**タイプ]**で [ Prometheus]を選択します。
   • URLには、Prometheus アドレスを指定します。
   • 必要に応じて他のフィールドを指定します。

5. [**追加]**をクリックして、新しいデータ ソースを保存します。

ステップ 2: Grafana ダッシュボードをインポートする

PDサーバー、TiKVサーバー、および TiDBサーバーの Grafana ダッシュボードをインポートするには、それぞれ次の手順を実行します。

1. Grafana ロゴをクリックして、サイドバー メニューを開きます。

2. サイドバー メニューで、[ダッシュボード] -> [インポート] をクリックして、[ダッシュボードのインポート] ウィンドウを開きます。

3. [ **.json ファイルのアップロード]**をクリックして、JSON ファイルをアップロードします ( pingcap/tidb 、 tikv/tikv 、およびtikv/pdから TiDB Grafana 構成ファイルをダウンロードします)。

   ノート：

   TiKV、PD、および TiDB ダッシュボードの場合、対応する JSON ファイルはtikv_summary.json 、 tikv_details.json 、 tikv_trouble_shooting.json 、 pd.json 、 tidb.json 、およびtidb_summary.jsonです。

4. [**ロード]**をクリックします。

5. Prometheus データ ソースを選択します。

6. [**インポート]**をクリックします。 Prometheus ダッシュボードがインポートされます。

コンポーネント メトリックをビューする

上部のメニューで [新しいダッシュボード] をクリックし、表示するダッシュボードを選択します。

クラスター コンポーネントの次のメトリックを取得できます。

• TiDBサーバー:

  • レイテンシーとスループットを監視するためのクエリ処理時間
  • DDL プロセスの監視
  • TiKV クライアント関連の監視
  • PD クライアント関連のモニタリング

• PDサーバー:

  • コマンドが実行された合計回数
  • 特定のコマンドが失敗した合計回数
  • コマンドが成功する期間
  • コマンドが失敗する期間
  • コマンドが終了して結果を返す期間

• TiKVサーバー:

  • ガベージ コレクション (GC) の監視
  • TiKV コマンドが実行された合計回数
  • スケジューラがコマンドを実行する期間
  • Raftの提案コマンドの合計回数
  • Raftがコマンドを実行する期間
  • Raftコマンドが失敗した合計回数
  • Raftが準備完了状態を処理した合計回数