Shopify / toxiproxy

:alarm_clock: :fire: A TCP proxy to simulate network and system conditions for chaos and resiliency testing
https://github.com/shopify/toxiproxy
MIT License
10.81k stars 448 forks source link

Fix cli help example for specifying several attributes for toxic #202

Closed gavvvr closed 3 years ago

gavvvr commented 6 years ago

toxiproxy-cli h t

gives me an incorrect example for adding new toxic:

toxic add: usage: toxiproxy-cli add --type --toxicName \ --attribute --upstream --downstream

example: toxiproxy-cli toxic add myProxy -t latency -n myToxic -a latency=100,jitter=50

This leads to:

Failed to add toxic: AddToxic: HTTP 409: toxic already exists

Correct usage will be (as said in #139):

toxiproxy-cli toxic add myProxy -t latency -n myToxic -a latency=100 -a jitter=50

miry commented 3 years ago

It seems fixed:

$ toxiproxy-cli h t
...
     toxic add:
       usage: toxiproxy-cli toxic add --type <toxicType> [--downstream|--upstream] \
               --toxicName <toxicName> [--toxicity <float>] \
               --attribute <key=value> [--attribute <key2=value2>] <proxyName>

       example: toxiproxy-cli toxic add -t latency -n myToxic -a latency=100 -a jitter=50 myProxy