Chính sách của SpikeArrest

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X. info

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

Phần tử <SpikeArrest>

Xác định chính sách Chặn độ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 minh hoạ một số cách bạn có thể sử dụng chính sách Chố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'

Tài liệu tham khảo về 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.

<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ống đột biến dựa trên máy khách. 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ệ Ngăn chặn đột biến của riêng họ chứ không phải tất cả các yêu cầu đến proxy.

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

Nếu bạn để trống phần tử <Identifier>, thì một hạn mức tốc độ sẽ được thực thi 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 từng thông báo. Trọng số thông báo 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 toán tỷ lệ Chặn đột biến. Trọng số 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 thông báo. Bạn cũng có thể sử dụng các biến tuỳ chỉnh bằng chính sách JavaScript hoặc chính sách AssignMessage.

Sử dụng cùng với <Identifier> để điều chỉnh thêm các yêu cầu theo ứng dụng hoặc máy khách cụ thể.

Ví dụ: nếu Spike Arrest <Rate> là 10pm và một ứng dụng gửi các yêu cầu có trọng số là 2, thì chỉ được phép gửi 5 thông báo mỗi phút từ ứng dụng đó 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 các đợt tăng đột biến lưu lượng truy cập bằng cách đặt số lượng yêu cầu được phép trong khoảng thời gian 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 mượt mà 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 Spike Arrest trên các Trình xử lý thông báo (MP) khi sử dụng các nhóm có tính năng 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 bạn bỏ qua phần tử này trong chính sách Chặn đột biến.

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

Tác dụng của <UseEffectiveCount> phụ thuộc vào giá trị của nó:

• true: Giới hạn tốc độ tăng đột biến của 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ă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ẽ vẫn giữ nguyên.
• false: Giới hạn tốc độ tăng đột biến của mỗi MP chỉ đơn giản là giá trị của <Rate>. Giới hạn tổng hợp là tổng của tỷ lệ tất cả các MP. Khi các MP được thêm (hoặc xoá), giới hạn tốc độ tăng đột biến riêng lẻ của chúng sẽ vẫn giữ nguyên, nhưng giới hạn tổng hợp sẽ tăng (hoặc giảm).

Chính sách SpikeArrest sử dụng thuật toán "thùng mã thông báo" giúp làm mượt các đột biến lưu lượng truy cập bằng cách chia giới hạn tốc độ mà bạn chỉ định thành các khoảng thời gian nhỏ hơn. Một hạn chế của phương pháp này là nhiều yêu cầu hợp lệ đến trong một khoảng thời gian ngắn có thể bị từ chối.

Ví dụ: giả sử bạn nhập tốc độ là 30pm (30 yêu cầu mỗi phút). Trong quá trình kiểm thử, bạn có thể nghĩ rằng mình có thể gửi 30 yêu cầu trong 1 giây, miễn là các yêu cầu đó được gửi trong vòng 1 phút. Nhưng chính sách không thực thi chế độ cài đặt theo cách đó. Nếu bạn nghĩ về điều này, 30 yêu cầu trong khoảng thời gian 1 giây có thể được coi là một mức tăng đột biến nhỏ trong một số môi trường.

• Tốc độ mỗi phút được làm mượt thành số yêu cầu đầy đủ được phép trong khoảng thời gian giây.
  

  Ví dụ: 30pm được làm mượt như sau:
  60 giây (1 phút) / 30pm = khoảng thời gian 2 giây hoặc 1 yêu cầu được phép cứ sau 2 giây. Yêu cầu thứ hai trong vòng 2 giây sẽ không thành công. Ngoài ra, yêu cầu thứ 31 trong vòng một phút sẽ không thành công.

• Tốc độ mỗi giây được làm mượt thành các yêu cầu đầy đủ được phép trong khoảng thời gian mili giây.

  Ví dụ: 10ps được làm mượt như sau:
  1000 mili giây (1 giây) / 10ps = khoảng thời gian 100 mili giây hoặc 1 yêu cầu được phép thực hiện sau mỗi 100 mili giây. Yêu cầu thứ hai trong vòng 100 mili giây sẽ không thành công. Ngoài ra, yêu cầu thứ 11 trong vòng một giây sẽ không thành công.

Bảng sau đây cho biết ảnh hưởng của <UseEffectiveCount> đến giới hạn tốc độ hiệu quả của từng 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, thì tỷ lệ hiệu quả trên mỗi MP vẫn giữ nguyên (ở mức 10). Nhưng 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 luồng

Khi chính sách Ngăn chặn đột biến thực thi, biến luồng sau đây sẽ được điền sẵn:

Để biết thêm thông tin, hãy xem phần Tài liệu tham khảo về các biến trong luồng.

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 khi vượt quá hạn mức do chính sách Hạn mức hoặc Chặn đột biến đặt ra 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 của 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 về hạn mức: Chính sách về hạn mức nhằm giới hạn lưu lượng truy cập trên từng ứng dụng khách
• Giới hạn tốc độ để biết thông tin tổng quan về giới hạn tốc độ
• So sánh chính sách về hạn mức và SpikeArrest
• Các mẫu hoạt động của proxy API