Политика SpikeArrest

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация

Политика Spike Arrest защищает от скачков трафика с помощью элемента <Rate> . Этот элемент регулирует количество запросов, обрабатываемых прокси-сервером API и отправляемых на серверную часть, защищая от задержек производительности и простоев.

Элемент <SpikeArrest>

Определяет политику 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>

This element has the following attributes that are common to all policies:

Примеры

В следующих примерах показаны некоторые способы использования политики 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'

Ссылка на дочерний элемент

В этом разделе описаны дочерние элементы <SpikeArrest> .

<DisplayName>

Используйте в дополнение к атрибуту name , чтобы пометить политику в редакторе прокси-сервера пользовательского интерфейса управления другим, более естественным именем.

Элемент <DisplayName> является общим для всех политик.

Элемент <DisplayName> использует следующий синтаксис:

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

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

Элемент <DisplayName> не имеет атрибутов или дочерних элементов.

<Identifier>

Позволяет выбрать, как группировать запросы, чтобы можно было применить политику Spike Arrest в зависимости от клиента. Например, вы можете группировать запросы по идентификатору разработчика, и в этом случае запросы каждого разработчика будут учитываться при расчете его собственного показателя Spike Arrest, а не всех запросов к прокси.

Используйте вместе с элементом <MessageWeight> для более детального управления регулированием запросов.

Если вы оставите элемент <Identifier> пустым, для всех запросов к этому прокси-серверу 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>

В следующей таблице описаны атрибуты <Identifier> :

Этот элемент также обсуждается в следующем сообщении сообщества Apigee: http://community.apigee.com/questions/2807/how-does-the-edge-quota-policy-work-when-no-identi.html .

<MessageWeight>

Указывает вес, определенный для каждого сообщения. Вес сообщения изменяет влияние одного запроса на вычисление частоты пиковых арестов. Весом сообщения может быть любая переменная потока, например заголовок HTTP, параметр запроса, параметр формы или содержимое тела сообщения. Вы также можете использовать пользовательские переменные, используя политику JavaScript или политику AssignMessage .

Используйте вместе с <Identifier> для дальнейшего регулирования запросов со стороны определенных клиентов или приложений.

Например, если Spike Arrest <Rate> равен 10pm и приложение отправляет запросы с весом 2 , то от этого клиента разрешено только пять сообщений в минуту, поскольку каждый запрос считается как 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>

В следующей таблице описаны атрибуты <MessageWeight> :

<Rate>

Указывает скорость, с которой следует ограничивать всплески (или всплески) трафика, устанавливая количество разрешенных запросов с интервалом в минуту или в секунду. Вы также можете использовать этот элемент в сочетании с <Identifier> и <MessageWeight> , чтобы плавно регулировать трафик во время выполнения, принимая значения от клиента.

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

В следующей таблице описаны атрибуты <Rate> :

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

<UseEffectiveCount>

Распределяет количество пиковых арестов по процессорам сообщений (MP) при использовании групп автоматического масштабирования.

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

Элемент <UseEffectiveCount> является необязательным. Значение по умолчанию — false если элемент исключен из вашей политики Spike Arrest.

В следующей таблице описаны атрибуты элемента <UseEffectiveCount> :

Эффект <UseEffectiveCount> зависит от его значения:

• true : предел скорости скачка MP равен <Rate> разделенному на текущее количество MP в одном модуле. Совокупный лимит — это значение <Rate> . Когда MP динамически добавляются (или удаляются), их индивидуальные пределы скорости всплесков увеличиваются (или уменьшаются), но совокупный лимит остается прежним.
• false (это значение по умолчанию, если оно опущено): предел скорости всплеска каждого MP — это просто значение его <Rate> . Совокупный лимит представляет собой сумму ставок всех депутатов. Когда MP добавляются (или удаляются), их индивидуальные ограничения скорости всплеска останутся прежними, но совокупный лимит увеличится (или уменьшится).

В следующей таблице показано влияние <UseEffectiveCount> на эффективный предел скорости каждого MP:

В этом примере обратите внимание, что когда количество MP уменьшается с 4 до 2, а <UseEffectiveCount> имеет значение false , эффективная ставка на MP остается прежней (10). Но когда <UseEffectiveCount> имеет значение true , эффективная ставка на МП увеличивается с 10 до 20, когда количество МП уменьшается с 4 до 2.

Переменные потока

При выполнении политики Spike Arrest заполняется следующая переменная потока:

Дополнительные сведения см. в разделе Справочник по переменным потока .

Ссылка на ошибку

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error response

Shown below is an example error response:

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

Example fault rule

Shown below is an example fault rule to handle a SpikeArrestViolation fault:

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

Текущий код состояния HTTP для превышения ограничения скорости, установленного политикой квоты или пикового ареста, — 429 (слишком много запросов). Чтобы изменить код состояния HTTP на 500 (внутренняя ошибка сервера), установите для свойства features.isHTTPStatusTooManyRequestEnabled значение false с помощью API обновления свойств организации .

Например:

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

Схемы

Каждый тип политики определяется схемой XML ( .xsd ). Для справки: схемы политик доступны на GitHub.

Связанные темы

• Политика квот : политика квот для ограничения трафика на отдельных клиентах.
• Ограничение скорости для обзора ограничения скорости
• Сравнение политик квот и SpikeArrest
• Рабочие образцы API-прокси