SpikeArrest politikası

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. info

Spike Arrest politikası, <Rate> öğesiyle trafik artışlarına karşı koruma sağlar. Bu öğe, bir API proxy'si tarafından işlenen ve bir arka uca gönderilen isteklerin sayısını kısıtlayarak performans gecikmelerine ve kapalı kalma süresine karşı koruma sağlar.

<SpikeArrest> öğesi

Spike Arrest politikasını tanımlar.

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

Bu öğe, tüm politikalarda ortak olan aşağıdaki özelliklere sahiptir:

Örnekler

Aşağıdaki örneklerde, Spike Arrest politikasını kullanabileceğiniz bazı yöntemler gösterilmektedir:

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

Alt öğe referansı

Bu bölümde, <SpikeArrest> öğesinin alt öğeleri açıklanmaktadır.

<DisplayName>

Politikayı yönetim kullanıcı arayüzü proxy düzenleyicisinde farklı ve daha doğal bir adla etiketlemek için name özelliğine ek olarak kullanın.

<DisplayName> öğesi tüm politikalarda ortaktır.

<DisplayName> öğesi şu söz dizimini kullanır:

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

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

<DisplayName> öğesinin özelliği veya alt öğesi yoktur.

<Identifier>

İstekleri nasıl gruplandıracağınızı seçmenize olanak tanır. Böylece, Spike Arrest politikası istemciye göre uygulanabilir. Örneğin, istekleri geliştirici kimliğine göre gruplandırabilirsiniz. Bu durumda, her geliştiricinin istekleri, proxy'ye gönderilen tüm istekler yerine kendi ani artış engelleme hızına göre sayılır.

İstek sınırlama üzerinde daha ayrıntılı kontrol için <MessageWeight> öğesiyle birlikte kullanın.

<Identifier> öğesini boş bırakırsanız bu API proxy'sine yapılan tüm istekler için tek bir hız sınırı uygulanır.

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

Aşağıdaki tabloda <Identifier> öğesinin özellikleri açıklanmaktadır:

Bu öğe, şu Apigee Topluluğu yayınında da ele alınmıştır: http://community.apigee.com/questions/2807/how-does-the-edge-quota-policy-work-when-no-identi.html.

<MessageWeight>

Her ileti için tanımlanan ağırlığı belirtir. Mesaj ağırlığı, tek bir isteğin ani artış önleme oranının hesaplanması üzerindeki etkisini değiştirir. İleti ağırlığı, HTTP üstbilgisi, sorgu parametresi, form parametresi veya ileti gövdesi içeriği gibi herhangi bir akış değişkeni olabilir. JavaScript politikası veya AssignMessage politikası ile özel değişkenler de kullanabilirsiniz.

Belirli istemciler veya uygulamalar tarafından yapılan istekleri daha da sınırlamak için <Identifier> ile birlikte kullanın.

Örneğin, ani artış önleme <Rate> değeri 10pm ise ve bir uygulama 2 ağırlığında istek gönderiyorsa bu istemciden dakikada yalnızca beş mesaja izin verilir. Bunun nedeni, her isteğin 2 olarak sayılmasıdır.

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

Aşağıdaki tabloda <MessageWeight> öğesinin özellikleri açıklanmaktadır:

<Rate>

Dakika veya saniye aralıklarında izin verilen istek sayısını ayarlayarak trafik artışlarını (veya patlamalarını) sınırlama hızını belirtir. Bu öğeyi, istemciden değer kabul ederek çalışma zamanında trafiği sorunsuz bir şekilde sınırlamak için <Identifier> ve <MessageWeight> ile birlikte de kullanabilirsiniz.

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

Aşağıdaki tabloda <Rate> öğesinin özellikleri açıklanmaktadır:

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

<UseEffectiveCount>

Otomatik ölçeklendirme grupları kullanılırken ani artış engelleme sayılarınızı mesaj işlemciler (MP) arasında dağıtır.

<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> öğesi isteğe bağlıdır. Öğe, ani artış engelleme politikanızda atlandığında varsayılan değer false olur.

Aşağıdaki tabloda <UseEffectiveCount> öğesinin özellikleri açıklanmaktadır:

<UseEffectiveCount> öğesinin etkisi değerine bağlıdır:

