SpikeArrest politikası

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

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

<SpikeArrest> öğe

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 yöntemlerden bazıları gösterilmektedir:

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

Alt öğe referansı

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

<DisplayName>

Politikayı, yönetim kullanıcı arayüzü proxy düzenleyicisinde farklı, 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>

Spike Arrest politikasının istemciye göre uygulanabilmesi için isteklerin nasıl gruplandırılacağını seçebilmenizi sağlar. Örneğin, istekleri geliştirici kimliğine göre gruplandırabilirsiniz. Bu durumda her geliştiricinin istekleri, proxy'ye yapılan tüm istekler değil kendi Spike Arrest oranına dahil edilir.

İstek kısıtlama ü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 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> özellikleri açıklanmaktadır:

Bu unsur, şu Apigee Topluluğu gönderisinde de ele alınmıştır: http://community.apigee.com/questions/2807/how-does-the-edge-quota-policy-work-when-no-identi.html.

<MessageWeight>

Her mesaj için tanımlanan ağırlıklandırmayı belirtir. Mesaj ağırlığı, tek bir isteğin Spike Arrest oranının hesaplanması üzerindeki etkisini değiştirir. Mesaj ağırlığı HTTP üst bilgisi, sorgu parametresi, form parametresi veya mesaj gövdesi içeriği gibi herhangi bir akış değişkeni olabilir. JavaScript politikasını veya assignMessage politikasını kullanarak da özel değişkenler kullanabilirsiniz.

Belirli istemciler veya uygulamalardan gelen istekleri daha da azaltmak için <Identifier> ile birlikte kullanın.

Örneğin, Spike Arrest <Rate> 10pm ise ve bir uygulama 2 ağırlığında istekler gönderirse her istek 2 sayılır. Bu nedenle söz konusu istemciden dakikada yalnızca beş mesaja izin verilir.

<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> özellikleri açıklanmaktadır:

<Rate>

Dakika veya saniye başına izin verilen istek sayısını ayarlayarak trafik artışlarının (veya patlamalarının) sınırlanacağı hızı belirtir. Bu öğeyi, istemciden değerler kabul ederek çalışma zamanında trafiği sorunsuz bir şekilde azaltmak 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 name="Spike-Arrest-1">
  <Rate>12pm</Rate>
</SpikeArrest>

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

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

<UseEffectiveCount>

Otomatik ölçeklendirme gruplarını kullanırken Spike Arrest sayılarınızı Mesaj İşlemcilere (MP'ler) 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 Spike Arrest politikanızdan çıkarıldığında varsayılan değer false olur.

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

<UseEffectiveCount> işlevinin etkisi, değerine bağlıdır:

• true: Bir MP'nin artış oranı 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) bağımsız artış oranı sınırları artar (veya azalır) ancak toplam sınır aynı kalır.
• false (atlanırsa varsayılan değerdir): Her MP'nin ani artış hızı sınırı, sadece <Rate> değeridir. Toplam sınır, tüm MP'lerin oranlarının toplamıdır. MP'ler eklendiğinde (veya kaldırıldığında) bireysel artış oranı sınırları aynı kalır ancak toplam sınır artar (veya azalır).

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

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

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ı

Bu bölümde, bu politika bir hatayı tetiklediğinde Edge tarafından ayarlanan hata kodları ve hata mesajları ile döndürülen hata değişkenleri açıklanmaktadır. Bu bilgiyi, hataları ele almak için hata kuralları geliştirip geliştirmediğinizi bilmeniz önemlidir. Daha fazla bilgi için Politika hataları hakkında bilmeniz gerekenler ve Hataları işleme bölümlerine bakın.

Çalışma zamanı hataları

Politika yürütüldüğünde bu hatalar ortaya çıkabilir.

Dağıtım hataları

Bu hatalar, bu politikayı içeren bir proxy dağıttığınızda ortaya çıkabilir.

Hata değişkenleri

Bu değişkenler, bir çalışma zamanı hatası oluştuğunda ayarlanır. Daha fazla bilgi için Politika hataları hakkında bilmeniz gerekenler bölümüne bakın.

Örnek hata yanıtı

Aşağıda örnek bir hata yanıtı gösterilmektedir:

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

Hata kuralı örneği

Aşağıda, bir SpikeArrestViolation hatasını işlemek için gereken örnek bir hata kuralı gösterilmektedir:

<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 Tutuklama politikası tarafından belirlenen hız sınırının aşılması için geçerli HTTP durum kodu 429 (Çok Fazla İstek) şeklindedir. HTTP durum kodunu 500 (Dahili Sunucu Hatası) olarak değiştirmek için Güncelleme kuruluş özelliklerini API'yi kullanarak features.isHTTPStatusTooManyRequestEnabled özelliğini false olarak ayarlayı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, GitHub'da politika şemaları bulunabilir.

İlgili konular

• Kota politikası: Tek tek istemcilerdeki trafiği sınırlamak için kullanılan kota politikası
• Hız sınırlamasına genel bakış için hız sınırlaması
• Kota ve SpikeArrest Politikalarını Karşılaştırma
• API proxy'lerinin çalışma örnekleri