Criterio SpikeArrest

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza la documentazione di Apigee Edge.

Il criterio SpikeArrest protegge dai picchi di traffico con l'elemento <Rate>. Questo limita il numero di richieste elaborate da un proxy API e inviate a un backend, per una protezione contro tempi di inattività e ritardi delle prestazioni.

Questo criterio è un criterio standard e può essere implementato in qualsiasi tipo di ambiente. Per informazioni sui tipi di criteri e sulla loro disponibilità in base a ciascun tipo di ambiente, consulta Tipi di criteri.

La differenza tra SpikeArrest e Quota

Il criterio per le quote configura il numero di messaggi di richiesta che un'app client può inviare a un'API nell'arco di un'ora, un giorno, una settimana o un mese. Il criterio per le quote applica limiti di consumo alle app client mantenendo un contatore distribuito che conteggia le richieste in entrata.

Utilizza la quota per applicare contratti commerciali o SLA con sviluppatori e partner, anziché per la gestione del traffico operativo. Utilizza SpikeArrest per proteggerti da picchi improvvisi nel traffico delle API. Consulta anche Confronto tra i criteri Quota e SpikeArrest.

Video

Questi video illustrano i casi d'uso di queste norme:

A cosa serve

Confronta criteri per le quote

<SpikeArrest> elemento

Definisce il criterio SpikeArrest.

Valore predefinito	Consulta la scheda Criterio predefinito di seguito
Obbligatorio?	Facoltativo
Tipo	Complesso oggetto
Elemento principale	n/a
Elementi secondari	<Identifier> <MessageWeight> <Rate> (obbligatorio) <UseEffectiveCount>

Sintassi

L'elemento <SpikeArrest> utilizza la seguente sintassi:

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <DisplayName>display_name</DisplayName>
  <Properties/>
  <Identifier ref="flow_variable"/>
  <MessageWeight ref="flow_variable"/>
  <Rate ref="flow_variable">rate[pm|ps]</Rate>
  <UseEffectiveCount>[false|true]</UseEffectiveCount>
</SpikeArrest>

Criterio predefinito

L'esempio seguente mostra le impostazioni predefinite quando aggiungi un criterio SpikeArrest al tuo flusso nell'interfaccia utente:

<SpikeArrest async="false" continueOnError="false" enabled="true" name="Spike-Arrest-1">
  <DisplayName>Spike Arrest-1</DisplayName>
  <Properties/>
  <Identifier ref="request.header.some-header-name"/>
  <MessageWeight ref="request.header.weight"/>
  <Rate>30ps</Rate>
  <UseEffectiveCount>false</UseEffectiveCount>
</SpikeArrest>

Questo elemento ha i seguenti attributi comuni a tutti i criteri:

Attributo	Predefinito	Obbligatorio?	Descrizione
name	N/A	Obbligatorio	Il nome interno del criterio. Il valore dell'attributo name può contenere lettere, numeri, spazi, trattini, trattini bassi e punti. Questo valore non può superare i 255 caratteri. Facoltativamente, utilizza l'elemento <DisplayName> per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.
continueOnError	falso	Facoltativo	Imposta su false per restituire un errore in caso di errore del criterio. Questo è un comportamento previsto per la maggior parte dei criteri. Imposta su true per continuare l'esecuzione del flusso anche dopo un errore nel criterio. Vedi anche: Le regole di errore vengono attivate SOLO in uno stato di errore (su continueOnError) Gestione degli errori nel flusso corrente
enabled	true	Facoltativo	Imposta su true per applicare il criterio. Imposta su false per disattivare il criterio. Il criterio non verrà applicato anche se rimane collegato a un flusso.
async	falso	Deprecato	Questo attributo è stato ritirato.

Esempi

Gli esempi riportati di seguito mostrano alcuni dei modi in cui puoi utilizzare il criterio SpikeArrest:

Esempio 1

