سياسة SpikeArrest

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. المعلومات

توفر سياسة "منع الارتفاع" الحماية ضد الزيادات المفاجئة في عدد الزيارات باستخدام العنصر <Rate>. يحدّ هذا العنصر من عدد الطلبات التي يعالجها الخادم الوكيل لواجهة برمجة التطبيقات ويرسلها إلى خلفية معيّنة، ما يحمي من حالات التأخُّر في الأداء وفترة التوقف عن العمل.

عنصر <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>true</UseEffectiveCount>
</SpikeArrest>

يتضمن هذا العنصر السمات التالية الشائعة لجميع السياسات:

أمثلة

توضّح الأمثلة التالية بعض الطرق التي يمكنك من خلالها استخدام سياسة إيقاف الإنذار بسبب الارتفاع الكبير:

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

مرجع عنصر ثانوي

يصف هذا القسم العناصر الفرعية لـ <SpikeArrest>.

<DisplayName>

يمكنك استخدامها بالإضافة إلى السمة name لتصنيف السياسة في محرِّر الخادم الوكيل لواجهة المستخدم الخاصة بالإدارة، وذلك باستخدام اسم مختلف يبدو طبيعيًا.

العنصر <DisplayName> شائع لجميع السياسات.

يستخدم العنصر <DisplayName> البنية التالية:

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

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

لا يتضمّن العنصر <DisplayName> أيّ سمات أو عناصر فرعية.

<Identifier>

تتيح لك هذه الميزة اختيار كيفية تجميع الطلبات بحيث يمكن تطبيق سياسة إيقاف رصد الارتفاع استنادًا إلى العميل. على سبيل المثال، يمكنك تجميع الطلبات حسب رقم تعريف مطوّر البرامج، وفي هذه الحالة سيتم احتساب طلبات كل مطوّر برامج ضمن معدّل إيقاف ارتفاع الإشعارات لديه وليس جميع الطلبات المرسَلة إلى الخادم الوكيل.

استخدِم هذه السمة مع العنصر <MessageWeight> لمزيد من الدقة في التحكّم في تقييد الطلبات.

في حال ترك العنصر <Identifier> فارغًا، سيتم فرض حد سعر واحد لجميع الطلبات الواردة إلى الخادم الوكيل لواجهة برمجة التطبيقات هذا.

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

ويوضّح الجدول التالي سمات <Identifier>:

تتم مناقشة هذا العنصر أيضًا في مشاركة منتدى Apigee التالية: http://community.apigee.com/questions/2807/how-does-the-edge-quota-policy-work-when-no-identi.html.

<MessageWeight>

تُستخدَم لتحديد قيمة الترجيح المحددة لكل رسالة. ويعدِّل حجم الرسالة تأثير طلب واحد في حساب معدّل إيقاف رسائل الارتفاع. ويمكن أن يكون حجم الرسالة أي متغيّر للتدفق، مثل عنوان HTTP أو مَعلمة طلب البحث أو مَعلمة النموذج أو محتوى نص الرسالة. يمكنك أيضًا استخدام المتغيّرات المخصّصة باستخدام سياسة JavaScript أو سياسةAssignMessage.

يُستخدم هذا الإعداد مع <Identifier> للتحكّم بشكل أكبر في إمكانية معالجة الطلبات الواردة من برامج أو تطبيقات محدّدة.

على سبيل المثال، إذا كانت قيمة الحد الأقصى لإيقاف رصد الارتفاع <Rate> هي 10pm، وأرسل أحد التطبيقات طلبات بقيمة 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>

ويوضّح الجدول التالي سمات <MessageWeight>:

<Rate>

تحدّد هذه السمة المعدّل الذي يجب عنده الحدّ من حالات الزيادة في عدد الزيارات (أو الانفجارات) من خلال ضبط عدد الطلبات المسموح بها في الفواصل الزمنية لكل دقيقة أو في الثانية. يمكنك أيضًا استخدام هذا العنصر مع <Identifier> و<MessageWeight> لتقليل عدد الزيارات بسلاسة أثناء وقت التشغيل من خلال قبول قيم من العميل.

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

ويوضّح الجدول التالي سمات <Rate>:

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

<UseEffectiveCount>

يوزِّع عدد مرات منع الارتفاع على معالِجات الرسائل (MPs) عند استخدام مجموعات تغيير الحجم التلقائي.

<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> اختياري وتكون القيمة التلقائية هي false عندما يتم حذف العنصر من سياسة منع الارتفاع المفاجئ.

