Kebijakan SpikeArrest

Anda sedang melihat dokumentasi Apigee Edge.
Buka Dokumentasi Apigee X. info

Kebijakan Penangkapan Lonjakan melindungi jaringan dari lonjakan traffic dengan elemen <Rate>. Ini men-throttle jumlah permintaan yang diproses oleh proxy API dan dikirim ke backend, untuk melindungi dari jeda performa dan periode nonaktif.

Elemen <SpikeArrest>

Menentukan kebijakan Lonjakan.

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

Contoh

Contoh berikut menunjukkan beberapa cara untuk menggunakan kebijakan Penangkapan Lonjakan:

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

Referensi elemen turunan

Bagian ini menjelaskan elemen turunan dari <SpikeArrest>.

<DisplayName>

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, more natural-sounding name.

The <DisplayName> element is common to all policies.

The <DisplayName> element uses the following syntax:

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

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

The <DisplayName> element has no attributes or child elements.

<Identifier>

Memungkinkan Anda memilih cara mengelompokkan permintaan sehingga kebijakan Penangkapan Lonjakan dapat diterapkan berdasarkan pada klien. Misalnya, Anda dapat mengelompokkan permintaan berdasarkan ID developer, dalam hal ini masing-masing permintaan pengembang akan diperhitungkan dalam tingkat Penangkapan Lonjakan mereka sendiri dan tidak semua permintaan ke {i>proxy<i}.

Gunakan bersama dengan elemen <MessageWeight> agar informasi lebih mendetail mengontrol throttling permintaan.

Jika Anda mengosongkan elemen <Identifier>, satu batas kapasitas akan diterapkan untuk semua permintaan ke proxy API tersebut.

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

Tabel berikut menjelaskan atribut <Identifier>:

Elemen ini juga dibahas dalam postingan Komunitas Apigee berikut: http://community.apigee.com/questions/2807/how-does-the-edge-quota-policy-work-when-no-identi.html.

<MessageWeight>

Menentukan pembobotan yang ditentukan untuk setiap pesan. Bobot pesan mengubah dampaknya atas satu permintaan pada perhitungan Tingkat Penahanan Lonjakan. Bobot pesan dapat berupa berapa pun variabel alur, seperti header HTTP, parameter kueri, parameter formulir, atau konten isi pesan. Anda juga dapat menggunakan variabel kustom menggunakan kebijakan JavaScript atau Kebijakan Menetapkan Pesan.

Gunakan bersama dengan <Identifier> untuk membatasi permintaan lebih lanjut dengan klien atau aplikasi tertentu.

Misalnya, jika Spike Arrest <Rate> adalah 10pm, dan aplikasi mengirimkan permintaan dengan bobot 2, maka hanya lima pesan per menit yang diizinkan dari klien tersebut karena setiap permintaan dihitung sebagai 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>

Tabel berikut menjelaskan atribut <MessageWeight>:

<Rate>

Menentukan rasio untuk membatasi lonjakan (atau burst) traffic dengan menetapkan jumlah yang diizinkan dalam interval per menit atau per detik. Anda juga dapat menggunakan elemen ini dalam bersama dengan <Identifier> dan <MessageWeight> untuk membatasi traffic secara lancar saat runtime dengan menerima nilai dari klien.

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

Tabel berikut menjelaskan atribut <Rate>:

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

<UseEffectiveCount>

Mendistribusikan jumlah lonjakan Lonjakan ke seluruh Pemroses Pesan (MP) saat menggunakan penskalaan otomatis grup.

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

Elemen <UseEffectiveCount> bersifat opsional. Nilai defaultnya adalah false jika elemen tersebut dihilangkan dari kebijakan Penangkapan Spike Anda.

Tabel berikut menjelaskan atribut elemen <UseEffectiveCount>:

Efek <UseEffectiveCount> bergantung pada nilainya:

• true: Batas kecepatan lonjakan seorang MP adalah <Rate> dibagi dengan jumlah anggota parlemen saat ini dalam pod yang sama. Batas gabungan adalah nilai dari <Rate>. Saat anggota parlemen ditambahkan (atau dihapus) secara dinamis, masing-masing lonjakan batas kapasitas akan meningkat (atau menurun), tetapi batas gabungan akan tetap sama.
• false (ini adalah nilai default jika dihilangkan): Batas kapasitas lonjakan setiap MP adalah cukup nilai <Rate>-nya. Batas agregat adalah jumlah jumlah anggota parlemen. Ketika anggota parlemen ditambahkan (atau dihapus), batas kapasitas lonjakan individual akan tetap sama, tetapi batas gabungan akan meningkat (atau ).

Tabel berikut menunjukkan efek <UseEffectiveCount> pada batas kapasitas efektif setiap MP:

Dalam contoh ini, perhatikan bahwa ketika jumlah anggota parlemen berkurang dari 4 menjadi 2, dan <UseEffectiveCount> adalah false, rasio efektif per MP tetap sama (pada 10.) Namun, jika <UseEffectiveCount> adalah true, rasio efektif per MP berubah dari Dari 10 menjadi 20, jumlah anggota parlemen berkurang dari 4 menjadi 2.

Variabel flow

Saat kebijakan Spike Arrest dijalankan, variabel flow berikut akan diisi:

Untuk mengetahui informasi selengkapnya, lihat Referensi variabel flow.

Referensi error

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>

Kode status HTTP saat ini karena melebihi batas kapasitas yang ditetapkan oleh kebijakan Kuota atau Lonjakan adalah 429 (Terlalu Banyak Permintaan). Untuk mengubah kode status HTTP menjadi 500 (Error Server Internal), setel properti features.isHTTPStatusTooManyRequestEnabled ke false menggunakan Mengupdate API properti organisasi.

Contoh:

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

Skema

Setiap jenis kebijakan ditentukan oleh skema XML (.xsd). Sebagai referensi, skema kebijakan tersedia di GitHub.

Topik terkait

• Kebijakan kuota: Kuota kebijakan, untuk membatasi traffic pada masing-masing klien
• Pembatasan kapasitas untuk pembatasan kapasitas ringkasan
• Membandingkan Kebijakan Kuota dan SpikeArrest
• Contoh proxy API yang berfungsi