Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

patch for socketio support #33

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

patch for socketio support #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
744e1d9
add soket.io support
iorichina Nov 5, 2015
ddc5415
thor:add ping(socket.io supported);socketio:optimize
iorichina Nov 6, 2015
40960cd
optimize
iorichina Nov 6, 2015
720bcdc
set unix style
iorichina Nov 6, 2015
4e4ef60
fix
iorichina Nov 6, 2015
7f4fdf1
socketio add polling support
iorichina Nov 6, 2015
7982347
fix
iorichina Nov 6, 2015
8275a3d
update stat interval
iorichina Nov 11, 2015
350165c
update 1.1.2
iorichina Nov 11, 2015
6f438ef
change socketio mode +x
iorichina Nov 12, 2015
9545ce2
add log error, fix concurrent summary
iorichina Dec 29, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
### 1.1.2

make things better

### 1.0.1

Add socket.io support

### 1.0.0

Initial release of `thor`.
382 changes: 231 additions & 151 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,151 +1,231 @@
# Thor

Thor is WebSocket benchmarking/load generator. There are a lot of benchmarking
tools for HTTP servers. You've got ab, siege, wrk and more. But all these tools
only work with plain ol HTTP and have no support for WebSockets - even if they did
they wouldn't be suitable, as they would be testing short running HTTP requests
instead of long running HTTP requests with a lot of messaging traffic. Thor
fixes all of this.

### Dependencies

Thor requires Node.js to be installed on your system. If you don't have Node.js
installed you can download it from http://nodejs.org or build it from the github
source repository: http://github.com/joyent/node.

Once you have Node.js installed, you can use the bundled package manager `npm` to
install this module:

```
npm install -g thor
```

The `-g` command flag tells `npm` to install the module globally on your system.

### Usage

```
thor [options] <urls>
```

Thor can hit multiple URL's at once; this is useful if you are testing your
reverse proxies, load balancers or just simply multiple applications. The url
that you supply to `thor` should be written in a WebSocket compatible format
using the `ws` or `wss` protocols:

```
thor --amount 5000 ws://localhost:8080 wss://localhost:8081
```

The snippet above will open up `5000` connections against the regular
`ws://localhost:8080` and also `5000` connections against the *secured*
`wss://localhost:8081` server, so a total of `10000` connections will be made.

One thing to keep in mind is you probably need to bump the amount of file
descriptors on your local machine if you start testing WebSockets. Set the
`ulimit -n` on machine as high as possible. If you do not know how to do this,
Google it.

#### Options

```
Usage: thor [options] ws://localhost

Options:

-h, --help output usage information
-A, --amount <connections> the amount of persistent connections to generate
-C, --concurrent <connections> how many concurrent-connections per second
-M, --messages <messages> messages to be send per connection
-P, --protocol <protocol> WebSocket protocol version
-B, --buffer <size> size of the messages that are send
-W, --workers <cpus> workers to be spawned
-G, --generator <file> custom message generators
-M, --masked send the messaged with a mask
-b, --binary send binary messages instead of utf-8
-V, --version output the version number
```

Some small notes about the options:

- `--protocol` is the protocol version number. If you want to use the *HyBi drafts
07-12* use `8` as argument or if you want to use the *HyBi drafts 13-17*
drafts which are the default version use `13`.
- `--buffer` should be size of the message in bytes.
- `--workers` as Node.js is single threaded this sets the amount of sub
processes to handle all the heavy lifting.

### Custom messages

Some WebSocket servers have their own custom messaging protocol. In order to
work with those servers we introduced a concept called `generators` a generator
is a small JavaScript file that can output `utf8` and `binary` messages. It uses
a really simple generator by default.

Checkout https://github.com/observing/thor/blob/master/generator.js for an
example of a generator.

```
thor --amount 1000 --generator <file.js> ws://localhost:8080
```

### Example

```
thor --amount 1000 --messages 100 ws://localhost:8080
```

This will hit the WebSocket server that runs on localhost:8080 with 1000
connections and sends 100 messages over each established connection. Once `thor`
is done with smashing your connections it will generate a detailed report:

