Chính sách của SpikeArrest

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X. thông tin

Chính sách Ngăn chặn sự gia tăng đột biến giúp bảo vệ khỏi sự gia tăng đột biến về lưu lượng truy cập bằng phần tử <Rate>. Phần tử này điều tiết số lượng yêu cầu do proxy API xử lý và gửi đến phần phụ trợ, giúp ngăn chặn tình trạng hiệu suất bị trễ và thời gian ngừng hoạt động.

Phần tử <SpikeArrest>

Xác định chính sách Ngăn chặn sự kiện tăng đột biến.

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

Phần tử này có các thuộc tính chung cho tất cả các chính sách:

Ví dụ

Các ví dụ sau đây cho thấy một số cách bạn có thể sử dụng chính sách Chặn sự kiện tăng đột biến:

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

Tham chiếu phần tử con

Phần này mô tả các phần tử con của <SpikeArrest>.

<DisplayName>

Sử dụng cùng với thuộc tính name để gắn nhãn chính sách trong trình chỉnh sửa proxy giao diện người dùng quản lý bằng một tên khác, nghe tự nhiên hơn.

Phần tử <DisplayName> là phần tử chung cho tất cả các chính sách.

Phần tử <DisplayName> sử dụng cú pháp sau:

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

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

Phần tử <DisplayName> không có thuộc tính hoặc phần tử con nào.

<Identifier>

Cho phép bạn chọn cách nhóm các yêu cầu để có thể áp dụng chính sách Chặn sự kiện tăng đột biến dựa trên ứng dụng. Ví dụ: bạn có thể nhóm các yêu cầu theo mã nhận dạng nhà phát triển. Trong trường hợp này, mỗi yêu cầu của nhà phát triển sẽ được tính vào tỷ lệ chặn sự kiện tăng đột biến của riêng họ chứ không phải tất cả yêu cầu đến proxy.

Sử dụng kết hợp với phần tử <MessageWeight> để kiểm soát chặt chẽ hơn việc điều tiết yêu cầu.

Nếu bạn để trống phần tử <Identifier>, hệ thống sẽ thực thi một giới hạn tốc độ cho tất cả các yêu cầu vào proxy 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>

Bảng sau đây mô tả các thuộc tính của <Identifier>:

Phần tử này cũng được thảo luận trong bài đăng sau đây trên Cộng đồng Apigee: http://community.apigee.com/questions/2807/how-does-the-edge-quota-policy-work-when-no-identi.html.

<MessageWeight>

Chỉ định trọng số được xác định cho mỗi thông báo. Tỷ lệ trọng số của thông báo sẽ sửa đổi mức tác động của một yêu cầu duy nhất đối với việc tính tỷ lệ chặn sự kiện tăng đột biến. Trọng số của thông báo có thể là bất kỳ biến luồng nào, chẳng hạn như tiêu đề HTTP, tham số truy vấn, tham số biểu mẫu hoặc nội dung nội dung thông báo. Bạn cũng có thể sử dụng biến tuỳ chỉnh bằng chính sách JavaScript hoặc chính sách AssignMessage.

Sử dụng kết hợp với <Identifier> để điều tiết thêm các yêu cầu theo ứng dụng hoặc ứng dụng cụ thể.

Ví dụ: nếu <Rate> của tính năng Ngăn chặn sự kiện tăng đột biến là 10pm và một ứng dụng gửi các yêu cầu có trọng số là 2, thì ứng dụng đó chỉ được phép gửi 5 thông báo mỗi phút vì mỗi yêu cầu được tính là 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>

Bảng sau đây mô tả các thuộc tính của <MessageWeight>:

<Rate>

Chỉ định tốc độ giới hạn mức tăng đột biến (hoặc sự kiện tăng đột biến) về lưu lượng truy cập bằng cách đặt số lượng yêu cầu được phép trong mỗi phút hoặc mỗi giây. Bạn cũng có thể sử dụng phần tử này cùng với <Identifier> và <MessageWeight> để điều tiết lưu lượng truy cập một cách trơn tru trong thời gian chạy bằng cách chấp nhận các giá trị từ ứng dụng.

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

Bảng sau đây mô tả các thuộc tính của <Rate>:

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

<UseEffectiveCount>

Phân phối số lượng lượt chặn đột biến trên các Trình xử lý thông báo (MP) khi sử dụng các nhóm tự động mở rộng quy mô.

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

