Kebijakan SpikeArrest

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

Kebijakan Spike Arrest 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 periode nonaktif.

Elemen <SpikeArrest>

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

Elemen ini memiliki atribut berikut yang sama untuk semua kebijakan:

Contoh

Contoh berikut menunjukkan beberapa cara penggunaan kebijakan Spike Arrest:

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

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 terdengar lebih 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 Pembatasan Lonjakan dapat diterapkan berdasarkan klien. Misalnya, Anda dapat mengelompokkan permintaan berdasarkan ID developer, yang dalam hal ini setiap permintaan developer akan dihitung berdasarkan rasio Spike Arrest-nya sendiri, bukan semua permintaan ke proxy.

Gunakan bersama dengan elemen <MessageWeight> untuk kontrol yang lebih mendetail terhadap 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/>
</SpikeArrest>

Tabel berikut menjelaskan atribut <Identifier>:

Elemen ini juga dibahas dalam postingan Komunitas Apigee berikut: Quota Identifier Across Different Policies.

<MessageWeight>

Menentukan pembobotan yang ditentukan untuk setiap pesan. Bobot pesan mengubah dampak satu permintaan pada penghitungan tingkat Pembatasan Lonjakan. Bobot pesan dapat berupa variabel alur apa pun, seperti header HTTP, parameter kueri, parameter formulir, atau konten isi pesan. Anda juga dapat menggunakan variabel kustom menggunakan kebijakan JavaScript atau kebijakan AssignMessage.

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

Misalnya, jika Pembatasan Lonjakan <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 kecepatan untuk membatasi lonjakan (atau burst) traffic dengan menetapkan jumlah permintaan yang diizinkan dalam interval per menit atau per detik. Anda juga dapat menggunakan elemen ini bersama dengan <Identifier> dan <MessageWeight> untuk membatasi traffic dengan 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 async="false" continueOnError="false" enabled="true" name="SpikeArreast">
  <DisplayName>SpikeArreast</DisplayName>
  <Rate>300pm</Rate>
</SpikeArrest>

Tabel berikut menjelaskan atribut <Rate>:

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

<UseEffectiveCount>

Mendistribusikan jumlah Spike Arrest di seluruh Pemroses Pesan (MP) saat menggunakan grup penskalaan otomatis.

<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 tidak disertakan dalam kebijakan Pembatasan Lonjakan.

Tabel berikut menjelaskan atribut elemen <UseEffectiveCount>:

Efek <UseEffectiveCount> bergantung pada nilainya:

• true: Batas laju lonjakan MP adalah <Rate> dibagi dengan jumlah MP saat ini dalam pod yang sama. Batas gabungan adalah nilai <Rate>. Saat MP ditambahkan (atau dihapus) secara dinamis, batas laju lonjakan masing-masing akan meningkat (atau menurun), tetapi batas gabungan akan tetap sama.
• false: Batas laju lonjakan setiap MP hanyalah nilai <Rate>-nya. Batas gabungan adalah jumlah tarif semua MP. Saat MP ditambahkan (atau dihapus), batas laju lonjakan masing-masing akan tetap sama, tetapi batas gabungan akan meningkat (atau berkurang).

Kebijakan SpikeArrest menggunakan algoritma "token bucket" yang memperlancar lonjakan traffic dengan membagi batas kapasitas yang Anda tentukan ke dalam interval yang lebih kecil. Kelemahan pendekatan ini adalah beberapa permintaan yang sah yang masuk dalam interval waktu singkat berpotensi ditolak.

Misalnya, Anda memasukkan kecepatan 30pm (30 permintaan per menit). Saat pengujian, Anda mungkin berpikir Anda dapat mengirim 30 permintaan dalam 1 detik, selama permintaan tersebut masuk dalam satu menit. Namun, bukan begitu cara kebijakan menerapkan setelan. Jika dipikir-pikir, 30 permintaan dalam periode 1 detik dapat dianggap sebagai lonjakan kecil di beberapa lingkungan.

• Rasio per menit akan disesuaikan menjadi permintaan penuh yang diizinkan dalam interval detik.
  

  Misalnya, 30 pm akan di-smoothing seperti ini:
  60 detik (1 menit) / 30 pm = interval 2 detik, atau 1 permintaan diizinkan setiap 2 detik. Permintaan kedua dalam waktu 2 detik akan gagal. Selain itu, permintaan ke-31 dalam satu menit akan gagal.

• Kecepatan per detik dihaluskan menjadi permintaan penuh yang diizinkan dalam interval milidetik.

  Misalnya, 10ps di-smoothing seperti ini:
  1.000 milidetik (1 detik) / 10ps = interval 100 milidetik, atau 1 permintaan diizinkan setiap 100 milidetik. Permintaan kedua dalam waktu 100 md akan gagal. Selain itu, permintaan ke-11 dalam satu detik akan gagal.

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

Dalam contoh ini, perhatikan bahwa saat jumlah MP dikurangi dari 4 menjadi 2, dan <UseEffectiveCount> adalah false, rasio efektif per MP tetap sama (di 10). Namun, jika <UseEffectiveCount> adalah true, rasio efektif per MP akan berubah dari 10 menjadi 20 saat jumlah MP dikurangi dari 4 menjadi 2.

Variabel alur

Saat kebijakan Pembatasan Lonjakan dieksekusi, variabel alur berikut akan diisi:

Untuk mengetahui informasi selengkapnya, lihat Referensi variabel alur.

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 untuk melampaui batas frekuensi yang ditetapkan oleh kebijakan Quota atau Spike Arrest adalah 429 (Terlalu Banyak Permintaan). Untuk mengubah kode status HTTP menjadi 500 (Error Server Internal), tetapkan properti features.isHTTPStatusTooManyRequestEnabled ke false menggunakan API Update organization properties.

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: Kebijakan kuota, untuk membatasi traffic pada setiap klien
• Pembatasan kapasitas untuk ringkasan pembatasan kapasitas
• Membandingkan Kebijakan Kuota dan SpikeArrest
• Contoh proxy API yang berfungsi