Anti-pattern: memorizzare le risposte di errore nella cache

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

La memorizzazione nella cache è un processo di archiviazione temporanea dei dati in un'area di archiviazione chiamata cache per il futuro riferimento. La memorizzazione nella cache dei dati offre notevoli vantaggi in termini di prestazioni in quanto:

  • Consente il recupero più rapido dei dati
  • Riduce il tempo di elaborazione evitando la rigenerazione ripetuta dei dati
  • Impedisce alle richieste API di raggiungere i server di backend e, di conseguenza, riduce il carico aggiuntivo su questi server
  • Consente un migliore utilizzo delle risorse di sistema/applicazione
  • Migliora i tempi di risposta delle API

Ogni volta che dobbiamo accedere di frequente a dati che non cambiano troppo spesso, consigliamo vivamente di utilizzare una cache per memorizzarli.

Apigee offre la possibilità di archiviare i dati in una cache in fase di esecuzione per la persistenza e un recupero più rapido. La funzionalità di memorizzazione nella cache viene resa disponibile tramite i criteri PopulateCache, LookupCache, InvalidateCache e ResponseCache.

In questa sezione, esamineremo le norme relative alla cache delle risposte. Il criterio della cache delle risposte in Apigee consente di memorizzare nella cache le risposte dei server di backend. Se le applicazioni client richiede più volte alla stessa risorsa di backend e la risorsa viene aggiornata periodicamente, possiamo memorizzare nella cache queste risposte utilizzando questo criterio. Il criterio della cache delle risposte aiuta a restituire le risposte memorizzate nella cache e di conseguenza evita di inoltrare le richieste ai server di backend inutilmente.

Criteri di Response Cache:

  • Riduce il numero di richieste che raggiungono il backend
  • Riduce la larghezza di banda della rete
  • Migliora le prestazioni e i tempi di risposta delle API

Antipattern

Il criterio ResponseCache consente di memorizzare nella cache le risposte HTTP con qualsiasi codice di stato possibile, per impostazione predefinita. Ciò significa che sia le risposte di successo che quelle di errore possono essere memorizzate nella cache.

Ecco un criterio di Response Cache di esempio con configurazione predefinita:

<!-- /antipatterns/examples/1-1.xml -->
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResponseCache async="false" continueOnError="false" enabled="true" name="TargetServerResponseCache">
  <DisplayName>TargetServer ResponseCache</DisplayName>
  <CacheKey>
    <Key Fragment ref="request.uri" /></CacheKey>
    <Scope>Exclusive</Scope>
    <ExpirySettings>
      <TimeoutInSec ref="flow.variable.here">600</TimeoutInSec>
    </ExpirySettings>
  <CacheResource>targetCache</CacheResource>
</ResponseCache>

Il criterio Cache delle risposte memorizza nella cache le risposte di errore nella configurazione predefinita. Tuttavia, non è consigliabile memorizzare nella cache le risposte agli errori senza riflettere attentamente sulle implicazioni negative perché:

  • Scenario 1: gli errori si verificano per un periodo temporaneo e sconosciuto e noi potrebbe continuare a inviare risposte di errore a causa della memorizzazione nella cache anche dopo la risoluzione del problema

    OR

  • Scenario 2: gli errori verranno osservati per un periodo di tempo fisso. dovremo modificare il codice per evitare la memorizzazione nella cache delle risposte una volta risolto il problema

Per spiegare meglio, esaminiamo questi due scenari in dettaglio.

Scenario 1: errore temporaneo del backend/delle risorse

Tieni presente che l'errore nel server di backend si verifica per uno dei seguenti motivi:

  • Un glitch di rete temporaneo
  • Il server di backend è estremamente occupato e non è in grado di rispondere alle richieste per un periodo di tempo limitato
  • La risorsa di backend richiesta potrebbe essere rimossa/non disponibile per un periodo di tempo temporaneo
  • Il server di backend risponde lentamente a causa di un tempo di elaborazione elevato per un periodo temporaneo e così via

In tutti questi casi, gli errori potrebbero verificarsi per un periodo di tempo sconosciuto, dopodiché potremmo iniziare a ricevere risposte positive. Se memorizziamo nella cache le risposte di errore, potremmo continuare a inviare le risposte di errore agli utenti anche se il problema con il server di backend è stato risolto.

Scenario 2: errore di backend/risorsa prolungato o corretto

Tieni presente che l'errore nel backend dura un periodo di tempo prefissato. Ad esempio, sei consapevole che:

  • Una risorsa di backend specifica non sarà disponibile per 1 ora

    OR

  • Il server di backend è stato rimosso/non disponibile per 24 ore a causa di un improvviso errore del sito. problemi di scalabilità, manutenzione, upgrade ecc.

Con queste informazioni, possiamo impostare la scadenza della cache in modo appropriato nella sezione Cache delle risposte in modo da non memorizzare nella cache le risposte di errore per un periodo di tempo più lungo. Tuttavia, una volta che il server/la risorsa di backend sarà di nuovo disponibile, dovremo modificare il criterio per evitare di memorizzare nella cache le risposte di errore. Questo perché se si verifica un errore temporaneo/una tantum dal backend memorizzeremo nella cache la risposta e finiremo con il problema spiegato nello scenario 1 sopra.

Impatto

  • La memorizzazione nella cache delle risposte di errore può causare l'invio di risposte di errore anche dopo che il problema è stato risolti nel server di backend
  • Gli utenti potrebbero impiegare molto tempo per risolvere la causa di un problema senza sapere che è causato dalla memorizzazione nella cache delle risposte di errore del server di backend

Best practice

  • Non archiviare le risposte di errore nella cache delle risposte. Assicurati che l'elemento <ExcludeErrorResponse> sia impostato su true nel criterio ResponseCache per impedire la memorizzazione nella cache delle risposte di errore, come mostrato nello snippet di codice di seguito. Con per questa configurazione solo le risposte per i codici di successo predefiniti da 200 a 205 (a meno che i codici di operazione riuscita vengono modificati). 
    <!-- /antipatterns/examples/1-2.xml -->
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResponseCache async="false" continueOnError="false" enabled="true" name="TargetServerResponseCache">
  <DisplayName>TargetServerResponseCache</DisplayName>
  <CacheKey>
    <KeyFragment ref="request.uri" />
  </CacheKey>
  <Scope>Exclusive</Scope>
  <ExpirySettings>
    <TimeoutinSec ref="flow.variable.here">600</TimeoutinSec>
  </ExpirySettings>
  <CacheResource>targetCache</CacheResource>
  <ExcludeErrorResponse>true</ExcludeErrorResponse>
</ResponseCache>
  • Se devi memorizzare nella cache le risposte di errore per un motivo specifico, puoi determinare la durata massima/esatta del periodo di tempo per cui verrà osservato l'errore (se possibile):
    • Imposta la scadenza in modo appropriato per assicurarti di non memorizzare nella cache le risposte di errore. rispetto al periodo di tempo per cui l'errore può essere visto.
    • Utilizza il criterio ResponseCache per memorizzare nella cache le risposte di errore senza l'elemento <ExcludeErrorResponse>.

    Esegui questa operazione solo se hai la certezza assoluta che l'errore del server di backend non sia per un per un periodo breve/temporaneo.

  • Apigee sconsiglia di memorizzare nella cache le risposte 5xx dai server di backend.