Metadata-Version: 2.1
Name: steinloss
Version: 0.1.2
Summary: Package loss measuring tool
Home-page: https://github.com/steinwurf/steinloss
Author: Steinwurf ApS
Author-email: contact@steinwurf.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Framework :: Dash
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: Flask (~=1.1.2)
Requires-Dist: asyncio-dgram (~=1.1.1)
Requires-Dist: dash (~=1.13.4)
Requires-Dist: hurry.filesize (~=0.9)
Requires-Dist: matplotlib
Requires-Dist: pandas (~=1.1.4)
Requires-Dist: plotly (~=4.12.0)

[![time tracker](https://wakatime.com/badge/github/steinwurf/steinloss.svg)](https://wakatime.com/badge/github/steinwurf/steinloss)
![Lint and test](https://github.com/steinwurf/steinloss/workflows/Lint%20and%20test/badge.svg?branch=master)
# Steinloss:
This is a tool for measuring packages loss, between two endpoint, with a web visualizer.

## Usage


## Test
Test made with ip-netns, where a random loss function is set to 1 pct

![setup](media/test_1pct_setup.png)

The results of the test, ended up very close to 1 percent

![results](media/test_1pct.png)

## Demo
|The demo is made for linux|
| --- |
To run a demo of the tool, we're setting up a virtual network on your machine using ip nets.
We're making a network `n1` and `n2` by running
```
sudo sh demo.sh
```

Now we would like to run the server on `n1` and the probe on `n2`
This is done with the following commands in two different terminals:

```bash
sudo ip netns exec ns1 bash -c "sudo -u $USER python3 steinloss py s"
```

```bash
sudo ip netns exec ns2 bash -c "sudo -u $USER python3 steinloss py p"
```
For example:

![](assets/readme/run_demo_1.png)

To access the browser, we to run a browser in our virtual network like so
```bash
sudo ip netns exec ns1 bash -c "sudo -u $USER $BROWSER 127.0.0.1:8050"
```
Like so:

![](assets/readme/browser_n1.png)

Now we can modify the packet loss by using the replace command. To set the packet loss to 20%, we run the following command, while everything is running:
```bash
sudo ip netns exec ns1 tc qdisc replace dev h1 root netem loss 20%
```

The virtual networks can be removed again with:
```bash
sudo ip netns delete ns1 && sudo ip netns delete ns2
```




