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

Enable prometheus by default, update README

Browse source
This commit is contained in:
Joakim Frostegård 2023-02-26 12:10:12 +01:00
parent 9e7e56b082
commit 07eac06a36
4 changed files with 15 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -125,17 +125,11 @@ in emitting of an info-level log message.
#### Prometheus #### Prometheus
`aquatic_http` and `aquatic_ws` support exporting [Prometheus](https://prometheus.io/) metrics. Exporting [Prometheus](https://prometheus.io/) metrics is supported.
Pass the `prometheus` feature when building: To use, activate the prometheus endpoint in the configuration file:
```sh ##### aquatic_http and aquatic_ws
. ./scripts/env-native-cpu-without-avx-512
cargo build --release -p aquatic_ws --features "prometheus"
cargo build --release -p aquatic_http --features "prometheus"
```
Then activate the prometheus endpoint in the configuration file:
```toml ```toml
[metrics] [metrics]
@ -143,6 +137,15 @@ run_prometheus_endpoint = true
prometheus_endpoint_address = "0.0.0.0:9000" prometheus_endpoint_address = "0.0.0.0:9000"
``` ```
##### aquatic_udp
```toml
[statistics]
interval = 5
run_prometheus_endpoint = true
prometheus_endpoint_address = "0.0.0.0:9000"
```
### Running ### Running
If you're running `aquatic_http` or `aquatic_ws`, please make sure locked memory If you're running `aquatic_http` or `aquatic_ws`, please make sure locked memory

1
aquatic_http/Cargo.toml
View file

@ -17,6 +17,7 @@ name = "aquatic_http"
name = "aquatic_http" name = "aquatic_http"
[features] [features]
default = ["prometheus"]
prometheus = ["metrics", "metrics-exporter-prometheus"] prometheus = ["metrics", "metrics-exporter-prometheus"]
metrics = ["dep:metrics"] metrics = ["dep:metrics"]

1
aquatic_udp/Cargo.toml
View file

@ -17,6 +17,7 @@ name = "aquatic_udp"
name = "aquatic_udp" name = "aquatic_udp"
[features] [features]
default = ["prometheus"]
cpu-pinning = ["aquatic_common/hwloc"] cpu-pinning = ["aquatic_common/hwloc"]
prometheus = ["metrics", "metrics-exporter-prometheus"] prometheus = ["metrics", "metrics-exporter-prometheus"]

1
aquatic_ws/Cargo.toml
View file

@ -17,6 +17,7 @@ name = "aquatic_ws"
name = "aquatic_ws" name = "aquatic_ws"
[features] [features]
default = ["prometheus"]
prometheus = ["metrics", "metrics-exporter-prometheus"] prometheus = ["metrics", "metrics-exporter-prometheus"]
metrics = ["dep:metrics"] metrics = ["dep:metrics"]