يوضّح الجدول التالي سمات العنصر <UseEffectiveCount>:

يعتمد تأثير <UseEffectiveCount> على قيمته:

• true: الحدّ الأقصى لمعدّل الارتفاع في الدقيقة هو <Rate> مقسومًا على العدد الحالي لوحدات البكسل في المجموعة نفسها. والحد الأقصى المجمَّع هو قيمة <Rate>. عند إضافة (أو إزالة) وحدات MP بشكل ديناميكي، ستزيد (أو تقل) الحدود الفردية لمعدّل الارتفاع، إلا أنّ الحدّ الأقصى الإجمالي لن يتغيّر.
• false (هذه هي القيمة التلقائية في حال حذفها): الحدّ الأقصى لمعدّل الارتفاع المُقدّر لكل ميغا بكسل هو قيمة <Rate>. والحد المجمّع هو مجموع أسعار جميع أعضاء البرلمان. عند إضافة (أو إزالة) أعضاء الفريق، ستظل حدود معدّل الارتفاع الفردي كما هي، ولكن سيزيد الحدّ المجمَّع (أو ينخفض).

يعرض الجدول التالي تأثير <UseEffectiveCount> على حد المعدّل الفعلي لكل ميغا بكسل:

في هذا المثال، لاحِظ أنّه عندما ينخفض عدد وحدات ميغابكسل من 4 إلى 2، و<UseEffectiveCount> بمعدّل false، يبقى المعدّل الفعلي لكل ميغا بكسل كما هو (عند 10). أما عندما تكون <UseEffectiveCount> ميغا بكسل true، يزيد المعدل الفعلي لكل ميغا بكسل من 10 إلى 20 عندما يقل عدد وحدات ميغا بكسل من 4 إلى 2.

متغيرات التدفق

عند تنفيذ سياسة منع الارتفاع، تتم تعبئة متغيّر التدفق التالي:

لمزيد من المعلومات، يُرجى الاطّلاع على مرجع متغيّرات التدفق.

مرجع الخطأ

يصف هذا القسم رموز الأخطاء ورسائل الخطأ التي يتم عرضها ومتغيّرات الأخطاء التي تضبطها Edge عندما تؤدي هذه السياسة إلى ظهور خطأ. هذه المعلومات مهمة لمعرفة ما إذا كنت تعمل على تطوير قواعد للأخطاء للتعامل معها. لمزيد من المعلومات، يمكنك الاطّلاع على المعلومات التي يجب معرفتها عن الأخطاء المتعلقة بالسياسات وأخطاء المعالجة.

أخطاء في وقت التشغيل

يمكن أن تحدث هذه الأخطاء عند تنفيذ السياسة.

أخطاء النشر

يمكن أن تحدث هذه الأخطاء عند نشر خادم وكيل يحتوي على هذه السياسة.

متغيرات الخطأ

ويتم ضبط هذه المتغيرات عند حدوث خطأ في وقت التشغيل. لمزيد من المعلومات، يمكنك الاطّلاع على المعلومات التي يجب معرفتها عن الأخطاء المتعلقة بالسياسات.

مثال على الردّ على الخطأ

في ما يلي مثال على استجابة الخطأ:

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

مثال لقاعدة خطأ

في ما يلي مثال على قاعدة خطأ للتعامل مع خطأ 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>

إنّ رمز حالة HTTP الحالي لتجاوز حدّ السعر الذي تم ضبطه من خلال سياسة الحصة أو الحد الأقصى المسموح به هو 429 (عدد كبير جدًا من الطلبات). لتغيير رمز حالة HTTP إلى 500 (خطأ داخلي في الخادم)، اضبط السمة features.isHTTPStatusTooManyRequestEnabled على false باستخدام واجهة برمجة التطبيقات لتعديل خصائص المؤسسة.

مثال:

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

المخططات

ويتم تحديد كل نوع من أنواع السياسات من خلال مخطّط XML (.xsd). وتتوفّر مخطّطات السياسات كمرجع على GitHub.

مواضيع ذات صلة

• سياسة الحصص: سياسة الحصص، لتقييد عدد الزيارات على العملاء الفرديين
• تحديد المُعدَّل للحصول على نظرة عامة حول تقييد المُعدَّل
• مقارنة سياسات الحصة وسياسة SpikeArrest
• نماذج عمل للخوادم الوكيلة لواجهة برمجة التطبيقات