```
Thor: version: 1.0.0

God of Thunder, son of Odin and smasher of WebSockets!

Thou shall:
- Spawn 4 workers.
- Create all the concurrent/parallel connections.
- Smash 1000 connections with the mighty Mjölnir.

The answers you seek shall be yours, once I claim what is mine.

Connecting to ws://localhost:8080

Opened 100 connections
Opened 200 connections
Opened 300 connections
Opened 400 connections
Opened 500 connections
Opened 600 connections
Opened 700 connections
Opened 800 connections
Opened 900 connections
Opened 1000 connections


Online 15000 milliseconds
Time taken 31775 milliseconds
Connected 1000
Disconnected 0
Failed 0
Total transferred 120.46MB
Total received 120.43MB

Durations (ms):

min mean stddev median max
Handshaking 217 5036 4094 3902 14451
Latency 0 215 104 205 701

Percentile (ms):

50% 66% 75% 80% 90% 95% 98% 98% 100%
Handshaking 3902 6425 8273 9141 11409 12904 13382 13945 14451
Latency 205 246 266 288 371 413 437 443 701
```

### License

MIT
# Thor

Thor is WebSocket benchmarking/load generator. There are a lot of benchmarking
tools for HTTP servers. You've got ab, siege, wrk and more. But all these tools
only work with plain ol HTTP and have no support for WebSockets - even if they did
they wouldn't be suitable, as they would be testing short running HTTP requests
instead of long running HTTP requests with a lot of messaging traffic. Thor
fixes all of this.

### Dependencies

Thor requires Node.js to be installed on your system. If you don't have Node.js
installed you can download it from http://nodejs.org or build it from the github
source repository: http://github.com/joyent/node.

Once you have Node.js installed, you can use the bundled package manager `npm` to
install this module:

```
npm install -g git://github.com/iorichina/thor.git
```

The `-g` command flag tells `npm` to install the module globally on your system.

### Usage

```
thor [options] <urls>
socketio [options] <urls>
```

Thor can hit multiple URL's at once; this is useful if you are testing your
reverse proxies, load balancers or just simply multiple applications. The url
that you supply to `thor` should be written in a WebSocket compatible format
using the `ws` or `wss` protocols:

```
thor --amount 5000 ws://localhost:8080 wss://localhost:8081
```
or use http/https if and only if ur using socket.io(nodejs/java/etc) in server
```
socketio --amount 5000 http://localhost:8080/ https://localhost:8081/
```

The snippet above will open up `5000` connections against the regular
`ws://localhost:8080` and also `5000` connections against the *secured*
`wss://localhost:8081` server, so a total of `10000` connections will be made.

One thing to keep in mind is you probably need to bump the amount of file
descriptors on your local machine if you start testing WebSockets. Set the
`ulimit -n` on machine as high as possible. If you do not know how to do this,
Google it.

And the other thing u have to know is that, one ip can only create max to 60 thousands connections,
which is limited by TCP/IP protocal. U can special the [@@one_of_the_machine_vip] after the url.

#### thor Options

```
Usage: thor [options] urls

urls like
ws://localhost:8080/?params
ws://localhost:8080/?params ws://localhost:8080/socket.io/?transport=websocket
ws://localhost:8080/?params@@192.168.102.33 ws://localhost:8080/socket.io/?transport=websocket@@192.168.102.53

Options:

-h, --help output usage information
-A, --amount <connections> the amount of persistent connections to generate, default 10000
-C, --concurrent [connections] [deprecated]how many concurrent-connections per second, default 0
-M, --messages [messages] number of messages to be send per connection, default 0
-P, --protocol [protocol] WebSocket protocol version, default 13
-B, --buffer [size] size of the messages that are send, default 1024
-W, --workers [cpus] workers to be spawned, default cpus.length
-G, --generator [file] custom message generators
-M, --masked send the messaged with a mask
-b, --binary send binary messages instead of utf-8
--SE, --serverEngine [engine] "socket.io"/"engine.io"(nodejs), "netty-socketio"(java) must be specified if ur using these engine in ur server
--PI, --pingInterval [seconds] seconds for doing ping to keep-alive, default 50
--SI, --statInterval [seconds] show stat info interval, default 60
--RT, --runtime [seconds] timeout to close socket(seconds), default to unlimited, u must stop by ctrl+c
-V, --version output the version number
```

