ノード監視の設定
このガイドでは、Kaiaノードを監視するためにPrometheusとGrafanaをセットアップする方法を説明します。
1. カイアのメトリック設定
Kaiaはメトリック・エクスポート用に以下のフラグを提供しています:
--metric:メトリックの記録を有効にする。このフラグは通常、--prometheusフラグと併用される。--prometheus:記録したメトリクスをPrometheusサーバーにエクスポートできるようにする。このフラグは通常、--metricフラグと一緒に使われる。--prometheusport:Prometheus メトリクスのポートを指定します。デフォルトは61001である。
メトリクスと Prometheus のエクスポートを有効にするには、.conf ファイルで METRICS と PROMETHEUS の両方を 1 に設定します:
METRICS=1PROMETHEUS=1
2. プロメテウスのセットアップ
プロメテウスは、モニタリングの中央システムとして機能し、ノードからリアルタイムデータを抽出してアーカイブする堅牢なデータマイニング機能を提供します。
:::note[Prometheus ハードウェア要件]
プロメテウスをセットアップする前に、お使いのシステムが以下のハードウェア要件を満たしていることを確認してください:
- プロセッサ: 少なくとも2CPU
- メモリ: 最低4GB RAM
- ストレージ: 少なくとも20GBのディスク空き容量
:::
2.1 Prometheusのインストール
以下の手順は、Prometheus の手動インストール手順の概要です。具体的な手順については、お使いのオペレーティングシステムを選択してください。 Prometheusのインストールに関する詳細は、Prometheus公式ドキュメントを参照してください。
- あなたのアーキテクチャに適した最新のPrometheusリリース(例:darwin-amd64)をPrometheus公式ダウンロードページからダウンロードしてください。このガイドでは、バージョン2.53.3を例にしています。
curl -LO https://github.com/prometheus/prometheus/releases/download/v2.53.3/prometheus-2.53.3.darwin-arm64.tar.gz
wget https://github.com/prometheus/prometheus/releases/download/v2.53.3/prometheus-2.53.3.linux-amd64.tar.gz
- ダウンロードしたアーカイブを展開し、バイナリを
/usr/local/bin/に移動してインストールする:
tar xvfz prometheus-2.53.3.darwin-arm64.tar.gzmv prometheus-2.53.3.darwin-arm64/prometheus /usr/local/bin/mv prometheus-2.53.3.darwin-arm64/promtool /usr/local/bin/
wget https://github.com/prometheus/prometheus/releases/download/v2.53.3/prometheus-2.53.3.linux-amd64.tar.gztar xvfz prometheus-2.53.3.linux-amd64.tar.gzmv prometheus-2.53.3.linux-amd64/prometheus /usr/local/bin/mv prometheus-2.53.3.linux-amd64/promtool /usr/local/bin/
- ダウンロードしたアーカイブと解凍したディレクトリを削除します:
rm -rf prometheus-2.53.3.darwin-arm64.tar.gz prometheus-2.53.3.darwin-amd64
rm -rf prometheus-2.43.0.linux-amd64.tar.gz prometheus-2.43.0.linux-amd64
- Prometheusを環境変数
PATHに追加すると、どのターミナルセッションからでもPrometheusにアクセスできるようになります。
echo "export PATH=\"\$HOME/monitoring/prometheus:\$PATH\"" >> ~/.bashrcsource ~/.bashrc# This assumes that a prometheus directory already exists in the HOME directory. If not, make a new one (mkdir -p $HOME/monitoring/prometheus).
2.2 Prometheusの設定
PrometheusはKaiaノードからメトリクスをスクレイピングするように設定する必要があります。
prometheus.ymlファイルはPrometheusを設定する。主な項目は以下の通り:
-
**global
**: evaluation_interval(Prometheusがルールを評価する頻度)やscrape_interval(Prometheusがターゲットをスクレイピングする頻度)のようなグローバルな設定パラメータを設定します。どちらも15秒が妥当なスタートポイントだが、ニーズやブロックの時間に応じて調整しよう。 -
scrape_configs:Prometheusが監視するターゲットを定義します。job_nameは対象グループを示す。static_configsはターゲットアドレスをリストアップする。<ip>をKaiaノードのIPアドレスに置き換え、ポート(デフォルトでは61001)が正しく設定されていることを確認する。
より高度な設定については、Prometheus documentationを参照してください。
-
prometheus/prometheus.ymlにあるprometheus.ymlファイルをテキストエディタで開く。 -
scrape_configsセクションにKaiaノードが含まれていることを確認してください。以下に設定例を示す:
global: evaluation_interval: 15s scrape_interval: 15sscrape_configs:- job_name: klaytn static_configs: - targets: #Replace `192.168.1.100` and `192.168.1.101` with the actual IP addresses of your Kaia nodes. - "192.168.1.100:61001" - "192.168.1.101:61001" ...
promtoolを使用して、設定ファイルに構文エラーがないかチェックする:
promtool check config prometheus/prometheus.yml
- 設定ファイルを使ってPrometheusを起動します。
prometheus --config.file=prometheus/prometheus.yml
2.3 マクロスクリプトを使ったPrometheusの設定(macOS)
このスクリプトは、macOS上でのPrometheusのインストールと設定プロセスを自動化します。必要に応じて、他のPrometheusのバージョンやオペレーティングシステムに適応させてください。
rm -rf prometheusecho "Installing Prometheus..."curl -LO https://github.com/prometheus/prometheus/releases/download/v2.43.0/prometheus-2.43.0.darwin-arm64.tar.gztar xvfz prometheus-2.43.0.darwin-arm64.tar.gz > /dev/null 2>&1 && mv prometheus-2.43.0.darwin-arm64 prometheus && rm -rf prometheus-2.43.0.darwin-arm64 && rm -rf prometheus-2.43.0.darwin-arm64.tar.gzecho "export PATH=\"$HOMEDIR/monitoring/prometheus:\$PATH\"" >> ~/.bashrc && source ~/.bashrc# Generate Prometheus config file (prometheus.yml)printf "%s\n" "global:" \ " evaluation_interval: 15s" \ " scrape_interval: 15s" \ "" \ "scrape_configs:" \ "- job_name: klaytn" \ " static_configs:" \ " - targets:" > prometheus/prometheus.yml# Append target configurations for multiple nodesfor (( i=0; i<NUMOFNODE; i++ ))do # Replace <ip> and <port> with the actual IP address and port (61001) for each node printf " - \"<ip>:%d\"\n" <port> >> prometheus/prometheus.ymldone
3. Grafanaのセットアップ
Grafanaでは、カスタマイズ可能なダッシュボードを通じて、Prometheusが収集したメトリクスを可視化することができます。
:::note[Grafana システム要件]
Grafanaをセットアップする前に、お使いのシステムがGrafana公式ドキュメントにあるハードウェアとソフトウェアの最小要件を満たしていることを確認してください。
:::
3.1 Grafanaのインストール
お使いのオペレーティングシステムに適した方法でGrafanaをダウンロードし、インストールする。例えば、GrafanaをHombrewを使ってmacOSに (brew install grafana)インストールすることができる。詳細な手順については、公式Grafanaインストールガイドを参照してください。
3.2 Grafanaの設定
Prometheusが収集したメトリクスを可視化するためにGrafanaをセットアップする。
- Grafana Serverを起動します。
# macOS using Homebrewbrew services start grafana
その他のOSについては、Grafana公式ドキュメントを参照してください。
-
ウェブブラウザを開き、
http://localhost:3000に移動する。デフォルトの認証情報(admin/admin)を使用してログインする。 -
プロメテウスをデータソースとして追加する。
- Configuration** -> Data Sources に移動します。
- Add data sourceをクリックします。
- タイプはPrometheusを選択してください。
- URL を
http://localhost:9090に設定してください(Prometheus が別のサーバーにある場合は変更してください)。 - Save & Testをクリックして接続を確認します。
-
カイアのダッシュボードを追加し、カイアのブロック番号を可視化するパネルを追加する。
- 新しいダッシュボードを作成する、または既存のダッシュボードに移動する。
- 右上のEditをクリックし、ダッシュボードのヘッダーにあるAddをクリックし、ドロップダウンからVisualizationを選択してパネルを追加します。
- Queryの下:
- プロメテウスをData sourceとして選択します。
- Metricフィールドに
klaytn_blockchain_head_blocknumberと入力する。 - Optionsで、Legend ドロップダウンからCustom を選択し、カスタム凡例フォーマットとして
{{instance}}を入力する。
- Applyをクリックしてパネルをダッシュボードに保存します。
:::note[Additional カイア・ダッシュボード]
設定済みのダッシュボードと自動プロビジョニングのセットアップについては、kaiasprayリポジトリを参照してください。このリポジトリには、事前構築されたダッシュボードの JSON ファイルと、データソースをプロビジョニングするための設定ファイルが含まれています。
:::
3.3 マクロスクリプトによるGrafanaの設定(macOS)
このスクリプトは、macOS上でのGrafanaのインストールプロセスを自動化します。必要に応じて、他のGrafanaのバージョンやオペレーティングシステムに適応させる。
# Remove any existing Grafana installationrm -rf grafana# Install Grafanaecho "Installing Grafana..."curl -O https://dl.grafana.com/enterprise/release/grafana-enterprise-8.4.5.darwin-arm64.tar.gztar -zxvf grafana-enterprise-8.4.5.darwin-arm64.tar.gz > /dev/null 2>&1 && mv grafana-8.4.5 grafana && rm -rf grafana-enterprise-8.4.5.darwin-arm64.tar.gzecho "export PATH=\"$HOMEDIR/monitoring/grafana/bin:\$PATH\"" >> ~/.bashrc && source ~/.bashrc# Generate Grafana dashboard config fileprintf "%s\n" "apiVersion: 1" \ "providers:" \ "- name: 'klaytn'" \ " folder: ''" \ " options:" \ " path: conf/provisioning/dashboards" > grafana/conf/provisioning/dashboards/klaytn-dashboard.yml# Generate Grafana datasource config fileprintf "%s\n" "datasources:" \ "- is_default: true " \ " name: 'klaytn'" \ " type: 'prometheus'" \ " url: 'http://localhost:9090'" > grafana/conf/provisioning/datasources/klaytn.yml
# Clone the kaiaspray repository if not already clonedif [ ! -d "kaiaspray" ]; then echo "Cloning kaiaspray repository..." git clone https://github.com/kaiachain/kaiaspray.gitfi# Copy Grafana dashboards from kaiaspraycp kaiaspray/roles/monitor-init/files/grafana/dashboards/*.json grafana/conf/provisioning/dashboards/
4. アクセスサービス
インストールと設定が終わったら、PrometheusとGrafanaのインターフェースにアクセスして、すべてが正しく設定されていることを確認する。
-
Prometheusインターフェース
- URL:
http://localhost:9090 - **検証:**ブラウザでこのURLに移動します。プロメテウスのウェブインターフェイスが表示されるはずです。 Graphタブを使用してサンプル・クエリーを実行し、メトリクスがスクレイピングされていることを確認します。
- URL:
-
Grafanaインターフェイス
- URL:
http://localhost:3000 - デフォルトの認証情報:。
- ユーザー名:
admin - パスワード:
admin
- ユーザー名:
- **確認:**初回ログイン時に、デフォルトパスワードの変更を促すメッセージが表示されます。ログイン後、Prometheusデータソースが正しく設定され、Kaiaダッシュボードにメトリクスが表示されていることを確認します。
- URL: