跳到主要內容

Apache Camel - Throttler Hello World

Introduction

在設計web應用程式時，有時會需要一個節流器，去幫我控制單位時間內能處理的請求數量，以避免過載；又或者是要根據不同使用者所買的授權，去控制單位時間內能呼叫的API次數等。Camel提供了Throttler，讓我們能輕鬆透過設定，去達到這些效果。

我將透過HTTP GET請求/events/{id}做為範例，說明如何使用Throttler。首先介紹這個範例中的兩個RouteBuilder。

(程式碼可參考link)

RestRouteBuilder

REST核心設定集中在這個builder中，它負責宣告用什麼port與component去建立REST服務:

package org.tonylin.practice.camel.rest;
 
import org.apache.camel.builder.RouteBuilder;
import org.apache.camel.model.rest.RestBindingMode;
 
public class RestRouteBuilder extends RouteBuilder {	
 
	@Override
	public void configure() throws Exception {
		restConfiguration().component("netty4-http").port(8080).bindingMode(RestBindingMode.auto).endpointProperty("ssl",  "false");
	}
}

(我以http當範例，如果對https用法有興趣，可以參考這篇)

ThrottlerRouteBuilder

接下來是今天的主角，我先列出程式碼內容，後面再針對重點configure做說明:

package org.tonylin.practice.camel.throttler;
 
import static com.google.common.base.Preconditions.checkState;
 
import org.apache.camel.Exchange;
import org.apache.camel.Processor;
import org.apache.camel.builder.RouteBuilder;
import org.apache.camel.processor.ThrottlerRejectedExecutionException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
 
public class ThrottlerRouteBuilder extends RouteBuilder {
	private static Logger logger = LoggerFactory.getLogger(ThrottlerRouteBuilder.class);
	private final static String GET_EVENTS = "GET_EVENTS";
 
	private Object eventHandler;
 
	private int limit = 2;
	private int period = 200;
 
	public ThrottlerRouteBuilder(Object eventHandler) {
		this.eventHandler = eventHandler;
 
	}
 
	public void setLimit(int limit) {
		this.limit = limit;
	}
 
	public void setPeriod(int period) {
		this.period = period;
	}
 
	@Override
	public void configure() throws Exception {
		checkState(eventHandler!=null, "Can't find eventHandler");
 
		onException(ThrottlerRejectedExecutionException.class)
		.process(new Processor() {
			@Override
			public void process(Exchange exchange) throws Exception {
				logger.debug("handle ThrottlerRejectedExecutionException");
				exchange.getOut().setHeader(Exchange.HTTP_RESPONSE_CODE, "503");
			}
		})
		.handled(true);
 
		rest("/events/{id}").get().route().id(GET_EVENTS)
		.throttle(limit)
		.timePeriodMillis(period)
		.rejectExecution(true)
		.bean(eventHandler).endRest();
	}
}

我首要說明的是throttler的configure:

rest("/events/{id}").get().route().id(GET_EVENTS)
	.throttle(limit)
	.timePeriodMillis(period)
	.rejectExecution(true)
	.bean(eventHandler).endRest();

除了HTTP GET的宣告外，這些程式碼代表著以下意義:

  • throttle(limit): 限制的存取次數。
  • timePeriodMillis(period): 限制存取次數的單位時間，預設是1000ms。
  • rejectExecution(true): 當超過此限制時，是否要reject請求，預設為false。假如沒reject，後續超過限制的請求會block至單位時間後執行。
  • bean(eventHandler): 請求的處理者。

在我設定rejectExecution為true後，我發現camel會拋出ThrottlerRejectedExecutionException，且client會block住；因此這個設定必須與camel的errorHandler一同使用，這是我的使用範例:

onException(ThrottlerRejectedExecutionException.class)
	.process(new Processor() {
		@Override
		public void process(Exchange exchange) throws Exception {
			logger.debug("handle ThrottlerRejectedExecutionException");
			exchange.getOut().setHeader(Exchange.HTTP_RESPONSE_CODE, "503");
		}
	})
.handled(true);

我宣告當發生ThrottlerRejectedExecutionException例外時，會將回應給client的response code設為503以代表server過載。除此之外，別忘記把handled設為true，代表例外已被處理。

Unit Test

最後我以單元測試來展示效果，包含testOverload與testThrottlePeriod兩個測試；而throttler的limit為2，period為200ms，testcase會在後面做說明:

package org.tonylin.practice.camel.throttler;
 
import java.util.ArrayList;
import java.util.List;
 
import org.apache.camel.RoutesBuilder;
import org.apache.camel.test.junit4.CamelTestSupport;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.HttpClientBuilder;
import org.junit.Test;
import org.tonylin.practice.camel.rest.RestHandler;
import org.tonylin.practice.camel.rest.RestRouteBuilder;
 
public class ThrottlerRouteBuilderTest extends CamelTestSupport {
 
	private RestHandler hander = new RestHandler();
	private static final int limit = 2;
	private static final int period = 200;
 
