Zasada SpikeArrest

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Zasada Spike Arrest chroni przed nagłymi wzrostami ruchu dzięki elementowi <Rate>. Ten element ogranicza liczbę żądań przetwarzanych przez serwer proxy API i wysyłanych do backendu, chroniąc przed spadkiem wydajności i przestojami.

Element <SpikeArrest>

Określa zasadę Spike Arrest.

<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>

<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>true</UseEffectiveCount>
</SpikeArrest>

Ten element ma te atrybuty, które są wspólne dla wszystkich zasad:

Przykłady

Poniższe przykłady pokazują, jak można stosować zasadę Spike Arrest:

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

<SpikeArrest async="false" continueOnError="false" enabled="true" name="SpikeArreast">
  <DisplayName>SpikeArreast</DisplayName>
  <Rate>300pm</Rate>
</SpikeArrest>

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

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

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

Odwołanie do elementu podrzędnego

W tej sekcji opisujemy elementy podrzędne elementu <SpikeArrest>.

<DisplayName>

Oprócz atrybutu name możesz użyć innej, bardziej naturalnie brzmiącej nazwy do oznaczenia zasady w edytorze proxy w interfejsie zarządzania.

Element <DisplayName> jest wspólny dla wszystkich zasad.

Element <DisplayName> używa tej składni:

<PolicyElement>
  <DisplayName>policy_display_name</DisplayName>
  ...
</PolicyElement>

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

Element <DisplayName> nie ma atrybutów ani elementów podrzędnych.

<Identifier>

Umożliwia wybranie sposobu grupowania żądań, aby można było zastosować zasadę Spike Arrest na podstawie klienta. Możesz na przykład grupować żądania według identyfikatora dewelopera. W takim przypadku żądania każdego dewelopera będą się liczyć do jego własnego współczynnika Spike Arrest, a nie wszystkich żądań do serwera proxy.

Aby uzyskać bardziej szczegółową kontrolę nad ograniczaniem żądań, użyj elementu <MessageWeight>.

Jeśli element <Identifier> pozostanie pusty, dla wszystkich żądań wysyłanych do tego serwera proxy interfejsu API będzie obowiązywał jeden limit szybkości.

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

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

W tej tabeli opisano atrybuty <Identifier>:

Ten element jest również omawiany w tym poście w społeczności Apigee: http://community.apigee.com/questions/2807/how-does-the-edge-quota-policy-work-when-no-identi.html.

<MessageWeight>

Określa wagę zdefiniowaną dla każdego komunikatu. Waga wiadomości zmienia wpływ pojedynczego żądania na obliczenie współczynnika Spike Arrest. Waga wiadomości może być dowolną zmienną przepływu, np. nagłówkiem HTTP, parametrem zapytania, parametrem formularza lub treścią w treści wiadomości. Zmiennych niestandardowych możesz też używać w ramach zasad dotyczących JavaScriptu lub zasad dotyczących funkcji AssignMessage.

Używaj ich razem z <Identifier>, aby dodatkowo ograniczać liczbę żądań wysyłanych przez konkretnych klientów lub aplikacje.

Jeśli np. wartość <Rate> dla szczytowego zatrzymania <Rate> wynosi 10pm, a aplikacja przesyła żądania o ciężarze 2, z tego klienta dozwolone są tylko 5 wiadomości na minutę, ponieważ każde żądanie jest liczone jako 2.

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

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

W tej tabeli opisano atrybuty <MessageWeight>:

<Rate>

Określa szybkość, z jaką należy ograniczać skok (lub wzrost) natężenia ruchu, przez ustawienie liczby żądań dozwolonych w interwałach minutowych lub sekundowych. Możesz też użyć tego elementu w połączeniu z elementami <Identifier> i <MessageWeight>, aby płynnie ograniczać natężenie ruchu w czasie wykonywania, akceptując wartości od klienta.

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

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

<SpikeArrest async="false" continueOnError="false" enabled="true" name="SpikeArreast">
  <DisplayName>SpikeArreast</DisplayName>
  <Rate>300pm</Rate>
</SpikeArrest>

W tej tabeli opisano atrybuty <Rate>:

<Rate ref="request.header.custom_rate">1pm</Rate>