• true: Bir MP'nin ani artış hızı sınırı, <Rate> değerinin aynı kapsüldeki mevcut MP sayısına bölünmesiyle elde edilir. Toplam sınır, <Rate> değeridir. MP'ler dinamik olarak eklendiğinde (veya kaldırıldığında) her birinin ayrı ayrı ani artış sıklığı sınırları artar (veya azalır) ancak toplam sınır aynı kalır.
• false: Her MP'nin ani artış hızı sınırı, <Rate> değeridir. Toplu sınır, tüm MP'lerin oranlarının toplamıdır. MP'ler eklendiğinde (veya kaldırıldığında) bunların bireysel ani artış hızı sınırları aynı kalır ancak toplu sınır artar (veya azalır).

SpikeArrest politikası, belirttiğiniz hız sınırını daha küçük aralıklara bölerek trafik artışlarını yumuşatan bir "token bucket" algoritması kullanır. Bu yaklaşımın dezavantajı, kısa bir süre içinde gelen birden fazla meşru isteğin reddedilebilmesidir.

Örneğin, 30pm (dakikada 30 istek) hızını girdiğinizi varsayalım. Test sırasında, bir dakika içinde gönderildiği sürece 1 saniyede 30 istek gönderebileceğinizi düşünebilirsiniz. Ancak politika, ayarı bu şekilde zorunlu kılmaz. Düşündüğünüzde, 1 saniyelik süre içinde 30 istek bazı ortamlarda küçük bir ani artış olarak kabul edilebilir.

• Dakika başına oranlar, saniyelik aralıklarla izin verilen tam istekler hâline getirilir.
  

  Örneğin, 30pm değeri şu şekilde düzeltilir:
  60 saniye (1 dakika) / 30pm = 2 saniyelik aralıklar veya her 2 saniyede 1 istek gönderilmesine izin verilir. 2 saniye içinde gönderilen ikinci istek başarısız olur. Ayrıca, bir dakika içinde 31. istek de başarısız olur.

• Saniye başına oranlar, milisaniye aralıklarında izin verilen tam istekler olarak düzeltilir.

  Örneğin, 10ps şu şekilde düzeltilir:
  1.000 milisaniye (1 saniye) / 10ps = 100 milisaniyelik aralıklar veya her 100 milisaniyede 1 isteğe izin verilir. 100 ms içinde gönderilen ikinci istek başarısız olur. Ayrıca, bir saniye içinde gönderilen 11. istek başarısız olur.

Aşağıdaki tabloda, <UseEffectiveCount> değerinin her MP'nin etkin hız sınırına etkisi gösterilmektedir:

Bu örnekte, MP sayısı 4'ten 2'ye düşürüldüğünde ve <UseEffectiveCount> değeri false olduğunda MP başına etkili oranın aynı kaldığını (10) unutmayın. Ancak <UseEffectiveCount>, true olduğunda MP sayısı 4'ten 2'ye düşürüldüğünde MP başına etkin oran 10'dan 20'ye çıkar.

Akış değişkenleri

Spike Arrest politikası yürütüldüğünde aşağıdaki akış değişkeni doldurulur:

Daha fazla bilgi için Akış değişkenleri referansı başlıklı makaleyi inceleyin.

Hata referansı

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>

Kota veya ani artış önleme politikası tarafından belirlenen bir hız sınırının aşılmasıyla ilgili mevcut HTTP durum kodu 429 (Çok Fazla İstek) şeklindedir. HTTP durum kodunu 500 (Dahili Sunucu Hatası) olarak değiştirmek için features.isHTTPStatusTooManyRequestEnabled özelliğini false olarak ayarlayın. Bu işlem için Update organization properties API'sini kullanın.

Örneğin:

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

Şemalar

Her politika türü bir XML şeması (.xsd) ile tanımlanır. Referans olarak politika şemaları GitHub'da mevcuttur.

İlgili konular

• Kota politikası: Kota politikası, tek tek istemcilerdeki trafiği sınırlamak için kullanılır.
• Hız sınırlamasına genel bakış için hız sınırlaması
• Kota ve SpikeArrest Politikalarını Karşılaştırma
• Çalışan API proxy'si örnekleri