YGGverse/aquatic
1
0
Fork 0
mirror of https://github.com/YGGverse/aquatic.git synced 2026-03-31 09:45:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

README: document ws prometheus support

Browse source
This commit is contained in:
Joakim Frostegård 2023-01-17 21:57:21 +01:00
parent 20d1bd73ec
commit 9dd45fd74c
1 changed files with 23 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -232,6 +232,29 @@ proxied to IPv4 requests, and IPv6 requests to IPv6 requests.
More details are available [here](./documents/aquatic-ws-load-test-2022-03-29.pdf). Please note that request workers have been renamed to swarm workers.
#### Prometheus
`aquatic_ws` supports exporting [Prometheus](https://prometheus.io/) metrics.
Pass the `prometheus` feature when building:
```sh
. ./scripts/env-native-cpu-without-avx-512
cargo build --release -p aquatic_ws --features "prometheus"
```
Then activate the prometheus endpoint in the configuration file:
```toml
[metrics]
# Run a prometheus endpoint
run_prometheus_endpoint = true
# Address to run prometheus endpoint on
prometheus_endpoint_address = "0.0.0.0:9000"
# Update metrics for torrent count this often (seconds)
torrent_count_update_interval = 10
```
## Load testing
There are load test binaries for all protocols. They use a CLI structure