Zasada SpikeArrest

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Zasady dotyczące zatrzymania szczytu chronią przed wzrostem natężenia ruchu dzięki elementowi <Rate>. Ten ogranicza liczbę żądań przetwarzanych przez serwer proxy interfejsu API i wysłanych do backendu, i chroni przed opóźnieniami w wydajności i przestojami.

<SpikeArrest> element

Definiuje zasady dotyczące aresztowania gwałtownego wzrostu.

<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ą niektóre sposoby wykorzystania zasady Spike Arrest:

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

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</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'

Odniesienie do elementu podrzędnego

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

<DisplayName>

Używaj oprócz atrybutu name do oznaczania zasady w edytor serwera proxy w interfejsie zarządzania o innej, bardziej naturalnie brzmiącej nazwie.

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

Element <DisplayName> ma taką 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>

Pozwalają wybrać, jak pogrupować żądania, tak aby można było stosować zasady dotyczące zatrzymania gwałtownego wzrostu na klienta. Na przykład możesz pogrupować żądania według identyfikatora programisty, przy czym każde żądanie Żądania dewelopera będą uwzględniane w jego własnym wskaźniku zatrzymania szczytu, a nie wszystkie serwera proxy.

Aby uzyskać bardziej szczegółowe dane, użyj w połączeniu z elementem <MessageWeight> kontrolę nad ograniczaniem liczby żądań.

Jeśli pozostawisz element <Identifier> pusty, dla wszystkich żądań zostanie narzucony jeden limit liczby żądań do tego serwera proxy interfejsu API.

<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 poniższej tabeli opisano atrybuty <Identifier>:

Ten element jest też omówiony w tym poście na karcie Społeczność 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żdej wiadomości. Waga wiadomości modyfikuje wpływ pojedynczego żądania dotyczącego obliczenia współczynnika aresztowania gwałtownego wzrostu. Waga wiadomości może być dowolna np. nagłówek HTTP, parametr zapytania, parametr formularza lub treść wiadomości. Możesz też użyć zmiennych niestandardowych, korzystając z zasad dotyczących JavaScriptu lub AssignMessage (zasada AssignMessage).

Użycie w połączeniu z <Identifier> do dalszego ograniczania żądań przez określonych klientów lub aplikacji.

Jeśli na przykład zdarzenie Spike Arrest <Rate> ma wartość 10pm, a aplikacja przesyła żądań o wadze 2, dozwolone jest tylko 5 wiadomości na minutę tego klienta, bo każde żądanie liczy się 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 poniższej tabeli opisano atrybuty <MessageWeight>:

<Rate>

Określa częstotliwość ograniczania skoków (lub skoków) ruchu, ustawiając liczbę dozwolonych żądań na minutę lub na sekundę. Tego elementu możesz też użyć w konsola z <Identifier> i <MessageWeight> do płynnie ograniczaj ruch w czasie działania, 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 name="Spike-Arrest-1">
  <Rate>12pm</Rate>
</SpikeArrest>

W poniższej tabeli opisano atrybuty <Rate>:

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

<UseEffectiveCount>

Rozdziela dane o wysokim wskaźniku retencji między procesorami komunikatów podczas korzystania z autoskalowania grup.

<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. gdy element jest pomijany w zasadzie Spike Arrest.

W tej tabeli opisano atrybuty elementu <UseEffectiveCount>:

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

• true: limit częstotliwości nagłego zwiększenia limitu to <Rate> podzielony przez bieżącą liczbę megapikseli w tym samym bloku reklamowym. Limit zbiorczy to wartość z <Rate>. Gdy członkowie MP są dynamicznie dodawane (lub usuwane), ich poszczególne skoki limity liczby żądań wzrosną (lub zmaleją), ale limit zbiorczy pozostanie bez zmian;
• false (jest to wartość domyślna, jeśli zostanie pominięta): limit częstotliwości gwałtownego wzrostu dla każdego MP wynosi po prostu wartość jego <Rate>. Limit zbiorczy to suma stawek wszystkich spadających elementów. Po dodaniu (lub usunięciu członków) ich indywidualne limity częstotliwości skoków pozostaną takie same, ale łączny limit wzrośnie (lub ).

W tabeli poniżej pokazujemy wpływ funkcji <UseEffectiveCount> na efektywny limit stawki każdy megapiksel:

Zwróć uwagę, że w tym przykładzie liczba członków MP zmniejszyła się z 4 do 2, <UseEffectiveCount> wynosi false, efektywna stawka na megapiksele pozostaje bez zmian (przy 10) Jeśli jednak <UseEffectiveCount> wynosi true, rzeczywista stawka na megapiksele wynosi Od 10 do 20, gdy liczba MP zmniejszy się z 4 do 2.

Zmienne przepływu

Po wykonaniu tej zasady zapełniana jest ta zmienna przepływu:

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

Informacje o błędzie

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>

bieżący kod stanu HTTP informujący o przekroczeniu limitu częstotliwości ustalonego przez zasadę dotyczącą limitu lub zwiększenia ruchu. to 429 (zbyt wiele żądań). Aby zmienić kod stanu HTTP na 500 (Wewnętrzny błąd serwera), ustaw wartość usługę features.isHTTPStatusTooManyRequestEnabled do usługi false za pomocą Zaktualizuj interfejs Organization properties API.

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). Schematy zasad są dostępne na GitHubie.

Powiązane artykuły

• Zasady dotyczące limitów: limit zasady ograniczające ruch w przypadku pojedynczych klientów
• Ograniczenie liczby żądań w przypadku ograniczenia liczby żądań podsumowanie
• Porównanie Zasady dotyczące limitów i spikeArrest
• Próbne próbki serwerów proxy interfejsów API