📣新登場！TiDB Cloud BYOC、TiDB Cloud Filesystem、PostgreSQL-compatible TiDB Cloud Starter がパブリックプレビュー中。このページは自動翻訳されたものです。原文はこちらからご覧ください。
AI
開発者
ベストプラクティス
API

監視サーバーの構成をカスタマイズする

TiUPを使用して TiDB クラスターをデプロイすると、 TiUP はPrometheus、Grafana、Alertmanager などの監視サーバーもデプロイします。また、このクラスターをスケールアウトすると、 TiUP は新しいノードを監視範囲に追加します。

上記の監視サーバーの構成をカスタマイズするには、以下の手順に従って、TiDB クラスターの topology.yaml に関連する設定項目を追加します。

Prometheusの設定をカスタマイズする

現在、 TiUP はPrometheus ルールとスクレイプ設定ファイルのカスタマイズをサポートしています。

Prometheusルール設定をカスタマイズする

  1. ルール設定ファイルをカスタマイズし、 TiUP が配置されているマシンのディレクトリの下に配置します。

  2. topology.yaml ファイルで、カスタマイズされたルール設定ファイルのディレクトリにrule_dirを設定します。

    以下は、topology.yaml ファイル内の monitoring_servers の構成例です。

    # # Server configs are used to specify the configuration of Prometheus Server.
monitoring_servers:
  # # The ip address of the Monitoring Server.
- host: 127.0.0.1
  rule_dir: /home/tidb/prometheus_rule   # prometheus rule dir on TiUP machine

上記の構成が完了したら、TiDB クラスターをデプロイ、スケールアウト、スケールイン、またはリロードすると、 TiUPはrule_dir (たとえば、 /home/tidb/prometheus_rule ) からカスタマイズされたルール構成をロードし、それを Prometheus サーバーに送信してデフォルトのルール構成を置き換えます。

Prometheusのスクレイプ設定をカスタマイズする

  1. TiDB クラスターの topology.yaml ファイルを開きます。

  2. monitoring_servers構成で、 additional_scrape_confフィールドを追加します。

    以下は、topology.yaml ファイル内の monitoring_servers の構成例です。

    monitoring_servers:
- host: xxxxxxx
ssh_port: 22
port: 9090
deploy_dir: /tidb-deploy/prometheus-9090
data_dir: /tidb-data/prometheus-9090
log_dir: /tidb-deploy/prometheus-9090/log
external_alertmanagers: []
arch: amd64
os: linux
additional_scrape_conf:
  metric_relabel_configs:
    - source_labels: [__name__]
        separator: ;
        regex: tikv_thread_nonvoluntary_context_switches|tikv_thread_voluntary_context_switches|tikv_threads_io_bytes_total
        action: drop
    - source_labels: [__name__,name]
        separator: ;
        regex: tikv_thread_cpu_seconds_total;(tokio|rocksdb).+
        action: drop

上記の構成が完了したら、TiDB クラスターをデプロイ、スケールアウト、スケールイン、またはリロードすると、 TiUP はadditional_scrape_confフィールドの内容を Prometheus 設定ファイルの対応するパラメーターに追加します。

Prometheus external labels をカスタマイズする

TiUP v1.17.0 以降では、トポロジーファイルで Prometheus グローバル external_labels を設定できます。

  1. TiDB クラスターの topology.yaml ファイルを開きます。

  2. monitoring_servers 設定に external_labels フィールドを追加します。

    以下は、topology.yaml ファイル内の monitoring_servers の設定例です。

    monitoring_servers:
- host: xxxxxxx
  external_labels:
    environment: production
    region: us-east-1

  3. 予約済みラベル cluster または monitor は設定せず、__ で始まるラベル名も使用しないでください。すべてのラベル名は Prometheus のラベル命名規則に準拠する必要があります。

前述の設定が完了すると、TiDB クラスターをデプロイ、スケールアウト、スケールイン、またはリロードする際に、TiUP は external_labels フィールドを Prometheus グローバル external_labels 設定にレンダリングします。

このフィールドをサポートしていない以前のバージョンの TiUP を使用してトポロジーファイルを開くと、TiUP はこのフィールドを無視するのではなく、トポロジーの解析に失敗します。

Grafanaの設定をカスタマイズする

現在、 TiUP はGrafana ダッシュボードやその他の構成のカスタマイズをサポートしています。

Grafanaダッシュボードをカスタマイズする

  1. Grafana ダッシュボードの設定ファイルをカスタマイズし、 TiUPが配置されているマシンのディレクトリの下に配置します。

  2. topology.yaml ファイルで、カスタマイズされたダッシュボード設定ファイルのディレクトリにdashboard_dirを設定します。

    以下は、topology.yaml ファイル内の grafana_servers の構成例です。

    # # Server configs are used to specify the configuration of Grafana Servers.
grafana_servers:
  # # The ip address of the Grafana Server.
 - host: 127.0.0.1
 dashboard_dir: /home/tidb/dashboards   # grafana dashboard dir on TiUP machine

上記の構成が完了したら、TiDB クラスターをデプロイ、スケールアウト、スケールイン、またはリロードすると、 TiUPはdashboard_dir (たとえば、 /home/tidb/dashboards ) からカスタマイズされたダッシュボード構成をロードし、その構成を Grafana サーバーに送信してデフォルトのダッシュボード構成を置き換えます。

その他のGrafana設定をカスタマイズする

  1. TiDB クラスターの topology.yaml ファイルを開きます。

  2. grafana_servers構成に他の設定項目を追加します。

    以下は、topology.yaml ファイルの[log.file] levelフィールドとsmtpフィールドの構成例です。

    # # Server configs are used to specify the configuration of Grafana Servers.
grafana_servers:
# # The ip address of the Grafana Server.
- host: 127.0.0.1
    config:
    log.file.level: warning
    smtp.enabled: true
    smtp.host: {IP}:{port}
    smtp.user: example@pingcap.com
    smtp.password: {password}
    smtp.skip_verify: true

上記の構成が完了したら、TiDB クラスターをデプロイ、スケールアウト、スケールイン、またはリロードすると、 TiUP はconfigフィールドの内容を Grafana 設定ファイルgrafana.iniに追加します。

Alertmanager の設定をカスタマイズする

現在、 TiUP はAlertmanager のリスニング アドレスのカスタマイズをサポートしています。

TiUPによってデプロイされた Alertmanager は、デフォルトでalertmanager_servers.hostをリッスンします。プロキシを使用している場合は Alertmanager にアクセスできません。この問題に対処するには、クラスター設定ファイル topology.yaml にlisten_hostを追加してリッスンアドレスを指定します。推奨値は 0.0.0.0 です。

次の例では、 listen_hostフィールドを 0.0.0.0 に設定します。

alertmanager_servers:
  # # The ip address of the Alertmanager Server.
  - host: 172.16.7.147
    listen_host: 0.0.0.0
    # # SSH port of the server.
    ssh_port: 22

上記の構成が完了したら、TiDB クラスターをデプロイ、スケールアウト、スケールイン、またはリロードすると、 TiUP はlisten_hostフィールドの内容を Alertmanager 起動パラメータの--web.listen-addressに追加します。

このページは役に立ちましたか？