Antipattern: memorizzare nella cache le risposte di errore

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 riferimento futuro. La memorizzazione nella cache dei dati offre vantaggi significativi in termini di prestazioni perché:

  • Consente un recupero più rapido dei dati
  • Riduce il tempo di elaborazione evitando la rigenerazione dei dati più e più volte
  • Impedisce alle richieste API di raggiungere i server di backend e riduce quindi il sovraccarico sui server di backend.
  • Consente un migliore utilizzo delle risorse di sistema/applicazione
  • Migliora i tempi di risposta delle API

Ogni volta che dobbiamo accedere frequentemente ad alcuni dati che non cambiano spesso, ti consigliamo vivamente di utilizzare una cache per memorizzarli.

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

In questa sezione esaminiamo le norme relative alla cache delle risposte. Il criterio Response Cache nella piattaforma Apigee ti consente di memorizzare nella cache le risposte dei server di backend. Se le applicazioni client effettuano ripetutamente richieste 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 consente di restituire le risposte memorizzate nella cache ed evita di inoltrare le richieste ai server di backend inutilmente.

La policy della cache delle risposte:

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

Antipattern

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

Ecco un esempio di policy della cache delle risposte con la 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>

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

  • Scenario 1: si verificano errori per un periodo temporaneo sconosciuto e potremmo 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, poi dovremo modificare il codice per evitare la memorizzazione nella cache delle risposte una volta risolto il problema

Spieghiamo questo concetto analizzando più nel dettaglio questi due scenari.

Scenario 1: errore temporaneo del backend/della risorsa

Tieni presente che l'errore nel server di backend è dovuto a uno dei seguenti motivi:

  • Un problema temporaneo della rete
  • Il server di backend è estremamente occupato e non è in grado di rispondere alle richieste per un periodo temporaneo
  • La risorsa di backend richiesta potrebbe essere rimossa/non disponibile per un periodo di tempo temporaneo
  • Il server di backend risponde lentamente a causa dell'elevato tempo di elaborazione per un periodo temporaneo, ecc.

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

Scenario 2: errore prolungato o fisso del backend/della risorsa

Tieni presente che sappiamo che l'errore nel backend si verifica per un periodo di tempo fisso. Ad esempio, sei consapevole che:

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

    OR

  • Il server di backend viene rimosso/non è disponibile per 24 ore a causa di un guasto improvviso del sito, problemi di scalabilità, manutenzione, upgrade e così via.

Con queste informazioni, possiamo impostare il tempo di scadenza della cache in modo appropriato nella policy della 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 le norme per evitare risposte di errore di memorizzazione nella cache. Questo perché, in caso di errore temporaneo/una tantum del server backend, memorizzeremo nella cache la risposta e ci ritroveremo 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 risolto nel server di backend
  • Gli utenti potrebbero impegnarsi molto 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 memorizzare le risposte di errore nella cache delle risposte. Assicurati che l'elemento <ExcludeErrorResponse> sia impostato su true nella policy ResponseCache per impedire la memorizzazione nella cache delle risposte di errore, come mostrato nello snippet di codice di seguito. Con questa configurazione verranno memorizzate nella cache solo le risposte per i codici di esito positivo predefiniti da 200 a 205 (a meno che non vengano 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 di tempo per cui verrà osservato l'errore (se possibile):
    • Imposta il tempo di scadenza in modo appropriato per assicurarti di non memorizzare nella cache le risposte di errore per un periodo di tempo superiore a quello in cui è possibile visualizzare l'errore.
    • 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 dovuto a un periodo breve/temporaneo.

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