Como Usar getHealth

​

Como Funciona

​

Casos de Uso Comuns

• Monitoramento de Nós: Verifique regularmente a saúde dos nós RPC para garantir que estejam operacionais e sincronizados.
• Balanceamento de Carga: Use verificações de saúde para determinar se um nó deve receber tráfego em uma configuração de balanceamento de carga.
• Sistemas de Failover: Acione o failover para um nó de backup se um nó primário se tornar não saudável.
• Depuração de Conectividade: Verifique rapidamente se um nó RPC está responsivo.

​

Parâmetros de Solicitação

​

Estrutura de Resposta

• Para POST JSON-RPC getHealth:
  • result: "ok" se o nó estiver saudável.
  • Pode retornar um objeto de erro ou outros valores de string (como "behind" ou "unknown") se estiver não saudável, embora a resposta exata de erro para um nó não saudável possa ser instável ou variar entre provedores.

​

Exemplos

​

1. Verificar Saúde do Nó usando JSON-RPC (POST com 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
}

​

Dicas para Desenvolvedores

• Definição de Saudável: “Saudável” geralmente significa que o nó é responsivo e não está muito atrás da ponta do cluster. A diferença exata de slots (HEALTH_CHECK_SLOT_DISTANCE) pode ser configurada no nó.
• Interpretando "behind" ou "unknown": Se você receber "behind {distance}" ou "unknown", o nó está operacional, mas pode não estar totalmente atualizado ou capaz de determinar seu status em relação ao cluster. Dependendo dos requisitos de sua aplicação, você pode tratar esses estados de maneira diferente.
• Diferenças entre Provedores: O comportamento exato e os códigos/corpos de resposta para um nó não saudável podem variar ligeiramente entre provedores de RPC.
• Tratamento de Erros: Sempre implemente um tratamento adequado de erros ao chamar getHealth, pois problemas de rede ou no nó podem causar a falha completa da solicitação.