Skip to content

Commit

Permalink
Documentation(README): removed few top utils gifs (#158)
Browse files Browse the repository at this point in the history
  • Loading branch information
strizhechenko authored Jul 29, 2017
1 parent 6a7e2be commit 0e2cd24
Showing 1 changed file with 11 additions and 42 deletions.
53 changes: 11 additions & 42 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,44 +50,23 @@ Brief explanation about highlighting colors for CPU and device groups: green and

network-top
~~~~~~~~~~~
Most useful util in this repo that includes all top-like utils and allow to monitor interrupts, soft interrupts, network processing statistic for devices and CPUs.
Most useful util in this repo that includes almost all linux network stack performance metrics and allow to monitor interrupts, soft interrupts, network processing statistic for devices and CPUs. Based on following files:

.. image:: https://cloud.githubusercontent.com/assets/3813830/26570951/acacf18c-452c-11e7-8fe7-5d0952f39d8b.gif
- `/proc/interrupts` (vectors with small amount of irqs/second are hidden by default)
- `/proc/net/softnet_stat` - packet distribution and errors/squeeze rate between CPUs.
- `/proc/softirqs` (only NET_RX and NET_TX values).
- `/sys/class/net/<NET_DEVICE>/statistic/<METRIC>` files (you can specify units, mbits are default)

.. image:: https://user-images.githubusercontent.com/3813830/26898411-4707ebec-4be5-11e7-8013-aff315bc07d0.gif

There are also separate utils if you want to look at only specific metrics: irqtop, softirq-top, softnet-stat-top, link-rate.

snmptop
~~~~~~~
Basic /proc/net/smmp file watcher.

.. image:: https://user-images.githubusercontent.com/3813830/28242466-b51f27dc-69c5-11e7-8076-52819b9b7450.gif

irqtop
~~~~~~
- Show you a rate of interrupts
- based on /proc/interrupts file
- Hides the interrupts with small rate to show a better picture.

.. image:: https://user-images.githubusercontent.com/3813830/26898412-470d2ddc-4be5-11e7-9b57-8bb3248db896.gif

softirq-top
~~~~~~~~~~~
- Show you a rate of receiving/transmitting packets
- Based on /proc/softirqs

.. image:: https://user-images.githubusercontent.com/3813830/26898413-470e6b98-4be5-11e7-8e11-c0caabfb8f5f.gif

link-rate
~~~~~~~~~
- Shows how many packets/bytes network interface receives/transmite and how many errors happened
- Based on /sys/class/net/XXX/statistic/YYY files

.. image:: https://user-images.githubusercontent.com/3813830/26898411-4707ebec-4be5-11e7-8013-aff315bc07d0.gif

softnet-stat-top
~~~~~~~~~~~~~~~~
Shows various statistic of packets processing per CPU.

.. image:: https://user-images.githubusercontent.com/3813830/26898415-4726de3a-4be5-11e7-8003-7b4bb358111c.gif

Tuning
------

Expand Down Expand Up @@ -138,14 +117,9 @@ Example output:
Ring parameters for eth1:
Pre-set maximums:
RX: 4096
RX Mini: 0
RX Jumbo: 0
TX: 4096
...
Current hardware settings:
RX: 256
RX Mini: 0
RX Jumbo: 0
TX: 256
# rx-buffers-increase eth1
Expand All @@ -160,14 +134,9 @@ Example output:
Ring parameters for eth1:
Pre-set maximums:
RX: 4096
RX Mini: 0
RX Jumbo: 0
TX: 4096
...
Current hardware settings:
RX: 2048
RX Mini: 0
RX Jumbo: 0
TX: 256
Hardware and its configuration rating
-------------------------------------
Expand Down

0 comments on commit 0e2cd24

Please sign in to comment.