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 men-throttle jumlah permintaan yang diproses oleh proxy API dan dikirim ke backend, guna melindungi dari kelambatan performa dan periode nonaktif.

Elemen <SpikeArrest>

Menentukan kebijakan Penahanan Spike.

<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 untuk menggunakan kebijakan Penangkapan Spike:

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

<DisplayName>

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

Elemen <DisplayName> bersifat 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 Penangkapan Spike dapat diterapkan berdasarkan klien. Misalnya, Anda dapat mengelompokkan permintaan berdasarkan ID developer, yang dalam hal ini permintaan setiap developer akan diperhitungkan dalam rasio Penangkapan Lonjakan mereka sendiri, dan bukan semua permintaan ke proxy.

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

Jika Anda membiarkan elemen <Identifier> kosong, satu batas kapasitas akan diterapkan untuk semua permintaan yang masuk 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 dampak satu permintaan pada penghitungan tingkat Penangkapan Spike. 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 kebijakanAssignMessage.

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

Misalnya, jika lonjakan <Rate> adalah 10pm, dan aplikasi mengirimkan permintaan dengan bobot 2, 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 tingkat pembatasan lonjakan (atau burst) traffic dengan menetapkan jumlah permintaan yang diizinkan dalam interval per menit atau per detik. Anda juga dapat menggunakan elemen ini bersamaan dengan <Identifier> dan <MessageWeight> untuk membatasi traffic dengan lancar pada 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 Spike Arrest Anda di seluruh Message Processors (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 dihilangkan dari kebijakan Spike Arrest Anda.

Tabel berikut menjelaskan atribut elemen <UseEffectiveCount>:

Efek <UseEffectiveCount> bergantung pada nilainya:

• true: Batas kecepatan lonjakan MP adalah <Rate> dibagi jumlah MP saat ini dalam pod yang sama. Batas agregat adalah nilai <Rate>. Saat MP ditambahkan (atau dihapus) secara dinamis, batas kapasitas lonjakan individual akan meningkat (atau menurun), tetapi batas agregat akan tetap sama.
• false (ini adalah nilai default jika dihilangkan): Setiap batas kapasitas lonjakan MP hanyalah nilai <Rate>-nya. Batas agregat adalah jumlah tarif semua MP. Saat MP ditambahkan (atau dihapus), batas kapasitas lonjakan individualnya akan tetap sama, tetapi batas gabungannya akan meningkat (atau menurun).

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

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

Variabel alur

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

Untuk informasi selengkapnya, lihat Referensi variabel flow.

Referensi error

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

Error runtime

Error ini dapat terjadi saat kebijakan dieksekusi.

Error saat deployment

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

Variabel kesalahan

Variabel ini ditetapkan saat terjadi error runtime. Untuk 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 kesalahan

Berikut adalah contoh aturan kesalahan untuk menangani kesalahan 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 melebihi batas kapasitas yang ditetapkan oleh kebijakan Kuota atau Penangkapan Lonjakan adalah 429 (Terlalu Banyak Permintaan). Untuk mengubah kode status HTTP menjadi 500 (Error Server Internal), tetapkan properti features.isHTTPStatusTooManyRequestEnabled ke false menggunakan API Perbarui 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: Kebijakan kuota, untuk membatasi traffic pada masing-masing klien
• Pembatasan kapasitas untuk ringkasan pembatasan kapasitas
• Membandingkan Kebijakan Kuota dan SpikeArrest
• Contoh proxy API yang berfungsi