นโยบาย 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 เมื่อไม่ได้ระบุองค์ประกอบในนโยบาย Spike Arrest

ตารางต่อไปนี้จะอธิบายแอตทริบิวต์ขององค์ประกอบ <UseEffectiveCount>

ผลของ <UseEffectiveCount> จะขึ้นอยู่กับค่าของตัวแปรดังกล่าว ดังนี้

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

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

เช่น สมมติว่าคุณป้อนอัตรา 30pm (คำขอ 30 รายการต่อนาที) ในการทดสอบ คุณอาจคิดว่าส่งคำขอ 30 รายการได้ใน 1 วินาที ตราบใดที่คำขอเหล่านั้นส่งภายใน 1 นาที แต่ไม่ใช่ วิธีที่นโยบายบังคับใช้การตั้งค่า หากลองพิจารณาดูแล้ว คำขอ 30 รายการภายในระยะเวลา 1 วินาที อาจถือเป็นช่วงที่มีการใช้งานสูงเล็กๆ ในบางสภาพแวดล้อม

• อัตราต่อนาทีจะได้รับการปรับให้เป็นคำขอแบบเต็มที่อนุญาตในช่วงเวลา วินาที
  

  เช่น 30pm จะได้รับการปรับให้ราบรื่นดังนี้
  60 วินาที (1 นาที) / 30pm = ช่วงเวลา 2 วินาที หรืออนุญาตให้ส่งคำขอ 1 รายการทุกๆ 2 วินาที คำขอที่ 2 ภายใน 2 วินาทีจะล้มเหลว นอกจากนี้ คำขอที่ 31 ภายใน 1 นาทีจะ ล้มเหลว

• อัตราต่อวินาทีจะได้รับการปรับให้เป็นคำขอแบบเต็มที่อนุญาตในช่วงเวลา มิลลิวินาที

  เช่น 10ps จะได้รับการปรับให้ราบรื่นดังนี้
  1,000 มิลลิวินาที (1 วินาที) / 10ps = ช่วงเวลา 100 มิลลิวินาที หรืออนุญาตคำขอ 1 รายการทุกๆ 100 มิลลิวินาที คำขอที่ 2 ที่ส่งภายใน 100 มิลลิวินาทีจะล้มเหลว นอกจากนี้ คำขอที่ 11 ภายใน 1 วินาที จะดำเนินการไม่สำเร็จ

ตารางต่อไปนี้แสดงผลของ <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 ที่ใช้งานได้