Cómo usar getHealth

​

Cómo funciona

​

Casos de uso comunes

• Monitoreo de nodos: Comprueba periódicamente el estado de los nodos RPC para asegurarte de que estén operativos y sincronizados.
• Balanceo de carga: Usa comprobaciones de estado para determinar si un nodo debe recibir tráfico en una configuración con balanceo de carga.
• Sistemas de conmutación por error: Activa la conmutación a un nodo de respaldo si un nodo principal deja de estar saludable.
• Depuración de conectividad: Determina rápidamente si un nodo RPC responde.

​

Parámetros de solicitud

​

Estructura de la respuesta

• Para una solicitud POST de JSON-RPC getHealth:
  • result: "ok" si el nodo está saludable.
  • Si el nodo no está saludable, puede devolver un objeto de error u otros valores de cadena (como "behind" o "unknown"), aunque la respuesta de error exacta puede ser inestable o variar entre proveedores.

​

Ejemplos

​

1. Comprobar el estado del nodo mediante JSON-RPC (POST con 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
}

​

Consejos para desarrolladores

• Definición de saludable: Por lo general, «saludable» significa que el nodo responde y no está demasiado retrasado respecto a la punta del clúster. La diferencia exacta de slots (HEALTH_CHECK_SLOT_DISTANCE) puede configurarse en el nodo.
• Interpretación de "behind" o "unknown": Si recibes "behind {distance}" o "unknown", el nodo está operativo, pero es posible que no esté completamente actualizado o que no pueda determinar su estado con respecto al clúster. Según los requisitos de tu aplicación, puedes tratar estos estados de manera diferente.
• Diferencias entre proveedores: El comportamiento exacto y los códigos o cuerpos de respuesta de un nodo que no está saludable pueden variar ligeramente entre proveedores de RPC.
• Manejo de errores: Implementa siempre un manejo de errores adecuado al llamar a getHealth, ya que los problemas de red o del nodo pueden hacer que la solicitud falle por completo.