L'esempio seguente imposta la frequenza su cinque al secondo:

<SpikeArrest name="Spike-Arrest-1">
  <Rate>5ps</Rate>
  <UseEffectiveCount>false</UseEffectiveCount>
</SpikeArrest>

Questo criterio di esempio consente un massimo di 5 richieste al secondo. Tramite il perfezionamento, viene applicato come di una richiesta per ogni intervallo di 200 millisecondi (1000/5).

Esempio 2

L'esempio seguente imposta la frequenza su 12 al minuto:

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</Rate>
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

Questo criterio di esempio consente un massimo di 12 richieste al minuto con una frequenza di una richiesta ogni 5 secondi (60/12). Se in un pod ci sono di una richiesta in un intervallo di 5 secondi, come le richieste (nessun smoothing) a condizione che il numero di richieste sia inferiore a quello configurato di 12 al minuto.

Esempio 3

L'esempio seguente limita le richieste a 12 al minuto (una richiesta consentita ogni cinque secondi o 60/12):

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</Rate>
  <Identifier ref="client_id" />
  <MessageWeight ref="request.header.weight" />
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

Inoltre, l'elemento <MessageWeight> accetta un valore personalizzato (la intestazione weight) che regola i pesi dei messaggi per app o client specifici. Ciò offre un maggiore controllo sulla limitazione per le entità identificate con l'elemento <Identifier>.

Esempio 4

L'esempio seguente indica a SpikeArrest di cercare un valore di runtime impostato tramite il metodo richiesta passata come variabile di flusso request.header.runtime_rate:

<SpikeArrest name="Spike-Arrest-1">
  <Rate ref="request.header.runtime_rate" />
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

Il valore della variabile di flusso deve essere nel formato intpm oppure intps.

Per provare questo esempio, esegui una richiesta come la seguente:

curl http://myorg-myenv.apigee.net/price -H 'runtime_rate:30ps'

Suggerimento: dai un'occhiata Come posso utilizzare i prodotti basati su API per impostare i limiti di arresto dei picchi?, in cui viene spiegato come impostare il valore Percentuale di SpikeArrest mediante variabili personalizzate impostate in un prodotto API.

Riferimento all'elemento secondario

Questa sezione descrive gli elementi secondari di <SpikeArrest>.

<DisplayName>

Da utilizzare insieme all'attributo name per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso e più naturale.

L'elemento <DisplayName> è comune a tutti i criteri.

Valore predefinito	N/D
Obbligatorio?	Facoltativo. Se ometti <DisplayName>, viene utilizzato il valore dell'attributo name del criterio.
Tipo	Stringa
Elemento principale	<PolicyElement>
Elementi secondari	Nessuno

La sintassi dell'elemento <DisplayName> è la seguente:

Sintassi

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

Esempio

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

L'elemento <DisplayName> non ha attributi o elementi secondari.

<Identifier>

Ti consente di scegliere come raggruppare le richieste in modo che il criterio SpikeArrest possa essere applicato in base al client. Ad esempio, puoi raggruppare le richieste per ID sviluppatore, nel qual caso ogni le richieste degli sviluppatori verranno conteggiate ai fini del loro tasso di SpikeArrest e non di tutte le richieste al proxy.

Da utilizzare in combinazione con l'elemento <MessageWeight> per un controllo più granulare sulla limitazione delle richieste.

Se lasci vuoto l'elemento <Identifier>, viene applicato un limite di frequenza per tutte le richieste al proxy API.

Valore predefinito	n/a
Obbligatorio?	Facoltativo
Tipo	Stringa
Elemento principale	<SpikeArrest>
Elementi secondari	Nessuno

Sintassi

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <Identifier ref="flow_variable"/>
</SpikeArrest>
        

Esempio 1

L'esempio seguente applica il criterio SpikeArrest per ID sviluppatore:

