นโยบาย SpikeArrest

คุณกําลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info

นโยบายการหยุดการเพิ่มขึ้นอย่างฉับพลันจะป้องกันการเข้าชมที่เพิ่มขึ้นอย่างฉับพลันด้วยองค์ประกอบ <Rate> องค์ประกอบนี้จะจำกัดจำนวนคำขอที่พร็อกซี API ประมวลผลและส่งไปยังแบ็กเอนด์ เพื่อป้องกันการหน่วงเวลาของประสิทธิภาพและการหยุดทำงาน

องค์ประกอบ <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 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'

การอ้างอิงองค์ประกอบย่อย

ส่วนนี้จะอธิบายองค์ประกอบย่อยของ <SpikeArrest>

<DisplayName>

ใช้ร่วมกับแอตทริบิวต์ name เพื่อติดป้ายกำกับนโยบายในเครื่องมือแก้ไขพร็อกซี UI การจัดการโดยใช้ชื่ออื่นที่ฟังดูเป็นธรรมชาติมากกว่า

องค์ประกอบ <DisplayName> เป็นองค์ประกอบที่ใช้ร่วมกันในทุกนโยบาย

องค์ประกอบ <DisplayName> ใช้ไวยากรณ์ต่อไปนี้

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

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

องค์ประกอบ <DisplayName> ไม่มีแอตทริบิวต์หรือองค์ประกอบย่อย

<Identifier>

ให้คุณเลือกวิธีจัดกลุ่มคำขอเพื่อให้ใช้นโยบายการหยุดการเพิ่มขึ้นอย่างฉับพลันตามไคลเอ็นต์ได้ เช่น คุณสามารถจัดกลุ่มคำขอตามรหัสนักพัฒนาแอปได้ ซึ่งในกรณีนี้ คำขอของนักพัฒนาแอปแต่ละรายจะนับรวมในอัตราการหยุดการเพิ่มขึ้นอย่างฉับพลันของตนเอง ไม่ใช่คำขอทั้งหมดที่ส่งไปยังพร็อกซี

ใช้ร่วมกับองค์ประกอบ <MessageWeight> เพื่อควบคุมการจำกัดคำขออย่างละเอียดยิ่งขึ้น

หากคุณปล่อยองค์ประกอบ <Identifier> ว่างไว้ ระบบจะใช้ขีดจํากัดอัตรา 1 รายการสําหรับคําขอทั้งหมดที่ส่งไปยังพร็อกซี API นั้น

<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 ระบบจะอนุญาตให้มีข้อความจากไคลเอ็นต์ดังกล่าวเพียง 5 ข้อความต่อนาที เนื่องจากคำขอแต่ละรายการนับเป็น 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 async="false" continueOnError="false" enabled="true" name="SpikeArreast">
  <DisplayName>SpikeArreast</DisplayName>
  <Rate>300pm</Rate>
</SpikeArrest>

ตารางต่อไปนี้อธิบายแอตทริบิวต์ของ <Rate>

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

<UseEffectiveCount>

กระจายจํานวนการหยุดการเพิ่มขึ้นของข้อความไปยังโปรแกรมประมวลผลข้อความ (MP) เมื่อใช้กลุ่มการปรับขนาดอัตโนมัติ

<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> จะขึ้นอยู่กับค่าของ <UseEffectiveCount> ดังนี้

• true: ขีดจํากัดอัตราเพิ่มขึ้นของ MP คือ <Rate> หารด้วยจํานวน MP ปัจจุบันในพ็อดเดียวกัน ขีดจํากัดรวมคือค่าของ <Rate> เมื่อเพิ่ม (หรือนําออก) MP แบบไดนามิก ขีดจํากัดอัตราที่เพิ่มขึ้นแต่ละรายการจะเพิ่มขึ้น (หรือลดลง) แต่ขีดจํากัดรวมจะยังคงเหมือนเดิม
• false (นี่คือค่าเริ่มต้นหากไม่ระบุ): ขีดจํากัดอัตราการเพิ่มขึ้นของ MP แต่ละรายการเป็นเพียงค่าของ <Rate> ขีดจํากัดรวมคือผลรวมของอัตราของ MP ทั้งหมด เมื่อเพิ่ม (หรือนําออก) MP ขีดจํากัดอัตราการเพิ่มขึ้นแต่ละรายการจะยังคงเหมือนเดิม แต่ขีดจํากัดรวมจะเพิ่มขึ้น (หรือลดลง)

ตารางต่อไปนี้แสดงผลของ <UseEffectiveCount> ต่อขีดจำกัดอัตราที่มีประสิทธิภาพของ MP แต่ละรายการ

ในตัวอย่างนี้ โปรดสังเกตว่าเมื่อจํานวน MP ลดลงจาก 4 เป็น 2 และ <UseEffectiveCount> คือ false อัตราที่มีประสิทธิภาพต่อ MP จะยังคงเดิม (ที่ 10) แต่เมื่อ <UseEffectiveCount> เป็น true อัตราที่มีประสิทธิภาพต่อ MP จะลดลงจาก 10 เป็น 20 เมื่อจำนวน MP ลดลงจาก 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 โดยใช้ API อัปเดตพร็อพเพอร์ตี้องค์กร

เช่น

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
• ตัวอย่างพร็อกซี API ที่ใช้งานได้