Política de SpikeArrest

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X. Información

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

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

Ejemplos

En los siguientes ejemplos, se muestran algunas de las formas en que puedes usar la política de 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 la política de Spike Arrest se pueda aplicar según el cliente. Por ejemplo, puedes agrupar solicitudes por ID de desarrollador, en cuyo caso las solicitudes de cada desarrollador se tendrán en cuenta para su propia tasa de detección de aumentos repentinos y no todas las solicitudes al 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 sola solicitud en el cálculo de la tasa de aumento de aumento repentino. 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 aumento repentino <Rate> es 10pm y una app envía solicitudes con un peso de 2, solo se permiten cinco mensajes por minuto de ese cliente, ya que 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 aumento de aumento repentinos en los procesadores de mensajes (MP) cuando se usan grupos de ajuste de escala automático.

<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 de 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 la tasa de aumento repentino de un miembro del Parlamento es el <Rate> dividido por la cantidad actual de MPS en el mismo grupo. El límite agregado es el valor de <Rate>. Cuando se agregan (o se quitan miembros) de forma dinámica, sus límites individuales de frecuencia de aumento aumentarán (o disminuirán), pero el límite agregado seguirá siendo el mismo.
• false (valor predeterminado si se omite): El límite de tasa de aumento repentino de cada MP es simplemente el valor de su <Rate>. El límite agregado es la suma de las tarifas de todos los miembros del Parlamento. Cuando se agreguen (o se quiten) miembros, sus límites individuales de tasa de aumento seguirán siendo los mismos, pero el límite agregado aumentará (o disminuirá).

En la siguiente tabla, se muestra el efecto de <UseEffectiveCount> en el límite de frecuencia 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 tasa efectiva por MP se mantiene igual (en 10). Sin embargo, cuando <UseEffectiveCount> es true, la tasa efectiva por MP pasa de 10 a 20 cuando la cantidad de MP se reduce 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

En esta sección, se describen los códigos y mensajes de error que se muestran, así como las variables de fallas que establece Edge cuando esta política activa un error. Esta información es importante para saber si estás desarrollando reglas de fallas con el propósito de manejar fallas. Para obtener más información, consulta Qué debes saber sobre los errores de políticas y Cómo solucionar fallas.

Errores de entorno de ejecución

Estos errores pueden producirse cuando se ejecuta la política.

Errores en la implementación

Estos errores pueden generarse cuando implementas un proxy que contiene esta política.

Variables con fallas

Estas variables se configuran cuando se genera un error de entorno de ejecución. Para obtener más información, consulta Qué debes saber sobre los errores de la política.

Ejemplo de respuesta de error

A continuación, se muestra un ejemplo de respuesta de error:

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

Ejemplo de regla de falla

A continuación, se muestra un ejemplo de regla de fallas para controlar una falla 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>

El código de estado HTTP actual para superar el límite de frecuencia establecido por una política de detección de aumentos repentinos o cuotas es 429 (Demasiadas solicitudes). Para cambiar el código de estado HTTP a 500 (Error interno del servidor), establece la propiedad features.isHTTPStatusTooManyRequestEnabled en false con la API Actualizar 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
• Cómo comparar las políticas de cuotas y SpikeArrest
• Muestras de trabajo de proxies de API