Comment utiliser getHealth

​

Comment ça fonctionne

​

Cas d’utilisation courants

• Surveillance des nœuds : Vérifiez régulièrement la santé des nœuds RPC pour s’assurer qu’ils sont opérationnels et synchronisés.
• Répartition de charge : Utilisez des vérifications de santé pour déterminer si un nœud doit recevoir du trafic dans une configuration d’équilibrage de charge.
• Systèmes de basculement : Déclenchez le basculement vers un nœud de sauvegarde si un nœud principal devient non sain.
• Débogage de la connectivité : Vérifiez rapidement si un nœud RPC est réactif.

​

Paramètres de requête

​

Structure de réponse

• Pour JSON-RPC getHealth POST :
  • result : "ok" si le nœud est sain.
  • Il peut renvoyer un objet d’erreur ou d’autres valeurs de chaîne (comme "behind" ou "unknown") si non sain, bien que la réponse d’erreur exacte pour un nœud non sain puisse être instable ou varier entre les fournisseurs.

​

Exemples

​

1. Vérifier la santé du nœud en utilisant JSON-RPC (POST avec 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
}

​

Conseils pour développeurs

• Définition de sain : “Sain” signifie généralement que le nœud est réactif et pas trop en retard par rapport à la pointe du cluster. La différence de slot exacte (HEALTH_CHECK_SLOT_DISTANCE) peut être configurée sur le nœud.
• Interpréter "behind" ou "unknown" : Si vous recevez "behind {distance}" ou "unknown", le nœud est opérationnel mais peut ne pas être entièrement à jour ou capable de déterminer son statut par rapport au cluster. Selon les exigences de votre application, vous pouvez traiter ces états différemment.
• Différences entre fournisseurs : Le comportement exact et les codes/réponses pour un nœud non sain peuvent légèrement varier entre les fournisseurs RPC.
• Gestion des erreurs : Implémentez toujours une gestion appropriée des erreurs lors de l’appel de getHealth, car des problèmes de réseau ou des problèmes de nœud peuvent entraîner l’échec complet de la requête.