So verwendest du getHealth

​

Funktionsweise

​

Häufige Anwendungsfälle

• Überwachung von Nodes: Prüfe regelmäßig den Zustand von RPC nodes, um sicherzustellen, dass sie betriebsbereit und synchronisiert sind.
• Lastverteilung: Ermittle mit Zustandsprüfungen, ob ein node in einer Umgebung mit Lastverteilung Datenverkehr erhalten soll.
• Failover-Systeme: Wechsle zu einem Backup-node, wenn der primäre node nicht mehr gesund ist.
• Fehlersuche bei Verbindungen: Stelle schnell fest, ob ein RPC node antwortet.

​

Request-Parameter

​

Response-Struktur

• Für JSON-RPC getHealth POST:
  • result: "ok", wenn der node gesund ist.
  • Ist der node nicht gesund, kann ein Fehlerobjekt oder ein anderer String-Wert zurückgegeben werden, etwa "behind" oder "unknown". Die genaue Fehler-response kann jedoch instabil sein oder je nach Anbieter variieren.

​

Beispiele

​

1. Zustand eines node mit JSON-RPC prüfen (POST mit cURL)

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
}

​

Tipps für Entwickler

• Definition von „gesund“: „Gesund“ bedeutet im Allgemeinen, dass der node antwortet und nicht zu weit hinter der Spitze des cluster liegt. Der genaue slot-Abstand (HEALTH_CHECK_SLOT_DISTANCE) lässt sich auf dem node konfigurieren.
• "behind" oder "unknown" interpretieren: Wenn du "behind {distance}" oder "unknown" erhältst, ist der node betriebsbereit, aber möglicherweise noch nicht vollständig synchronisiert oder kann seinen Zustand relativ zum cluster nicht bestimmen. Je nach Anforderungen deiner Anwendung kannst du diese Zustände unterschiedlich behandeln.
• Unterschiede zwischen Anbietern: Das genaue Verhalten sowie die response-Codes und -Inhalte für einen nicht gesunden node können zwischen RPC-Anbietern leicht variieren.
• Fehlerbehandlung: Implementiere beim Aufruf von getHealth immer eine geeignete Fehlerbehandlung. Netzwerk- oder node-Probleme können dazu führen, dass der request vollständig fehlschlägt.