https://github.com/aykhans/sarin
A high-performance HTTP load testing tool. Features dynamic request generation with 320+ template functions, proxy support, and configuration via CLI, YAML, ENV.
https://github.com/aykhans/sarin
benchmarking cli go load-testing
Last synced: 3 months ago
JSON representation
A high-performance HTTP load testing tool. Features dynamic request generation with 320+ template functions, proxy support, and configuration via CLI, YAML, ENV.
- Host: GitHub
- URL: https://github.com/aykhans/sarin
- Owner: aykhans
- License: mit
- Created: 2024-05-25T16:02:42.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2026-03-22T18:31:59.000Z (4 months ago)
- Last Synced: 2026-03-23T09:47:26.991Z (3 months ago)
- Topics: benchmarking, cli, go, load-testing
- Language: Go
- Homepage:
- Size: 923 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
## Sarin is a high-performance HTTP load testing tool built with Go and fasthttp.
[](https://pkg.go.dev/go.aykhans.me/sarin)
[](https://goreportcard.com/report/go.aykhans.me/sarin)
[](https://opensource.org/licenses/MIT)
Install •
Quick Start •
Examples •
Configuration •
Templating
## Overview
Sarin is designed for efficient HTTP load testing with minimal resource consumption. It prioritizes simplicity—features like templating add zero overhead when unused.
| ✅ Supported | ❌ Not Supported |
| ---------------------------------------------------------- | ------------------------------- |
| High-performance with low memory footprint | Detailed response body analysis |
| Long-running duration/count based tests | Extensive response statistics |
| Dynamic requests via 320+ template functions | Web UI or complex TUI |
| Request scripting with Lua and JavaScript | Distributed load testing |
| Multiple proxy protocols
(HTTP, HTTPS, SOCKS5, SOCKS5H) | HTTP/2, HTTP/3, WebSocket, gRPC |
| Flexible config (CLI, ENV, YAML) | Plugins / extensions ecosystem |
## Installation
### Docker (Recommended)
```sh
docker pull aykhans/sarin:latest
```
With a local config file:
```sh
docker run --rm -it -v /path/to/config.yaml:/config.yaml aykhans/sarin -f /config.yaml
```
With a remote config file:
```sh
docker run --rm -it aykhans/sarin -f https://example.com/config.yaml
```
### Pre-built Binaries
Download the latest binaries from the [releases](https://github.com/aykhans/sarin/releases) page.
### Building from Source
Requires [Go 1.26+](https://golang.org/dl/).
```sh
git clone https://github.com/aykhans/sarin.git && cd sarin
CGO_ENABLED=0 go build \
-ldflags "-X 'go.aykhans.me/sarin/internal/version.Version=dev' \
-X 'go.aykhans.me/sarin/internal/version.GitCommit=$(git rev-parse HEAD)' \
-X 'go.aykhans.me/sarin/internal/version.BuildDate=$(date -u +%Y-%m-%dT%H:%M:%SZ)' \
-X 'go.aykhans.me/sarin/internal/version.GoVersion=$(go version)' \
-s -w" \
-o sarin ./cmd/cli/main.go
```
## Quick Start
Send 10,000 GET requests with 50 concurrent connections and a random User-Agent for each request:
```sh
sarin -U http://example.com -r 10_000 -c 50 -H "User-Agent: {{ fakeit_UserAgent }}"
```
Run a 5-minute duration-based test:
```sh
sarin -U http://example.com -d 5m -c 100
```
Use a YAML config file:
```sh
sarin -f config.yaml
```
For more usage examples, see the **[Examples Guide](docs/examples.md)**.
## Configuration
Sarin supports environment variables, CLI flags, and YAML files. When the same option is specified in multiple sources, the following priority order applies:
```
CLI Flags (Highest) > YAML > Environment Variables (Lowest)
```
For detailed documentation on all configuration options (URL, method, timeout, concurrency, headers, cookies, proxy, etc.), see the **[Configuration Guide](docs/configuration.md)**.
## Templating
Sarin supports Go templates in URL paths, methods, bodies, headers, params, cookies, and values. Use the 320+ built-in functions to generate dynamic data for each request.
**Example:**
```sh
sarin -U "http://example.com/users/{{ fakeit_UUID }}" -r 1000 -c 10 \
-V "REQUEST_ID={{ fakeit_UUID }}" \
-H "X-Request-ID: {{ .Values.REQUEST_ID }}" \
-B '{"request_id": "{{ .Values.REQUEST_ID }}"}'
```
For the complete templating guide and functions reference, see the **[Templating Guide](docs/templating.md)**.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.