-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
80be4af
commit 988d164
Showing
1 changed file
with
47 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,55 @@ | ||
# Terjang | ||
Scalable HTTP load testing tool built on Vegeta | ||
Scalable HTTP load testing tool built on [Vegeta](https://github.com/tsenart/vegeta). | ||
|
||
[![Build status](https://img.shields.io/github/workflow/status/andylibrian/terjang/CI?style=flat)](https://github.com/andylibrian/terjang/actions) | ||
|
||
## Build for production | ||
|
||
## Features | ||
|
||
- Scalable: support multiple node of workers | ||
- Web UI with detailed report | ||
- Extensible: | ||
- Start and stop load test via HTTP API | ||
- Receive real time results via websocket | ||
|
||
## Install | ||
|
||
### Pre-compiled | ||
|
||
Download the pre-compiled executables from the [releases page](https://github.com/andylibrian/terjang/releases) and copy to the desired location. | ||
|
||
### From source | ||
|
||
```bash | ||
git clone [email protected]:andylibrian/terjang.git | ||
cd terjang | ||
make | ||
``` | ||
|
||
## Usage | ||
|
||
### Quick start on your local machine | ||
|
||
Open a terminal, and run: | ||
|
||
```bash | ||
terjang server | ||
``` | ||
|
||
Open another terminal, and run: | ||
|
||
```bash | ||
terjang worker | ||
``` | ||
|
||
Then open [http://localhost:9009](http://localhost:9009) | ||
|
||
### See more options | ||
|
||
```bash | ||
terjang -h | ||
``` | ||
|
||
## Development | ||
|
||
Prerequisites: | ||
|
@@ -22,12 +64,13 @@ go build -o ./bin/terjang ./cmd/terjang/ | |
|
||
Run server: | ||
|
||
``` | ||
```bash | ||
./bin/terjang server | ||
``` | ||
|
||
Run a worker on another terminal: | ||
``` | ||
|
||
```bash | ||
./bin/terjang worker | ||
``` | ||
|
||
|