Política de SpikeArrest

Estás viendo la documentación de Apigee Edge.
Ve a la Documentación de Apigee X. información

La política Spike Arrest protege contra los aumentos de tráfico con el elemento <Rate>. Este elemento regula la cantidad de solicitudes que procesa un proxy de API y se envía a un backend, lo que protege contra los retrasos de rendimiento y el tiempo de inactividad.

Elemento <SpikeArrest>

Define la política de 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>

Este elemento tiene los siguientes atributos que son comunes a todas las políticas:

Ejemplos

En los siguientes ejemplos, se muestran algunas de las formas en que puedes usar la política 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'

Referencia del elemento secundario

En esta sección, se describen los elementos secundarios de <SpikeArrest>.

<DisplayName>

Se usan además del atributo name para etiquetar la política en el editor de proxy de la IU de administración con un nombre de lenguaje natural diferente.

El elemento <DisplayName> es común a todas las políticas.

El elemento <DisplayName> usa la siguiente sintaxis:

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

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

El elemento <DisplayName> no tiene atributos ni elementos secundarios.

<Identifier>

Te permite elegir cómo agrupar las solicitudes para que se pueda aplicar la política Spike Arrest según en el cliente. Por ejemplo, puedes agrupar las solicitudes por ID de desarrollador, en cuyo caso cada las solicitudes de los desarrolladores se contabilizarán en su propia tasa de Spike Arrest y no todas las solicitudes a proxy.

Instala junto con el elemento <MessageWeight> para obtener un control más preciso sobre la regulación de solicitudes.

Si dejas el elemento <Identifier> vacío, se aplica un límite de frecuencia para todas las solicitudes a ese proxy de 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>

En la siguiente tabla, se describen los atributos de <Identifier>:

Este elemento también se analiza en la siguiente publicación de la Comunidad de Apigee: http://community.apigee.com/questions/2807/how-does-the-edge-quota-policy-work-when-no-identi.html.

<MessageWeight>

Especifica la ponderación definida para cada mensaje. El peso del mensaje modifica el impacto de una única solicitud sobre el cálculo de la tasa de Spike Arrest. El peso del mensaje puede ser cualquier variable de flujo, como un encabezado HTTP, un parámetro de consulta, un parámetro de formulario o contenido del cuerpo del mensaje. También puedes usar variables personalizadas mediante la política de JavaScript o la Política de AssignMessage.

Usa junto con <Identifier> para limitar aún más las solicitudes de clientes o apps específicos.

Por ejemplo, si el argumento Spike Arrest <Rate> es 10pm y una app envía con un peso de 2, entonces solo se permiten cinco mensajes por minuto desde porque cada solicitud cuenta como 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>

En la siguiente tabla, se describen los atributos de <MessageWeight>:

<Rate>

Especifica la frecuencia a la que se deben limitar los aumentos repentinos de tráfico (o aumentos de actividad) mediante la configuración de la cantidad de solicitudes permitidas en intervalos por minuto o por segundo. También puedes usar este elemento junto con <Identifier> y <MessageWeight> a fin de limitar el tráfico en el entorno de ejecución con facilidad. Para ello, debes aceptar valores del cliente.

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

En la siguiente tabla, se describen los atributos de <Rate>:

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

<UseEffectiveCount>

Distribuye los recuentos de Spike Arrest entre Message Processor (MP) cuando se usa el ajuste de escala automático. grupos.

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

El elemento <UseEffectiveCount> es opcional. El valor predeterminado es false. Cuando se omite el elemento de tu política Spike Arrest.

En la siguiente tabla, se describen los atributos del elemento <UseEffectiveCount>:

El efecto de <UseEffectiveCount> depende de su valor:

• true: El límite de frecuencia de aumento de un MP es el <Rate> dividido por la cantidad actual de miembros del Parlamento en el mismo grupo de anuncios. El límite agregado es el valor de <Rate>. Cuando se agregan (o se quitan miembros del Parlamento de forma dinámica), sus aumentos los límites de frecuencia aumentarán (o disminuirán), pero el límite global se mantendrá igual.
• false (este es el valor predeterminado si se omite): El límite de tasa de aumento de cada MP es solo el valor de su <Rate>. El límite agregado es la suma de las tasas de todos los MP. Cuando se agregan (o se eliminan los MP) sus límites de tasa de aumento repentinos individuales se mantendrán iguales, pero el límite agregado aumentará (o disminuir).

En la siguiente tabla, se muestra el efecto de <UseEffectiveCount> en el límite de tasa efectivo de cada MP:

En este ejemplo, observa que cuando la cantidad de MP se reduce de 4 a 2, y <UseEffectiveCount> es false, la tarifa efectiva por MP no cambia (en 10). Pero cuando <UseEffectiveCount> es true, la tasa efectiva por MP pasa de De 10 a 20 cuando la cantidad de MPS disminuye de 4 a 2.

Variables de flujo

Cuando se ejecuta una política de Spike Arrest, se propaga la siguiente variable de flujo:

Para obtener más información, consulta Referencia de variables de flujo.

Referencia de errores

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>

El código de estado HTTP actual para exceder un límite de frecuencia establecido por una política de Quota o Spike Arrest es 429 (Demasiadas solicitudes). Para cambiar el código de estado HTTP a 500, sigue estos pasos: (Error interno del servidor), configura el propiedad features.isHTTPStatusTooManyRequestEnabled a false con el Actualiza la API de propiedades de la organización.

Por ejemplo:

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

Esquemas

Un esquema XML (.xsd) define cada tipo de política. Como referencia, los esquemas de políticas están disponibles en GitHub.

Temas relacionados

• Política de cuotas: Política de cuotas, para limitar el tráfico en clientes individuales
• Límite de frecuencia para una descripción general sobre el límite de frecuencia
• Comparación Políticas de cuota y SpikeArrest
• Muestras de trabajo de proxies de API