<UseEffectiveCount>

Przy użyciu autoskalowania rozkłada liczbę Spike Arrest na procesory wiadomości (MP) w grupach.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <UseEffectiveCount>[false|true]</UseEffectiveCount>
</SpikeArrest>

<SpikeArrest name='Spike-Arrest-1'>
  <Rate>40ps</Rate>
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

Element <UseEffectiveCount> jest opcjonalny. Wartość domyślna to false, jeśli element jest pominięty w zasadach Spike Arrest.

W tej tabeli opisano atrybuty elementu <UseEffectiveCount>:

Efekt działania funkcji <UseEffectiveCount> zależy od jej wartości:

• true: Ograniczenie częstotliwości szczytowej instancji usługi jest równe <Rate> podzielone przez bieżącą liczbę instancji usługi w tym samym podzie. Łączny limit to <Rate>. Gdy MP są dynamicznie dodawane (lub usuwane), ich indywidualne limity szybkości będą się zwiększać (lub zmniejszać), ale łączny limit pozostanie taki sam.
• false (jeśli nie zostanie podana, jest to wartość domyślna): limit szybkości szczytowej każdego MP jest po prostu wartością jego <Rate>. Łączny limit to suma stawek wszystkich MP. Gdy dodasz (lub usuniesz) MP, ich indywidualne limity szybkości skoku pozostaną bez zmian, ale łączny limit zostanie zwiększony (lub zmniejszony).

Poniższa tabela pokazuje wpływ wartości <UseEffectiveCount> na skuteczny limit stawki każdego MP:

W tym przykładzie zwróć uwagę, że gdy liczba MP zmniejszy się z 4 na 2, a <UseEffectiveCount> będzie równa false, skuteczna stawka na MP pozostanie taka sama (na poziomie 10). Gdy jednak <UseEffectiveCount> = true, skuteczna stawka na MP zmienia się z 10 na 20, gdy liczba MP zmniejsza się z 4 na 2.

Zmienne przepływu

Gdy zadziała reguła zapobiegania wzrostom, wypełnia się ta zmienna przepływu:

Więcej informacji znajdziesz w dokumentacji dotyczącej zmiennych przepływu.

Odniesienie do błędu

W tej sekcji opisano zwracane kody błędów i komunikaty o błędach oraz zmienne błędów ustawiane przez Edge, gdy ta zasada wywołuje błąd. Warto o tym wiedzieć, jeśli rozwijasz reguły błędów, aby obsługi błędów. Więcej informacji: Niezbędne informacje o błędach związanych z zasadami i postępowaniu z błędami

Błędy w czasie wykonywania

Te błędy mogą wystąpić podczas wykonywania zasady.

Błędy wdrażania

Te błędy mogą wystąpić podczas wdrażania serwera proxy zawierającego tę zasadę.

Zmienne błędów

Te zmienne są ustawiane po wystąpieniu błędu działania. Więcej informacji znajdziesz w artykule Podstawowe informacje o błędach związanych z naruszeniem zasad.

Przykładowa odpowiedź na błąd

Poniżej znajdziesz przykładową odpowiedź na błąd:

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

Przykładowa reguła błędu

Poniżej znajduje się przykładowa reguła błędu obsługi błędu 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>

Obecny kod stanu HTTP w przypadku przekroczenia limitu szybkości określonego przez zasadę dotyczącą limitu lub zatrzymania wzrostu to 429 (Za dużo żądań). Aby zmienić kod stanu HTTP na 500 (błąd wewnętrzny serwera), użyj interfejsu API Update organization properties, aby ustawić właściwość features.isHTTPStatusTooManyRequestEnabled na false.

Na przykład:

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

Schematy

Każdy typ zasad jest definiowany przez schemat XML (.xsd). Informacje na temat schematów zasad znajdziesz na GitHubie.

Powiązane artykuły

• Zasady dotyczące limitów: zasady dotyczące limitów, aby ograniczyć ruch dla poszczególnych klientów
• Ograniczenie szybkości – omówienie ograniczania szybkości
• Porównywanie zasad dotyczących limitów i SpikeArrest
• działające przykłady serwerów proxy interfejsu API