rath / http-replay-bench Goto Github PK

==============================================
  HTTP Benchmark tool with captured requests
==============================================

Author
-------------
Jang-Ho Hwang, [email protected]


What is this?
-------------
A benchmark tool to replay all http-requests which are captured in a real 
environment, not a fake one. We have to test our web applications with good 
and even bad parameters or headers. In many cases, we cannot expect most kinds 
of requests that are sent by users. As a result, we usually do test in a small 
boundary, and will see a sort of bugs in a real environment. 

With replay benchmark tool, you can capture users' http-request to file system.
then, can test your modified web application with captured requests. 



Requirement
-------------
Java Standard Edition 6 or greater version.


Usage
-------------
java -jar rb.jar -d samples -c 100 -n 20000 http://myservice.com/


Expected result
---------------
Number of sent requests
2,000,000

Total time to consume
06h 21m 10s

                  min     avg      max
Response time     3ms   260ms    822ms

Response codes     
OK        200:      1,883,293  ( 94.16%)
Moved     302:         17,382  (  0.86%)
Forbidden 403:          1,238  (  0.06%)
Not found 404:              0  (  0.00%)
Error     500:        103,290  (  5.16%)
Death     503:            383  (  0.01%)


Options
-----------
d : A directory pathname that includes captured http-requests in file formats. 
    This file is generated by rb-capture-plugin.jar.

c : concurrency. number of multiple requests to replay at a time. Default is one
    request at a time. The default implementation is built with n-thread. 

n : Number of requests to replay for benchmarking session. this number is 
    belong to each thread to replay http-requests.


Format of Captured Requests
---------------------------
Captured requests are stored with Java Object Serialization. A sequence of 
java.util.Map objects. These maps are not stored in java.util.List. Instead,
each map have its own stream header. Following is a code snippet which is 
intended to capture a series of http-requests. 

  FileOutputStream fos = new FileOutputStream(String.format(
    "captured-%d.log", Thread.currentThread().getId()), true);

  ObjectOutputStream oos = new ObjectOutputStream(fos); 
  oos.writeObject(*a-http-request*);
  oos.flush();

  fos.close();

A http-request is a java.util.Map object which includes following attributes. 

  REMOTE_ADDR  : a IP in String. but not be used in this benchmark tool.
  METHOD       : HTTP Method in String . it can be GET, POST, DELETE, PUT.
  HEADERS      : a Map which is includes all HTTP request headers. Its generic
                 type is Map<String, String>. This attributes are useful 
                 when you want to test in gzip/deflate request.
  REQUEST_URI  : a URI in String. Be careful that this value doesn't include
                 querystring even in GET method.
  PARAMETERS   : a Map which is stored all parameters included in a request. 
                 Its generic type is Map<String, Object>. the format of a 
                 value is generally String and can be String[].
  TIMESTAMP    : timestamp when this request was sent that represented by Long.


Install rb-capture-plugin.jar into your web application
---------------------------------------------------
1) copy rb-capture-plugin.jar into WEB-INF/lib
2) Open web.xml file and append below block.

  <filter>
    <filter-name>request-capture</filter-name>
    <filter-class>com.xrath.benchmark.http.plugins.RequestCaptureFilter</filter-class>
    <init-param>
      <param-name>output-directory</param-name>
      <param-value>/tmp</param-value>
    </init-param>
  </filter>
  
  <filter-mapping>
    <filter-name>request-capture</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

3) Done!