Anti-pattern: bilanciamento del carico con un singolo server di destinazione con MaxFailures impostato su un valore diverso da zero

Stai visualizzando la documentazione di Apigee e Apigee hybrid.
Visualizza la documentazione di Apigee Edge.

La configurazione TargetEndpoint definisce il modo in cui Apigee si connette a un'API o a un servizio di backend. Invia le richieste e riceve le risposte da/verso il servizio di backend. Il servizio di backend può essere un server HTTP/HTTPS o NodeJS.

Il servizio di backend in TargetEndpoint può essere richiamato in uno dei seguenti modi:

  • Indirizza l'URL a un server HTTP o HTTPS
  • Configurazione TargetServer

Allo stesso modo, il criterio Callout di servizio può essere utilizzato per effettuare una chiamata a qualsiasi servizio esterno dal flusso proxy API. Questo criterio supporta la definizione di URL di destinazione HTTP/HTTPS direttamente nel criterio stesso o utilizzando una configurazione TargetServer.

Configurazione TargetServer

La configurazione TargetServer disaccoppia gli URL di endpoint concreti dalle configurazioni TargetEndpoint o nei criteri di callout del servizio. Un TargetServer fa riferimento a un nome anziché all'URL in TargetEndpoint. La configurazione di TargetServer includerà il nome host del servizio di backend, il numero di porta e altri dettagli.

Ecco una configurazione di TargetServer di esempio:

<TargetServer name="target1">
  <Host>www.mybackendservice.com</Host>
  <Port>80</Port>
  <IsEnabled>true</IsEnabled>
</TargetServer>

TargetServer consente di avere configurazioni diverse per ogni ambiente. Un criterio TargetEndpoint/Callout di servizio può essere configurato con uno o più TargetServers denominati utilizzando un LoadBalancer. Il supporto integrato per il bilanciamento del carico migliora la disponibilità delle API e il failover tra le istanze del server di backend configurate.

Ecco un esempio di configurazione TargetEndpoint che utilizza TargetServers:

<TargetEndpoint name="default">
    <HTTPTargetConnection>>
      <LoadBalancer>
        <Server name="target1"/>
        <Server name="target2"/>
      </LoadBalancer>
    </HTTPTargetConnection>
</TargetEndpoint>

MaxFailures

La configurazione MaxFailures specifica il numero massimo di richieste non riuscite al server di destinazione, dopo il quale il server di destinazione deve essere contrassegnato come inattivo e rimosso dalla rotazione per tutte le richieste successive.

Una configurazione di esempio con MaxFailures specificato:

<TargetEndpoint name="default">
    <HTTPTargetConnection>
      <LoadBalancer>
        <Server name="target1"/>
        <Server name="target2"/>
        <MaxFailures>5</MaxFailures>
      </LoadBalancer>
    </HTTPTargetConnection>
</TargetEndpoint>

Nell'esempio precedente, se cinque richieste consecutive non sono riuscite per "target1", "target1" verrà rimosso dalla rotazione e tutte le richieste successive verranno inviate solo a target2.

Antipattern

Non è consigliabile avere un singolo TargetServer in una configurazione LoadBalancer del criterio TargetEndpoint o Callout di servizio con MaxFailures impostato su un valore diverso da zero, in quanto può avere implicazioni negative.

Considera la seguente configurazione di esempio con un singolo TargetServer denominato "target1" con MaxFailures impostato su 5 (valore diverso da zero): 

<TargetEndpoint name="default">
  <HTTPTargetConnection>
      <LoadBalancer>
        <Algorithm>RoundRobin</Algorithm>
        <Server name="target1" />
        <MaxFailures>5</MaxFailures>
      </LoadBalancer>
  </HTTPTargetConnection>

Se le richieste al TargetServer "target1" non vanno a buon fine cinque volte (numero specificato in MaxFailures), TargetServer viene rimosso dalla rotazione. Poiché non sono presenti altri server TargetServer a cui eseguire il failover, tutte le richieste successive al proxy API con questa configurazione non andranno a buon fine con un errore 503 Service Unavailable.

Anche se TargetServer "target1" torna al suo stato normale ed è in grado di inviare risposte riuscite, le richieste al proxy API continueranno a restituire errori 503. Questo perché Apigee non riporta automaticamente TargetServer in rotazione, anche dopo che il target è nuovamente attivo e in esecuzione. Per risolvere questo problema, è necessario eseguire nuovamente il deployment del proxy API affinché Apigee possa ripristinare la rotazione di TargetServer.

Se nel criterio Callout di servizio viene utilizzata la stessa configurazione, le richieste API riceveranno un errore 500 dopo che le richieste a TargetServer "target1" non andranno a buon fine per 5 volte.

Impatto

L'utilizzo di un singolo TargetServer in una configurazione LoadBalancer del criterio TargetEndpoint o Callout di servizio con MaxFailures impostato su un valore diverso da zero causa:

  • Le richieste API non andranno a buon fine con errori 503/500 continuamente (dopo che le richieste non vanno a buon fine per numero di volte MaxFailures) fino a quando non viene eseguito nuovamente il deployment del proxy API.
  • Interruzione più lunga in quanto è complessa e può richiedere più tempo per diagnosticare la causa del problema (senza previa conoscenza di questo anti-pattern).

Best practice

  1. Hai più di un TargetServer nella configurazione LoadBalancer per una maggiore disponibilità.

  2. Definisci sempre un Monitoraggio integrità quando MaxFailures è impostato su un valore diverso da zero. Un server di destinazione verrà rimosso dalla rotazione quando il numero di errori raggiungerà il numero specificato in MaxFailures. L'impostazione HealthMonitor assicura che TargetServer venga reinserito in rotazione non appena il server di destinazione diventa di nuovo disponibile, il che significa che non è necessario eseguire nuovamente il deployment del proxy.

    Per garantire che il controllo di integrità venga eseguito sullo stesso numero di porta utilizzato da Apigee per connettersi ai server di destinazione, Apigee consiglia di omettere l'elemento secondario <Port> in <TCPMonitor>, a meno che non sia diverso dalla porta TargetServer. Per impostazione predefinita, <Port> corrisponde alla porta di TargetServer.

    Configurazione di esempio con HealthMonitor:

    <TargetEndpoint name="default">
  <HTTPTargetConnection>
    <LoadBalancer>
      <Algorithm>RoundRobin</Algorithm>
      <Server name="target1" />
      <Server name="target2" />
      <MaxFailures>5</MaxFailures>
    </LoadBalancer>
    <Path>/test</Path>
    <HealthMonitor>
      <IsEnabled>true</IsEnabled>
      <IntervalInSec>5</IntervalInSec>
      <TCPMonitor>
        <ConnectTimeoutInSec>10</ConnectTimeoutInSec>
      </TCPMonitor>
    </HealthMonitor>
  </HTTPTargetConnection>
</TargetEndpoint>

  3. Se è presente un vincolo che prevede un solo TargetServer e se HealthMonitor non viene utilizzato, non specificare MaxFailures nella configurazione di LoadBalancer.

    Il valore predefinito di MaxFailures è 0. Ciò significa che Apigee prova sempre a connettersi alla destinazione per ogni richiesta e non rimuove mai il server di destinazione dalla rotazione.

Per approfondire