From 9dd45fd74c031a1e5c7507bb153ea4a95c7abdb4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Joakim=20Frosteg=C3=A5rd?= <joakim.frostegard@gmail.com>
Date: Tue, 17 Jan 2023 21:57:21 +0100
Subject: [PATCH] README: document ws prometheus support

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/README.md b/README.md
index 5cf42dd..25dae04 100644
--- a/README.md
+++ b/README.md
@@ -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