Skip to content

Commit

Permalink
More docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fcsonline committed Mar 6, 2018
1 parent 4256dc2 commit 7b4ab6d
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,16 @@ plan:
request:
method: DELETE
url: /

- name: Custom headers
request:
url: /admin
headers:
Authorization: Basic aHR0cHdhdGNoOmY=
X-Foo: Bar
```
As you can see you can play with interpolations in different ways. This
As you can see, you can play with interpolations in different ways. This
will let you specify a benchmank with different requests and
dependencies between them.
Expand All @@ -130,13 +137,13 @@ This is the list of all features supported by the current version of `drill`:
- **Multi thread:** run your benchmarks setting as many concurrent threads as you want.
- **Multi iterations:** specify the number of iterations you want to run the benchmark.
- **Dynamic urls:** execute requests with dynamic interpolations in the url, like `/api/users/{{ item }}`
- **Dynamic headers:** execute requests with dynamic headers. [headers.yml](./example/headers.yml)
- **Dynamic headers:** execute requests with dynamic headers. Example: [headers.yml](./example/headers.yml)
- **Request dependencies:** create dependencies between requests with `assign` and url interpolations.
- **Split files:** organize you benchmarks in multiple files and include them.
- **Split files:** organize your benchmarks in multiple files and include them.
- **CSV support:** read CSV files and build N requests fill dynamic interpolations with CSV data.
- **HTTP methods:** build request with different http methods like GET, POST, PUT, PATCH or DELETE.
- **Cookie support:** create benchmarks with sessions because cookies are propagates between requests.
- **Stats:** get nice statistics about all the requests. [cookies.yml](./example/cookies.yml)
- **Stats:** get nice statistics about all the requests. Example: [cookies.yml](./example/cookies.yml)
- **Thresholds:** compare the current benchmark performance against a stored one session and fail if a threshold is exceeded.

## Test it
Expand Down
35 changes: 35 additions & 0 deletions example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Compile drill:
cargo build --release
```

### Example 1

Start a HTTP server from `responses` directory in another terminal:

```
Expand All @@ -19,3 +21,36 @@ and then run:
cd example
../target/release/drill --benchmark benchmark.yml
```

### Example 2

Start a Node HTTP server from `server` directory in another terminal:

```
cd example/server
npm install
node server.js
```

and then run:

```
cd example
../target/release/drill --benchmark cookies.yml
```

### Example 3

Start a Node HTTP server from `server` directory in another terminal:

```
cd example/server
npm install
node server.js
```

and then run:

```
cd example
../target/release/drill --benchmark headers.yml

0 comments on commit 7b4ab6d

Please sign in to comment.