<SpikeArrest name="Spike-Arrest-1">
  <Identifier ref="developer.id"/>
  <Rate>42pm</Rate/>
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

La tabella seguente descrive gli attributi di <Identifier>:

Attributo	Descrizione	Predefinito	Presenza
ref	Identifica la variabile in base alla quale SpikeArrest raggruppa le richieste in entrata. Puoi utilizzare qualsiasi variabile di flusso per indicare un cliente univoco, ad esempio quelle disponibili con il criterio VerifyAPIKey. Puoi anche impostare variabili personalizzate utilizzando Il criterio JavaScript o il criterioAssignMessage	n/a	Obbligatorio

Questo elemento è discusso anche in questo post della community Apigee.

<MessageWeight>

Specifica la ponderazione definita per ogni messaggio. Il peso del messaggio modifica l'impatto di una singola richiesta sul calcolo del tasso di arresto picco. Il peso del messaggio può essere qualsiasi variabile di flusso, ad esempio un'intestazione HTTP, un parametro di query, un parametro di modulo o i contenuti del corpo del messaggio. Puoi anche utilizzare variabili personalizzate usando il criterio JavaScript o il metodo CriterioAssignMessage:

Da utilizzare insieme a <Identifier> per limitare ulteriormente le richieste del per client o app specifici.

Ad esempio, se SpikeArrest <Rate> è 10pm e un'app invia richieste con una ponderazione di 2, allora sono consentiti solo cinque messaggi al minuto da perché ogni richiesta viene conteggiata come 2.

Valore predefinito	n/a
Obbligatorio?	Facoltativo
Tipo	Numero intero
Elemento principale	<SpikeArrest>
Elementi secondari	Nessuno

Sintassi

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <MessageWeight ref="flow_variable"/>
</SpikeArrest>

Esempio 1

L'esempio seguente limita le richieste a 12 al minuto (una richiesta consentita ogni cinque secondi o 60/12):

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</Rate>
  <Identifier ref="client_id" />
  <MessageWeight ref="request.header.weight" />
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

