https://github.com/eipi1/overload
A distributed load testing tool written in Rust
https://github.com/eipi1/overload
cluster distributed gatling jmeter kubernetes load-generator load-testing performance-testing stress-test
Last synced: 7 months ago
JSON representation
A distributed load testing tool written in Rust
- Host: GitHub
- URL: https://github.com/eipi1/overload
- Owner: eipi1
- License: mit
- Created: 2020-05-05T03:48:21.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-06-27T16:55:58.000Z (over 1 year ago)
- Last Synced: 2025-01-14T05:49:40.844Z (9 months ago)
- Topics: cluster, distributed, gatling, jmeter, kubernetes, load-generator, load-testing, performance-testing, stress-test
- Language: Rust
- Homepage: https://eipi1.github.io/overload/
- Size: 617 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# overload
[](https://eipi1.github.io/overload/)
[![MIT licensed][mit-badge]][mit-url]
[![Github][github-badge]][github-rep]
Overload is a distributed, scalable performance testing application. It mainly focuses on ease-of-use.
* Distributed - users don't need to handle complex cluster management - the application creates and manages the cluster by itself once deployed.
* Control - better control over QPS, connection pool, request data
* Assertion - easy assertion with lua script
For details usage and reference please check https://eipi1.github.io/overload/
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: https://github.com/tokio-rs/tokio/blob/master/LICENSE
[github-badge]: https://img.shields.io/badge/github-eipi1/overload-brightgreen
[github-rep]: https://github.com/eipi1/overload
## Getting started
### Docker
```shell
docker run -p 3030:3030 ghcr.io/eipi1/overload:latest-standalone-snapshot
```
### Kubernetes
```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
labels:
app: overload
name: overload
namespace: default
spec:
replicas: 4
selector:
matchLabels:
app: overload
template:
metadata:
labels:
app: overload
spec:
containers:
- image: ghcr.io/eipi1/overload:latest-cluster-snapshot
imagePullPolicy: "IfNotPresent"
name: overload
ports:
- containerPort: 3030
- containerPort: 3031
env:
- name: DATA_DIR
value: "/tmp"
- name: RUST_BACKTRACE
value: "1"
- name: K8S_ENDPOINT_NAME
value: "overload"
- name: K8S_NAMESPACE_NAME
value: "default"
- name: RUST_LOG
value: info
---
apiVersion: v1
kind: Service
metadata:
name: overload
spec:
# type: LoadBalancer
selector:
app: overload
ports:
- protocol: TCP
port: 3030
targetPort: 3030
name: http-endpoint
- protocol: TCP
port: 3031
targetPort: 3031
name: tcp-remoc
---
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
name: overload-endpoints-reader
rules:
- apiGroups: [""]
resources: ["endpoints"]
verbs: ["get", "list"]
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: overload-endpoints-reader
subjects:
- kind: Group
name: system:serviceaccounts
apiGroup: rbac.authorization.k8s.io
roleRef:
kind: Role
name: overload-endpoints-reader
apiGroup: rbac.authorization.k8s.io
```
### Start Test
The following request will send two `GET` request per second(`"countPerSec": 2`) to `httpbin.org/get` for 120
seconds(`"duration": 120`). More example can be found in [test cases](https://github.com/eipi1/overload/tree/main/tests/src/resources)
```shell
curl --location --request POST '{overload-host}:3030/test' \
--header 'Content-Type: application/json' \
--data-raw ''
```
Sample JSON request body -
```json
{
"duration": 120,
"name": "demo-test",
"qps": {
"ConstantRate": {
"countPerSec": 2
}
},
"req": {
"RequestList": {
"data": [
{
"method": "GET",
"url": "/get"
}
]
}
},
"target": {
"host": "httpbin.org",
"port": 80,
"protocol": "HTTP"
}
}
```
It'll respond with a job identifier and status.
```json
{
"job_id": "demo-test-d2ae5ff0-7bf4-4daf-8784-83b642d7dd6b",
"status": "Starting"
}
```
We'll need the `job_id` if we want to stop the test later.
### Get job status
```shell
curl --location --request GET '{overload-host}:3030/test/status/'
```
### Stop a job
```shell
curl --location --request GET '{overload-host}:3030/test/stop/demo-test-d2ae5ff0-7bf4-4daf-8784-83b642d7dd6b'
```
## Monitoring
Overload exposes details data on QPS, assertion result, etc through prometheus. For details please check [here](https://eipi1.github.io/overload/monitoring.html)
License: MIT