	private HttpClient client = HttpClientBuilder.create().build();
	private HttpGet httpGet = new HttpGet("http://localhost:8080/events/123");
 
	@Override
	protected RoutesBuilder[] createRouteBuilders() throws Exception {
		ThrottlerRouteBuilder throttlerRouteBuilder = new ThrottlerRouteBuilder(hander);
		throttlerRouteBuilder.setLimit(limit);
		throttlerRouteBuilder.setPeriod(period);
 
		return new RoutesBuilder[] {
				new RestRouteBuilder(),
				throttlerRouteBuilder
		};
	}
 
	private List<HttpResponse> batchRequest(int times) throws Exception {
		List<HttpResponse> responses = new ArrayList<HttpResponse>();
		for( int i = 0 ; i < times ; i++ ) {
			responses.add(client.execute(httpGet));
		}
		return responses;
	}
 
	@Test
	public void testOverload() throws Exception {
		// skip
	}
 
	@Test
	public void testThrottlePeriod() throws Exception  {
		// skip
	}
}

測試中使用的RestHandler，負責收集請求的event id，用以確認請求內容是否正確:

public class RestHandler {
	private static Logger logger = LoggerFactory.getLogger(RestHandler.class);
	private List<String> requestIds = new ArrayList<String>();
 
	@Handler
	public void handle(Exchange exchange) {
		String requestId = exchange.getIn().getHeader("id", String.class);
		logger.debug("Request id: {}", requestId);
		requestIds.add(requestId);
	}
 
	public List<String> getRequestIds(){
		return requestIds;
	}
}

針對testOverload測試，是用來確認throttler單位時間內的請求是否有效；因此測試中，連續做了3次請求，最後會去確認這三次的請求結果是否正確:

@Test
public void testOverload() throws Exception {
	// when request 3 times
	List<HttpResponse> responses = batchRequest(3);
 
	// then
	assertEquals(2, hander.getRequestIds().size());
	assertEquals(200, responses.get(0).getStatusLine().getStatusCode());
	assertEquals(200, responses.get(1).getStatusLine().getStatusCode());
	assertEquals(503, responses.get(2).getStatusLine().getStatusCode());
}

而testThrottlePeriod測試，用以確認throttler單位時間是否有作用；因此測試中，會先發3次請求，再等待此單位時間後，再發3次請求。最後確認請求結果:

@Test
public void testThrottlePeriod() throws Exception  {
	// when
	List<HttpResponse> responses = batchRequest(3);
	Thread.sleep(period+1);
 
	responses.addAll(batchRequest(3));
 
	// then
	assertEquals(2, hander.getRequestIds().size());
	assertEquals(200, responses.get(0).getStatusLine().getStatusCode());
	assertEquals(200, responses.get(1).getStatusLine().getStatusCode());
	assertEquals(503, responses.get(2).getStatusLine().getStatusCode());
	assertEquals(200, responses.get(3).getStatusLine().getStatusCode());
	assertEquals(200, responses.get(4).getStatusLine().getStatusCode());
	assertEquals(503, responses.get(5).getStatusLine().getStatusCode());
}

透過這兩個測試範例，我們可以簡單地了解throttler的用法。

Library Info (Gradle Config)

以下是我在寫這篇文章時，所使用的libraries版本:

ext {
	camelVersion='2.23.1'
	nettyAllVersion='4.1.34.Final'
	guavaVersion='27.1-jre'
	log4jVersion='1.2.17'
	slf4jVersion='1.7.26'
	httpClientVersion='4.5.7'
}

dependencies {
    compile group: 'org.apache.camel', name: 'camel-core', version: "$camelVersion"
    compile group: 'org.apache.camel', name: 'camel-netty4-http', version: "$camelVersion"
    compile group: 'org.apache.camel', name: 'camel-http-common', version: "$camelVersion"
    compile group: 'org.apache.camel', name: 'camel-netty4', version: "$camelVersion"
    compile group: 'io.netty', name: 'netty-all', version: "$nettyAllVersion"
    compile group: 'com.google.guava', name: 'guava', version: "$guavaVersion"
    compile group: 'log4j', name: 'log4j', version: "$log4jVersion"
    compile group: 'org.slf4j', name: 'slf4j-api', version: "$slf4jVersion"
    runtime group: 'org.slf4j', name: 'slf4j-log4j12', version: "$slf4jVersion"
    testCompile group: 'org.apache.camel', name: 'camel-test', version: "$camelVersion"
    testCompile group: 'org.apache.httpcomponents', name: 'httpclient', version: "$httpClientVersion"
    testCompile 'junit:junit:4.12'
}

Reference

標籤：

留言

張貼留言

這個網誌中的熱門文章

解決RobotFramework從3.1.2升級到3.2.2之後，Choose File突然會整個Hand住的問題