In questo esempio, <MessageWeight> accetta un valore personalizzato (il valore weight l'intestazione nella richiesta) che regola le ponderazioni dei messaggi per client specifici. Ciò offre un maggiore controllo sulla limitazione per le entità identificate con l'elemento <Identifier>.

Nella tabella seguente vengono descritti gli attributi di <MessageWeight>:

Attributo	Descrizione	Presenza	Predefinito
ref	Identifica la variabile di flusso che contiene il peso del messaggio per il client specifico. Può essere qualsiasi variabile di flusso, come parametro di query HTTP, intestazione o contenuto del corpo del messaggio. Per ulteriori informazioni, vedi Riferimento per le variabili di flusso. Puoi anche impostare variabili personalizzate utilizzando il criterio JavaScript o il criterioAssignMessage	Obbligatorio	N/D

<Rate>

Specifica la frequenza con cui limitare i picchi (o le esplosioni) di traffico impostando il numero di richieste consentite in intervalli di un minuto o un secondo. Puoi utilizzare questo elemento anche in abbinamento con <Identifier> e <MessageWeight> per limitare in modo fluido il traffico in fase di runtime accettando valori dal client. Utilizza la Elemento <UseEffectiveCount> per impostare l'algoritmo di limitazione di frequenza utilizzato dal criterio.

Nota: consulta la sezione SpikeArrest della pagina Limiti per conoscere i limiti di frequenza massima che puoi specificare.

Valore predefinito	n/a
Obbligatorio?	Obbligatorio
Tipo	Numero intero
Elemento principale	<SpikeArrest>
Elementi secondari	Nessuno

Sintassi

Puoi specificare le tariffe in uno dei seguenti modi:

• Una tariffa fissa specificata come corpo dell'elemento <Rate>
• Un valore variabile che può essere passato dal client. Identifica il nome della variabile di flusso utilizzando l'attributo ref

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <Rate ref="flow_variable">rate[pm|ps]</Rate>
</SpikeArrest>

I valori di tariffa validi (definiti come valore di una variabile o nel corpo dell'elemento) devono essere conformi al seguente formato:

• intps (numero di richieste al secondo, uniformato in intervalli di millisecondi)
• intpm (numero di richieste al minuto, semplificate in intervalli di secondi)

Il valore di int deve essere un numero intero positivo diverso da zero.

Esempio 1

L'esempio seguente imposta la frequenza su cinque richieste al secondo:

<SpikeArrest name="Spike-Arrest-1">
  <Rate>5ps</Rate>
  <UseEffectiveCount>false</UseEffectiveCount>
</SpikeArrest>

Il criterio riduce la frequenza a una richiesta consentita ogni 200 millisecondi (1000/5).

Esempio 2

L'esempio seguente imposta la frequenza su 12 richieste al minuto:

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</Rate>
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

Questo criterio di esempio attenua la tariffa a una richiesta consentita ogni cinque secondi (60/12).

La tabella seguente descrive gli attributi di <Rate>:

Attributo	Descrizione	Presenza	Predefinito
ref	Identifica una variabile di flusso che specifica la tariffa. Può essere qualsiasi flusso quali un parametro di query HTTP, un'intestazione, i contenuti del corpo del messaggio o un valore come una KVM. Per ulteriori informazioni, consulta la sezione Riferimento alle variabili di flusso. Puoi anche utilizzare le variabili personalizzate utilizzando il criterio JavaScript o il criterio Assegna messaggio. Se definisci sia ref che il corpo di questo elemento, il valore di ref viene applicato e ha la precedenza quando la variabile di flusso è impostata nella richiesta. Il contrario è vero quando la variabile identificata in ref non è impostata nella richiesta. Ad esempio: <Rate ref="request.header.custom_rate">1pm</Rate> In questo esempio, se il client non passa un'intestazione custom_rate, la per il proxy API è di 1 richiesta al minuto per tutti i client. Se il cliente supera una custom_rate, la limitazione di frequenza diventa di 10 richieste al secondo per tutti i client proxy finché non viene inviata una richiesta senza l'intestazione custom_rate. Puoi utilizzare <Identifier> per raggruppare le richieste in modo da applicare tariffe personalizzate per diversi tipi di clienti. Se specifichi un valore per ref ma non imposti la tariffa nel corpo della <Rate> e il client non passa un valore, quindi il criterio SpikeArrest genera un errore.	Facoltativo	n/a

<UseEffectiveCount>

Questo elemento ti consente di scegliere tra algoritmi di arresto degli picchi distinti impostando il valore su true o false, come spiegato di seguito:

true

Se impostato su true, SpikeArrest viene distribuito in una regione. Ciò significa che i conteggi delle richieste vengono sincronizzati tra i processori di messaggi (MP) di una regione. Inoltre, viene utilizzato un algoritmo di limitazione di frequenza con "finestra scorrevole". Questo l'algoritmo fornisce un comportamento coerente della limitazione di frequenza e non "attenua" il numero di in entrata richieste che possono essere inviate al backend. Se viene inviata una serie di richieste in un breve intervallo di tempo, queste sono consentite a condizione che non superino il limite di frequenza configurato, come impostato nell'elemento <Rate>. Ad esempio:

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</Rate>
  <Identifier ref="client_id" />
  <MessageWeight ref="request.header.weight" />
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

false (valore predefinito)

Se impostato su false (il valore predefinito), il criterio SpikeArrest utilizza un algoritmo "bucket di token" che attenua i picchi di traffico dividendo il limite di frequenza specificato in intervalli più piccoli. Uno svantaggio di questo approccio è che più richieste legittime inviate in un breve intervallo di tempo possono essere potenzialmente rifiutate.

Ad esempio, supponi di inserire una frequenza di 30:00 (30 richieste al minuto). Durante i test, potresti Pensi che potresti inviare 30 richieste in un secondo, purché vengano ricevute entro un minuto. Ma questo è non il modo in cui il criterio applica l'impostazione. Se ci pensi, 30 richieste in un periodo di 1 secondo potrebbero essere considerate un mini picco in alcuni ambienti.

• Le tariffe al minuto vengono appiattite in richieste complete consentite a intervalli di secondi.
  

  Ad esempio, le ore 30:00 vengono semplificate in questo modo:
  60 secondi (1 minuto) / 30:00 = intervalli di 2 secondi o 1 richiesta consentita ogni 2 secondi. R una seconda richiesta entro 2 secondi non andrà a buon fine. Inoltre, una 31a richiesta entro un minuto non riuscito.

• Le tariffe al secondo vengono appiattite in richieste complete consentite in intervalli di millisecondi.

  Ad esempio, 10 pps viene appiattito come segue:
  1000 millisecondi (1 secondo) / 10 pps = intervalli di 100 millisecondi o 1 richiesta consentita ogni 100 millisecondi. Una seconda richiesta entro 100 ms avrà esito negativo. Inoltre, un'undicesima richiesta entro un secondo non riuscirà.

Nota: Nel perfezionamento della frequenza, il numero di richieste è sempre un numero intero maggiore di zero. L'appiattimento non comporta mai il calcolo di frazioni di richieste.

Valore predefinito	Falso
Obbligatorio?	Facoltativo
Tipo	Booleano
Elemento principale	<SpikeArrest>
Elementi secondari	Nessuno

Nella tabella seguente vengono descritti gli attributi dell'elemento <UseEffectiveCount>:

Attributo	Descrizione	Predefinito	Presenza
ref	Identifica la variabile che contiene il valore di <UseEffectiveCount>. Può essere Qualsiasi variabile di flusso, ad esempio parametro di query HTTP, intestazione o contenuti del corpo di un messaggio. Per ulteriori informazioni, consulta la sezione Riferimento alle variabili di flusso. Puoi anche impostare variabili personalizzate utilizzando il criterio JavaScript o il criterio Assegna messaggio.	n/a	Facoltativo

Variabili di flusso

Quando viene eseguito un criterio SpikeArrest, viene compilata la seguente variabile di flusso:

Variabile	Tipo	Autorizzazione	Descrizione
ratelimit.policy_name.failed	Booleano	Sola lettura	Indica se il criterio ha avuto esito positivo o meno (true o false).

Per ulteriori informazioni, consulta Riferimento per le variabili di flusso.

Messaggi di errore

Questa sezione descrive i codici e i messaggi di errore restituiti, nonché le variabili di errore. impostate da Apigee quando questo criterio attiva un errore. Queste informazioni sono importanti se stai sviluppando regole di errore per gestire gli errori. Per scoprire di più, consulta Informazioni importanti sugli errori relativi alle norme e Gestione degli errori.

Errori di runtime

Questi errori possono verificarsi durante l'esecuzione del criterio.

Suggerimento: hai bisogno di aiuto per risolvere un errore? Fai clic su nella colonna Correzione per informazioni dettagliate sulla risoluzione dei problemi.

Codice di errore	Stato HTTP	Causa	Correggi
policies.ratelimit.FailedToResolveSpikeArrestRate	500	Questo errore si verifica se il riferimento alla variabile contenente l'impostazione della tariffa all'interno dell'elemento <Rate> non può essere risolto in un valore all'interno di SpikeArrest . Questo elemento è obbligatorio e viene utilizzato per specificare il tasso di arresto dei picchi in nel formato intpm o intps.
policies.ratelimit.InvalidMessageWeight	500	Questo errore si verifica se il valore specificato per l'elemento <MessageWeight> tramite una variabile di flusso non è valido (un valore non intero).
policies.ratelimit.SpikeArrestViolation	429	Il limite di frequenza è stato superato.

Errori di deployment

Questi errori possono verificarsi quando esegui il deployment di un proxy contenente questo criterio.

Suggerimento: hai bisogno di aiuto per risolvere un errore? Fai clic su nella colonna Correzione per informazioni dettagliate sulla risoluzione dei problemi.

Nome errore	Causa	Correggi
InvalidAllowedRate	Se il tasso di arresto dei picchi specificato nell'elemento <Rate> di SpikeArrest Il criterio non è un numero intero o se la tariffa non ha ps o pm come suffisso, il deployment del proxy API non va a buon fine.

Variabili di errore

Queste variabili vengono impostate quando si verifica un errore di runtime. Per ulteriori informazioni, consulta Informazioni importanti sugli errori relativi alle norme.

Variabili	Dove	Esempio
fault.name="fault_name"	fault_name è il nome dell'errore, come elencato in Tabella Errori di runtime qui sopra. Il nome dell'errore è l'ultima parte del codice di errore.	fault.name Matches "SpikeArrestViolation"
ratelimit.policy_name.failed	policy_name è il nome specificato dall'utente del criterio che ha generato l'errore.	ratelimit.SA-SpikeArrestPolicy.failed = true

Esempio di risposta di errore

Di seguito è riportato un esempio di risposta di errore:

Nota: per la gestione degli errori, la best practice è il trap errorcode parte della risposta di errore. Non fare affidamento sul testo faultstring, perché potrebbe cambiare.

{  
   "fault":{  
      "detail":{  
         "errorcode":"policies.ratelimit.SpikeArrestViolation"
      },
      "faultstring":"Spike arrest violation. Allowed rate : 10ps"
   }
}

Esempio di regola di errore

Di seguito è riportato un esempio di regola di errore per gestire un errore SpikeArrestViolation:

<FaultRules>
    <FaultRule name="Spike Arrest Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "SpikeArrestViolation") </Condition>
        </Step>
        <Condition>ratelimit.Spike-Arrest-1.failed=true</Condition>
    </FaultRule>
</FaultRules>

L'attuale codice di stato HTTP per il superamento di un limite di frequenza impostato da un criterio Quota o SpikeArrest è 429 (Troppe richieste). Per modificare il codice di stato HTTP in 500 (errore interno del server), imposta la proprietà features.isHTTPStatusTooManyRequestEnabled su false utilizzando l'API Aggiorna proprietà dell'organizzazione.

Attenzione:quando aggiorni le proprietà, devi passare tutte le proprietà esistenti all'API, anche se non vengono modificate. Se non includi le proprietà nel payload della chiamata all'API Update organization properties (Aggiorna proprietà dell'organizzazione), le proprietà vengono rimosse. Per ottenere l'elenco corrente delle proprietà per l'ambiente, utilizza l'API GetOrganization.

Se tenti di impostare una proprietà, ma il valore aggiornato della proprietà non viene restituito nel payload della risposta, significa che la proprietà deve essere impostata da un utente con il ruolo sysadmin. Contatta l'assistenza Apigee per modificare il valore di una proprietà che richiede il ruolo sysadmin).

Ad esempio:

curl -u email:password -X POST -H "Content-type:application/xml" http://apigee.googleapis.com/v1/organizations/myorg -d \
"<Organization type="trial" name="MyOrganization">
    <Properties>
        <Property name="features.isHTTPStatusTooManyRequestEnabled">true</Property>
        . . .
    </Properties>
</Organization>"

Schemi

Ogni tipo di criterio è definito da uno schema XML (.xsd). Come riferimento, consulta gli schemi dei criteri sono disponibili su GitHub.

Argomenti correlati

• Criteri per le quote: criteri per le quote per limitare il traffico sui singoli client
• Limitazione di frequenza per una panoramica della limitazione di frequenza
• Confronto tra i criteri Quota e SpikeArrest