Kebijakan SpikeArrest

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Lihat dokumentasi Apigee Edge.

Kebijakan SpikeArrest melindungi dari lonjakan traffic dengan elemen <Rate>. Elemen ini membatasi jumlah permintaan yang diproses oleh proxy API dan dikirim ke backend, sehingga melindungi dari penurunan performa dan waktu nonaktif.

Kebijakan ini adalah kebijakan Standar dan dapat di-deploy ke jenis lingkungan apa pun. Untuk mengetahui informasi tentang jenis dan ketersediaan kebijakan dengan setiap jenis lingkungan, lihat Jenis kebijakan.

Perbedaan antara SpikeArrest dan Kuota

Kebijakan kuota mengonfigurasi jumlah pesan permintaan yang diizinkan untuk dikirimkan aplikasi klien ke API selama satu jam, hari, minggu, atau bulan. Kebijakan Kuota menerapkan batas konsumsi pada aplikasi klien dengan mempertahankan penghitung terdistribusi yang mencatat permintaan masuk.

Gunakan Kuota untuk menerapkan kontrak bisnis atau SLA dengan developer dan partner, bukan untuk pengelolaan traffic operasional. Gunakan SpikeArrest untuk melindungi dari lonjakan traffic API yang tiba-tiba. Lihat juga Membandingkan kebijakan Quota dan SpikeArrest.

Video

Video ini membahas kasus penggunaan untuk kebijakan ini:

Elemen <SpikeArrest>

Menentukan kebijakan SpikeArrest.

<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>false</UseEffectiveCount>
</SpikeArrest>

Elemen ini memiliki atribut berikut yang umum untuk semua kebijakan:

Contoh

Contoh berikut menunjukkan beberapa cara Anda dapat menggunakan kebijakan SpikeArrest:

<SpikeArrest name="SA-Static-5ps">
  <Rate>5ps</Rate>
  <UseEffectiveCount>false</UseEffectiveCount>
</SpikeArrest>

<SpikeArrest name="SA-Static-12pm">
  <Rate>12pm</Rate>
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

<SpikeArrest name="SA-With-Dynamic-Weight-1">
  <Rate>12pm</Rate>
  <Identifier ref="client_id" />
  <MessageWeight ref="request_specific_weight" />
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

<SpikeArrest name="SA-From-Inbound-Header-1">
  <Rate ref="request.header.runtime_rate" />
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

curl https://my-api-endpoint.net/price -H 'runtime_rate:30ps'

Referensi elemen turunan

Bagian ini menjelaskan elemen turunan <SpikeArrest>.

<DisplayName>

Gunakan selain atribut name untuk memberi label pada kebijakan di editor proxy UI pengelolaan dengan nama yang berbeda dan lebih terdengar alami.

Elemen <DisplayName> umum untuk semua kebijakan.

Elemen <DisplayName> menggunakan sintaksis berikut:

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

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

Elemen <DisplayName> tidak memiliki atribut atau elemen turunan.

<Identifier>

Memungkinkan Anda memilih cara mengelompokkan permintaan sehingga kebijakan SpikeArrest dapat diterapkan berdasarkan sesuatu dalam permintaan masuk. Misalnya, Anda dapat menerapkan batas frekuensi menurut ID developer, dalam hal ini semua permintaan yang dikirim oleh aplikasi yang dimiliki oleh developer tertentu akan berbagi satu jumlah SpikeArrest. Atau, Anda dapat menerapkan batas frekuensi berdasarkan ID klien, yang dalam hal ini setiap aplikasi klien akan tunduk pada penghitung batas frekuensi yang berbeda. Anda juga dapat merujuk ke variabel yang sebelumnya telah ditetapkan oleh proxy Anda. Variabel tersebut dapat menggabungkan beberapa faktor, misalnya, ID klien dan alamat IP klien.

Gunakan bersama dengan elemen <MessageWeight> untuk kontrol yang lebih mendetail atas pembatasan permintaan.

Jika Anda mengosongkan elemen <Identifier>, satu batas frekuensi 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/>
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

Tabel berikut menjelaskan atribut <Identifier>:

Elemen ini juga dibahas dalam postingan Komunitas Apigee ini.

<MessageWeight>