Some small notes about the options:

- `--protocol` is the protocol version number. If you want to use the *HyBi drafts
07-12* use `8` as argument or if you want to use the *HyBi drafts 13-17*
drafts which are the default version use `13`.
- `--buffer` should be size of the message in bytes.
- `--workers` as Node.js is single threaded this sets the amount of sub
processes to handle all the heavy lifting.

#### socketio Options

```
Usage: socketio [options] urls

urls like
http://localhost:8080/
http://localhost:8080/?params
http://localhost:8080/?params@@192.168.102.53

Options:

-h, --help output usage information
-A, --amount <connections> the amount of persistent connections to generate, default 10000
-C, --concurrent [connections] [deprecated]how many concurrent-connections per second, default 0
-M, --messages [messages] number of messages to be send per connection, default 0
-P, --protocol [protocol] WebSocket protocol version, default 13
-B, --buffer [size] size of the messages that are send, default 1024
-W, --workers [cpus] workers to be spawned, default cpus.length
-G, --generator [file] custom message generators
-M, --masked send the messaged with a mask
-b, --binary send binary messages instead of utf-8
--TP, --transport [transport] "polling"/"websocket" default websocket
--PI, --pingInterval [seconds] seconds for doing ping to keep-alive, default 50
--SI, --statInterval [seconds] show stat info interval, default 60
--RT, --runtime [seconds] timeout to close socket(seconds), default to unlimited, u must stop by ctrl+c
-V, --version output the version number
```


### Custom messages

Some WebSocket servers have their own custom messaging protocol. In order to
work with those servers we introduced a concept called `generators` a generator
is a small JavaScript file that can output `utf8` and `binary` messages. It uses
a really simple generator by default.

Checkout https://github.com/observing/thor/blob/master/generator.js for an
example of a generator.

```
thor --amount 1000 --generator <file.js> ws://localhost:8080
```

### Example

```
thor --amount 5000 ws://localhost:8080
```

This will hit the WebSocket server that runs on localhost:8080 with 1000
connections and sends 100 messages over each established connection. Once `thor`
is done with smashing your connections it will generate a detailed report:

```
Thor: version: 1.1.2

God of Thunder, son of Odin and smasher of WebSockets!

Thou shall:
- Spawn 4 workers.
- Create all the concurrent connections.
- Smash 5000 connections .

Connecting to ws://localhost:8080

◜ Progress :: Created 0, Active 0, @2015-11-11 17:31:15 ==> this will hide after process end

Online 96728 milliseconds
Time taken 96728 milliseconds
Connected 2211
Disconnected 0
Failed 2789
Total transferred 658.86kB
Total received 631.64kB

Durations (ms):

min mean stddev median max
Handshaking 171 3354 1631 2915 7737
Latency NaN NaN NaN NaN NaN

Percentile (ms):

50% 66% 75% 80% 90% 95% 98% 98% 100%
Handshaking 2915 3627 4705 4827 5811 6412 7686 7712 7737
Latency NaN NaN NaN NaN NaN NaN NaN NaN NaN

Received errors:

2789x undefined
```

### Example

```
socketio --amount 5000 --RT 300 --SI 30 http://localhost:8080/
```

```
Thor: version: 1.1.2

God of Thunder, son of Odin and smasher of WebSockets!

Thou shall:
- Spawn 4 workers.
- Create all the concurrent connections.
- Smash 5 connections.

Connecting to http://localhost:8080/



Online 137539 milliseconds
Time taken 137539 milliseconds
Connected 5000
Disconnected 0
Failed 0
Total transferred 14.59kB
Total received 14.68kB

Durations (ms):

min mean stddev median max
Handshaking 598 614 13 610 638
Latency NaN NaN NaN NaN NaN

Percentile (ms):

50% 66% 75% 80% 90% 95% 98% 98% 100%
Handshaking 610 617 617 638 638 638 638 638 638
Latency NaN NaN NaN NaN NaN NaN NaN NaN NaN
```

### License

MIT
Loading