From 26b12518210e87c0db1b9078aa5e4ee3db239d5f Mon Sep 17 00:00:00 2001 From: Hashim Khan Date: Mon, 27 Jul 2026 04:25:24 +0500 Subject: [PATCH] docs: clarify that latency toxics are one-way The latency section said delay applied to all data through the proxy, which suggested bidirectional delay. Document the default downstream stream and that both streams need latency for a symmetric round trip. Fixes #655 --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b385e7e..4f461220 100644 --- a/README.md +++ b/README.md @@ -382,7 +382,12 @@ For documentation on implementing custom toxics, see [CREATING_TOXICS.md](./CREA #### latency -Add a delay to all data going through the proxy. The delay is equal to `latency` +/- `jitter`. +Add a delay to data on a single proxy stream. The delay is equal to `latency` +/- `jitter`. + +Toxics are directional: by default a latency toxic is attached to the `downstream` +stream (`server -> client`). It does not delay the opposite direction unless you +also add a latency toxic with `stream=upstream`. For a symmetric round-trip delay, +add latency on both streams. Attributes: