Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tylertreat/comcast

Simulating shitty network connections so you can build better systems.
https://github.com/tylertreat/comcast

bandwidth chaos chaos-engineering go latency packet-loss

Last synced: 2 days ago
JSON representation

Simulating shitty network connections so you can build better systems.

Awesome Lists containing this project

README 

        
# Comcast



Testing distributed systems under hard failures like network partitions and instance termination is critical, but it's also important we test them under [less catastrophic conditions](http://www.bravenewgeek.com/sometimes-kill-9-isnt-enough/) because this is what they most often experience. Comcast is a tool designed to simulate common network problems like latency, bandwidth restrictions, and dropped/reordered/corrupted packets.



It works by wrapping up some system tools in a portable(ish) way. On BSD-derived systems such as OSX, we use tools like `ipfw` and `pfctl` to inject failure. On Linux, we use `iptables` and `tc`. Comcast is merely a thin wrapper around these controls. Windows support may be possible with `wipfw` or even the native network stack, but this has not yet been implemented in Comcast and may be at a later date.



## Installation



```

$ go install github.com/tylertreat/comcast@latest

```



## Usage



On Linux, Comcast supports several options: device, latency, target/default bandwidth, packet loss, protocol, and port number.



```

$ comcast --device=eth0 --latency=250 --target-bw=1000 --default-bw=1000000 --packet-loss=10% --target-addr=8.8.8.8,10.0.0.0/24 --target-proto=tcp,udp,icmp --target-port=80,22,1000:2000

```



On OSX, Comcast will check for `pfctl` support (as of Yosemite), which supports the same options as above. If `pfctl` is not available, it will use `ipfw` instead, which supports device, latency, target bandwidth, and packet-loss options.



On BSD (with `ipfw`), Comcast currently supports only: device, latency, target bandwidth, and packet loss. 



```

$ comcast --device=eth0 --latency=250 --target-bw=1000 --packet-loss=10%

```



This will add 250ms of latency, limit bandwidth to 1Mbps, and drop 10% of packets to the targetted (on Linux) destination addresses using the specified protocols on the specified port numbers (slow lane). The default bandwidth specified will apply to all egress traffic (fast lane). To turn this off, run the following:



```

$ comcast --stop

```



By default, comcast will determine the system commands to execute, log them to stdout, and execute them. The `--dry-run` flag will skip execution.



## I don't trust you, this code sucks, I hate Go, etc.



If you don't like running code that executes shell commands for you (despite it being open source, so you can read it and change the code) or want finer-grained control, you can run them directly instead. Read the man pages on these things for more details.



### Linux



On Linux, you can use `iptables` to drop incoming and outgoing packets.



```

$ iptables -A INPUT -m statistic --mode random --probability 0.1 -j DROP

$ iptables -A OUTPUT -m statistic --mode random --probability 0.1 -j DROP

```



Alternatively, you can use `tc` which supports some additional options.



```

$ tc qdisc add dev eth0 root netem delay 50ms 20ms distribution normal

$ tc qdisc change dev eth0 root netem reorder 0.02 duplicate 0.05 corrupt 0.01

```



To reset:



```

$ tc qdisc del dev eth0 root netem

```



### BSD/OSX



To shape traffic in BSD-derived systems, create an `ipfw` pipe and configure it. You can control incoming and outgoing traffic separately for any specific host or network.



```

$ ipfw add 1 pipe 1 ip from me to any

$ ipfw add 2 pipe 1 ip from any to me

$ ipfw pipe 1 config delay 500ms bw 1Mbit/s plr 0.1

```



To reset:



```

$ ipfw delete 1

```



*Note: `ipfw` was removed in OSX Yosemite in favor of `pfctl`.*



## Network Condition Profiles



Here's a list of network conditions with values that you can plug into Comcast. Please add any more that you may come across.



Name | Latency | Bandwidth | Packet-loss

:-- | --: | --: | --:

GPRS (good) | 500 | 50 | 2

EDGE (good) | 300 | 250 | 1.5

3G/HSDPA (good) | 250 | 750 | 1.5

DIAL-UP (good) | 185 | 40 | 2

DSL (poor) | 70 | 2000 | 2

DSL (good) | 40 | 8000 | 0.5

WIFI (good) | 40 | 30000 | 0.2

Starlink | 20 | - | 2.5