mirror of
https://github.com/weaveworks/scope.git
synced 2026-07-16 03:49:52 +00:00
plugins/traffic-control: README
Added simple README to give an overview of the plugin. Also the value of the latency controls were changed.
This commit is contained in:
17
examples/plugins/traffic-control/README.md
Normal file
17
examples/plugins/traffic-control/README.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Traffic Control Plugin
|
||||
|
||||
The Traffic Control plugin allows to modify the performance parameters of container's network interfaces. The following images show a simple example of how **status** and **controls** are displayed in scope UI.
|
||||
|
||||
<img src="imgs/container_view.png" width="200" alt="Scope Probe plugin screenshot" align="center">
|
||||
|
||||
## Visualization
|
||||
|
||||
The parameters are shown in a table named **Traffic Control**. The plugin shows the values of latency and packet loss that are enforced on the network interface. The "-" mean that no value is set for that parameter, latency is displayed in *milliseconds* (ms) and packet loss in *percentage*.
|
||||
|
||||
## Controls
|
||||
|
||||
The Traffic Controls plugin provides a simple interface to change the value of latency (hourglass buttons) and packet loss (scissor button) or remove value that was set (circled cross button). Such buttons are displayed on the top of the container detailed view, just above the STATUS section (See picture below, control are shown inside the red rectangle).
|
||||
|
||||
<img src="imgs/controls.png" width="400" alt="Scope Probe plugin screenshot" align="center">
|
||||
|
||||
The *hourglass* buttons control the latency value, from left to right they set: 2000ms, 1000ms, and 500ms. The *scissor* button controls the packet loss value, it set a 10% packet loss. The *circled cross* button clear any previous settings.
|
||||
BIN
examples/plugins/traffic-control/imgs/container_view.png
Normal file
BIN
examples/plugins/traffic-control/imgs/container_view.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 145 KiB |
BIN
examples/plugins/traffic-control/imgs/controls.png
Normal file
BIN
examples/plugins/traffic-control/imgs/controls.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 49 KiB |
@@ -251,7 +251,7 @@ func getLatencyControls() []extControl {
|
||||
Rank: 21,
|
||||
},
|
||||
handler: func(pid int) error {
|
||||
return DoTrafficControl(pid, "300ms", "")
|
||||
return DoTrafficControl(pid, "1000ms", "")
|
||||
},
|
||||
},
|
||||
{
|
||||
@@ -262,7 +262,7 @@ func getLatencyControls() []extControl {
|
||||
Rank: 22,
|
||||
},
|
||||
handler: func(pid int) error {
|
||||
return DoTrafficControl(pid, "1ms", "")
|
||||
return DoTrafficControl(pid, "500ms", "")
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user