getHealthの使用方法

​

作動方法

​

一般的な使用例

• ノード監視: RPCノードが稼働しており同期していることを確認するために、定期的に健康状態をチェックします。
• 負荷分散: ヘルスチェックを使用して、ノードが負荷分散された設定でトラフィックを受け取るべきかを判断します。
• フェイルオーバーシステム: プライマリノードが健康でなくなった場合にバックアップノードへのフェイルオーバーをトリガーします。
• 接続性のデバッグ: RPCノードが応答しているかどうかを迅速に確認します。

​

リクエストパラメータ

​

レスポンス構造

• JSON-RPC getHealth POSTの場合:
  • result: ノードが健康である場合の"ok"。
  • ノードが健康でない場合、エラーオブジェクトやその他の文字列値（"behind"や"unknown"など）が返されることがありますが、正確なエラーレスポンスは不安定でプロバイダ間で異なる場合があります。

​

例

​

1. JSON-RPCを使用したノード健康チェック（cURLでのPOST）

curl https://mainnet.helius-rpc.com/?api-key=<api-key> -X POST -H "Content-Type: application/json" -d \
  '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "getHealth"
  }'

const { Connection } = require('@solana/web3.js');

async function checkRpcHealth(rpcUrl) {
    const connection = new Connection(rpcUrl);
    try {
        const health = await connection.rpcRequest('getHealth', []);
        console.log(`getHealth result for ${rpcUrl}:`, health);
        return health.result;
    } catch (error) {
        console.error(`Error calling getHealth for ${rpcUrl}:`, error.message);
        return null;
    }
}

// Example usage:
checkRpcHealth('https://mainnet.helius-rpc.com/?api-key=<api-key>');

{
  "jsonrpc": "2.0",
  "result": "ok",
  "id": 1
}

​

開発者向けのヒント

• 健康の定義: 「健康」とは、ノードが応答可能でクラスタの先端からあまり離れていないことを意味します。正確なスロットの差（HEALTH_CHECK_SLOT_DISTANCE）は、ノードで設定できます。
• "behind"や"unknown"の解釈: "behind {distance}"や"unknown"を受け取った場合、ノードは稼働中ですが、クラスタに完全に追いついていないか、その状態を把握できないことを示します。アプリケーションの要件に応じて、これらの状態を異なる扱いが必要です。
• プロバイダの違い: 非健康なノードに対する正確な動作やレスポンスコード/ボディは、RPCプロバイダ間でわずかに異なる可能性があります。
• エラーハンドリング: ネットワークの問題やノードの問題によってリクエストが完全に失敗する可能性があるため、getHealthを呼び出す際には、常に適切なエラーハンドリングを実装する必要があります。