Phần tử <UseEffectiveCount> là phần tử không bắt buộc. Giá trị mặc định là false khi phần tử bị bỏ qua khỏi chính sách Chống sự kiện tăng đột biến.

Bảng sau đây mô tả các thuộc tính của phần tử <UseEffectiveCount>:

Hiệu ứng của <UseEffectiveCount> phụ thuộc vào giá trị của thuộc tính này:

• true: Giới hạn tốc độ tăng đột biến của một MP là <Rate> chia cho số lượng MP hiện tại trong cùng một nhóm. Giới hạn tổng hợp là giá trị của <Rate>. Khi các MP được thêm (hoặc xoá) một cách linh động, hạn mức tốc độ tăng đột biến riêng lẻ của chúng sẽ tăng (hoặc giảm), nhưng hạn mức tổng hợp sẽ giữ nguyên.
• false (đây là giá trị mặc định nếu bạn bỏ qua): Giới hạn tốc độ tăng đột biến của mỗi MP chỉ là giá trị của <Rate>. Giới hạn tổng hợp là tổng tỷ lệ của tất cả các MP. Khi bạn thêm (hoặc xoá) MP, giới hạn tốc độ tăng đột biến riêng lẻ của các MP đó sẽ giữ nguyên, nhưng giới hạn tổng hợp sẽ tăng (hoặc giảm).

Bảng sau đây cho thấy ảnh hưởng của <UseEffectiveCount> đối với giới hạn tốc độ hiệu quả của mỗi MP:

Trong ví dụ này, hãy lưu ý rằng khi số lượng MP giảm từ 4 xuống 2 và <UseEffectiveCount> là false, tỷ lệ hiệu quả trên mỗi MP vẫn giữ nguyên (ở mức 10). Tuy nhiên, khi <UseEffectiveCount> là true, tỷ lệ hiệu quả trên mỗi MP sẽ tăng từ 10 lên 20 khi số lượng MP giảm từ 4 xuống 2.

Biến flow

Khi chính sách Chặn sự kiện tăng đột biến thực thi, biến flow sau đây sẽ được điền:

Để biết thêm thông tin, hãy xem phần Tham khảo về biến Flow.

Tham chiếu lỗi

Phần này mô tả các mã lỗi và thông báo lỗi được trả về cũng như các biến lỗi do Edge đặt khi chính sách này kích hoạt lỗi. Thông tin này rất quan trọng nếu bạn đang phát triển các quy tắc lỗi để xử lý lỗi. Để tìm hiểu thêm, hãy xem Những điều bạn cần biết về lỗi chính sách và Xử lý lỗi.

Lỗi thời gian chạy

Những lỗi này có thể xảy ra khi chính sách này thực thi.

Lỗi triển khai

Những lỗi này có thể xảy ra khi bạn triển khai proxy có chứa chính sách này.

Biến lỗi

Các biến này được đặt khi xảy ra lỗi thời gian chạy. Để biết thêm thông tin, hãy xem bài viết Những điều bạn cần biết về lỗi chính sách.

Ví dụ về phản hồi khi gặp lỗi

Dưới đây là ví dụ về phản hồi lỗi:

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

Ví dụ về quy tắc lỗi

Dưới đây là ví dụ về quy tắc lỗi để xử lý lỗi 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>

Mã trạng thái HTTP hiện tại cho việc vượt quá giới hạn tốc độ do chính sách Hạn mức hoặc Chặn đột biến đặt là 429 (Quá nhiều yêu cầu). Để thay đổi mã trạng thái HTTP thành 500 (Lỗi máy chủ nội bộ), hãy đặt thuộc tính features.isHTTPStatusTooManyRequestEnabled thành false bằng API Cập nhật thuộc tính tổ chức.

Ví dụ:

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

Giản đồ

Mỗi loại chính sách được xác định bằng một lược đồ XML (.xsd). Để tham khảo, bạn có thể xem lược đồ chính sách trên GitHub.

Chủ đề có liên quan

• Chính sách hạn mức: Chính sách hạn mức để giới hạn lưu lượng truy cập trên từng ứng dụng
• Giới hạn tốc độ để xem thông tin tổng quan về giới hạn tốc độ
• So sánh chính sách Hạn mức và SpikeArrest
• Mẫu hoạt động của proxy API