考慮到自動測試環境的維護，我們很久以前就使用java去執行robot framework。前陣子開始處理從3.1.2升級到3.2.2的事情，主要先把明確的runtime語法錯誤與deprecate item處理好，這部分內容可以參考: link 。 直到最近才發現，透過SeleniumLibrary執行Choose File去上傳檔案的動作，會導致測試案例timeout。本篇文章主要分享心路歷程與解決方法，我也送了一條issue給robot framework: link 。 我的環境如下: RobotFramework: 3.2.2 Selenium: 3.141.0 SeleniumLibrary: 3.3.1 Remote Selenium Version: selenium-server-standalone-3.141.59 首先並非所有Choose File的動作都會hang住，有些測試案例是可以執行的，但是上傳一個作業系統ISO檔案一定會發生問題。後來我透過wireshark去比對新舊版本的上傳動作，因為我使用 Remote Selenium ，所以Selenium會先把檔案透過REST API發送到Remote Selenium Server上。從下圖我們可以發現，在3.2.2的最後一個TCP封包，比3.1.2大概少了500個bytes。 於是就開始了我trace code之路。包含SeleniumLibrary產生要送給Remote Selenium Server的request內容，還有HTTP Content-Length的計算，我都確認過沒有問題。 最後發現問題是出在socket API的使用上，就是下圖的這支code: 最後發現可能因為開始使用nio的方式送資料，但沒處理到尚未送完的資料內容，而導致發生問題。加一個loop去做計算就可以解決了。 最後我有把解法提供給robot framework官方，在他們出新的版本之前，我是將改完的_socket.py放在我們自己的Lib底下，好讓我們測試可以正常進行。(shutil.py應該也是為了解某個bug而產生的樣子..)
張貼留言
閱讀完整內容

Show NIC selection when setting the network command with the device option

 Problem  在answer file中設定網卡名稱後，安裝時會停在以下畫面: 所使用的command參數如下: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 Diagnostic Result 這樣的參數，以前試驗過是可以安裝完成的。因此在發生這個問題後，我檢查了它的debug console: 從console得知，eth1可能是沒有連接網路線或者是網路太慢而導致的問題。後來和Ivy再三確認，有問題的是有接網路線的網卡，且問題是發生在activate階段: Solution 我想既然有retry應該就有次數或者timeout限制，因此發現在Anaconda的說明文件中( link )，有提到dhcptimeout這個boot參數。看了一些人的使用範例，應該是可以直接串在isolinux.cfg中，如下: default linux ksdevice = link ip =dhcp ks =cdrom: / ks.cfg dhcptimeout = 90 然而我在RHEL/CentOS 6.7與6.8試驗後都無效。 因此我就拿了顯示的錯誤字串，問問Google大師，想找一下Anaconda source code來看一下。最後找到別人根據Anaconda code修改的版本: link ，關鍵在於setupIfaceStruct函式中的setupIfaceStruct與readNetConfig: setupIfaceStruct: 會在dhcp時設定dhcptimeout。 readNetConfig: 在writeEnabledNetInfo將timeout寫入dhclient config中；在wait_for_iface_activation內會根據timeout做retry。 再來從log與code可以得知，它讀取的檔案是answer file而不是boot command line。因此我接下來的測試，就是在answer file的network command上加入dhcptimeout: network --onboot = yes --bootproto =dhcp --ipv6 =auto --device =eth1 --...
張貼留言
閱讀完整內容

Robot Framework - Evaluate該怎麼用?

Evaluate該怎麼用? 前言 Builtin的RobotFramework Library提供了Evaluate Keyword。它所提供的功能是「執行Python描述句」。但實際上到底有什麼用途呢?原本我僅僅拿來將string轉為int的功用，經過一些查詢與試驗，我將心得整理給大家。 Builtin Builtin的function可以參考Library Doc for Evaluate。我以有使用過的function做說明。 數字轉換 Python提供了int、long、float與complex等function讓你可以將字串轉為數字，也可以透過它們做四則運算。首先以字串轉數字為例，我將8設於${num_str}中，再透過Evaluate+int轉為數字。這裡必須注意的是: 「int()中放變數必須以單引號'括起」。否則，假如你設定的數字為08，在轉換int時會出現Syntax Error。 ${num_str} | Set Variable | 8 ${num} | Evaluate | int('${num_str}') 其中int與long的第二個參數為base，這是根據你的input所決定: Comment | num = 9 ${num} | Evaluate | int('11', 8) Comment | num = 11 ${num} | Evaluate | int('11', 10) Comment | num = 17 ${num} | Evaluate | int('11', 16) 其它還有像bin、oct、hex，可以將整數轉為2、8、16進位。 運算 四則運算: 直接將運算子加上即可: ${num} | Evaluate | int('${hour}')*60 + int('${min}') 指數: 可以用pow。以下面兩個例子來說，第一個是2的3次方為8，第二個是2的3次方再mod 7為1。需注意的是: 「傳入值必須是數字不可為字串」。 ${num} | Evaluate | pow(2,3) ${num} | Evaluate | pow(2,3,7) 取最大最小值: 使用max/min，可以選擇丟一個array的方式...
張貼留言
閱讀完整內容