Skip to content

docs: clarify that latency toxics are one-way - #756

Open
Hashim1999164 wants to merge 1 commit into
Shopify:mainfrom
Hashim1999164:docs/clarify-latency-toxic-direction
Open

docs: clarify that latency toxics are one-way#756
Hashim1999164 wants to merge 1 commit into
Shopify:mainfrom
Hashim1999164:docs/clarify-latency-toxic-direction

Conversation

@Hashim1999164

@Hashim1999164 Hashim1999164 commented Jul 26, 2026

Copy link
Copy Markdown

Summary

  • The latency toxic docs said the delay applied to all data through the proxy, which read like a bidirectional round trip.
  • Latency toxics only affect the stream they are attached to (default downstream). Symmetric delay needs latency on both upstream and downstream.
  • Updates the latency section to match the existing stream field behavior.

Fixes #655

Test plan

  • Read the latency section in README and confirm it matches the stream field docs
  • No code changes; docs only

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 Shopify#655
@Hashim1999164

Copy link
Copy Markdown
Author

I have signed the CLA!

1 similar comment
@Hashim1999164

Copy link
Copy Markdown
Author

I have signed the CLA!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Latency toxic is not bidirectional (and this is undocumented)

1 participant