Menentukan bobot yang ditentukan untuk pesan saat ini. Bobot pesan mengubah dampak satu permintaan pada penghitungan laju SpikeArrest. Bobot pesan dapat berupa variabel alur apa pun, seperti header HTTP, parameter kueri, parameter formulir, atau konten isi pesan. Namun, biasanya Anda tidak akan menggunakan variabel yang berasal langsung dari permintaan masuk. Sebagai gantinya, Anda akan menggunakan variabel yang merepresentasikan atribut kustom pada produk API, atau pada aplikasi klien. Anda juga dapat menggunakan variabel kustom yang ditetapkan dengan nilai dinamis melalui kebijakan JavaScript atau kebijakan AssignMessage. Dalam semua kasus, nilai harus berupa bilangan bulat positif bukan nol.

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

Misalnya, jika SpikeArrest <Rate> adalah 10pm, dan proxy menggunakan variabel yang menyimpan nilai 2 untuk bobot pesan, maka hanya 5 pesan per menit yang akan diizinkan untuk ID tertentu karena setiap permintaan dihitung sebagai 2.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <MessageWeight ref="flow_variable"/>
</SpikeArrest>

<SpikeArrest name="SA-With-Dynamic-Weight-1">
  <Rate>12pm</Rate>
  <Identifier ref="client_id" />
  <MessageWeight ref="request_specific_weight" />
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

<SpikeArrest name="SA-Default-Weight-1">
  <Rate>1000pm</Rate>
  <Identifier ref="client_id" />
  <!-- omit <MessageWeight/> to use a default weight of 1 -->
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

Tabel berikut menjelaskan atribut <MessageWeight>:

<Rate>

Menentukan kecepatan untuk membatasi lonjakan (atau burst) traffic dengan menetapkan jumlah permintaan yang diizinkan dalam interval per menit atau per detik. Anda dapat menggunakan elemen ini bersama dengan <Identifier> dan <MessageWeight> untuk membatasi traffic dengan lancar saat runtime dengan kontrol yang akurat. Gunakan elemen <UseEffectiveCount> untuk menetapkan algoritma pembatasan frekuensi yang digunakan oleh kebijakan.

Lihat bagian SpikeArrest di halaman Batas untuk mengetahui batas frekuensi maksimum yang dapat Anda tentukan.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <Rate ref="flow_variable">rate[pm|ps]</Rate>
</SpikeArrest>

<SpikeArrest name="SA-Static-5ps">
  <Rate>5ps</Rate>
  <UseEffectiveCount>false</UseEffectiveCount>
</SpikeArrest>

<SpikeArrest name="SA-Static-12pm">
  <Rate>12pm</Rate>
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

Tabel berikut menjelaskan atribut <Rate>:

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

<UseEffectiveCount>

Elemen ini memungkinkan Anda memilih di antara algoritma peredaman lonjakan yang berbeda dengan menyetel nilai ke true atau false, seperti yang dijelaskan di bawah:

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</Rate>
  <Identifier ref="client_id" />
  <MessageWeight ref="request.header.weight" />
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

Tabel berikut menjelaskan atribut elemen <UseEffectiveCount>:

Variabel alur

Saat kebijakan SpikeArrest dijalankan, variabel alur berikut akan diisi:

Untuk mengetahui informasi selengkapnya, lihat Referensi variabel alur.

Referensi error

Bagian ini menjelaskan kode error dan pesan error yang ditampilkan serta variabel error yang ditetapkan oleh Apigee saat kebijakan ini memicu error. Informasi ini penting untuk diketahui jika Anda mengembangkan aturan error untuk menangani error. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani error.

Error runtime

Error ini dapat terjadi saat kebijakan dijalankan.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Variabel error

Variabel ini ditetapkan saat error runtime terjadi. Untuk mengetahui informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Contoh respons error

Berikut adalah contoh respons error:

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

Contoh aturan error

Berikut adalah contoh aturan error untuk menangani error 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>

Kode status HTTP saat ini untuk melampaui batas frekuensi yang ditetapkan oleh kebijakan Quota atau SpikeArrest adalah 429 (Terlalu Banyak Permintaan).

Skema

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

Topik terkait

• Kebijakan kuota: Kebijakan kuota, untuk membatasi traffic pada setiap klien
• Pembatasan kapasitas untuk ringkasan pembatasan kapasitas
• Membandingkan kebijakan Quota dan SpikeArrest