docs: convert plugins doc md->rst
Type: improvement Change-Id: I7e821cce1feae229e1be4baeed249b9cca658135 Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
This commit is contained in:

committed by
Dave Wallace

parent
1e4281223a
commit
f47122e07e
@@ -1,24 +0,0 @@
|
||||
# Buffers monitoring plugin {#bufmon_doc}
|
||||
|
||||
This plugin enables to track buffer utilization in the VPP graph nodes. The
|
||||
main use is to detect buffer leakage.
|
||||
It works by keeping track of number of buffer allocations and free in graph
|
||||
nodes and also of number of buffers received in input frames and in output
|
||||
frames.
|
||||
The formula to compute the number of "buffered" buffers in a node is simply:
|
||||
#buffered = #alloc + #input - #free - #output
|
||||
Note: monitoring will impact performances.
|
||||
|
||||
## Basic usage
|
||||
1. Turn buffer traces on:
|
||||
```
|
||||
~# vppctl set buffer traces on
|
||||
```
|
||||
2. Monitor buffer usage:
|
||||
```
|
||||
~# vppctl show buffer traces verbose
|
||||
```
|
||||
3. Turn buffer traces off:
|
||||
```
|
||||
~# vppctl set buffer traces off
|
||||
```
|
33
src/plugins/bufmon/bufmon_doc.rst
Normal file
33
src/plugins/bufmon/bufmon_doc.rst
Normal file
@@ -0,0 +1,33 @@
|
||||
.. _bufmon_doc:
|
||||
|
||||
Buffers monitoring plugin
|
||||
=========================
|
||||
|
||||
This plugin enables to track buffer utilization in the VPP graph nodes.
|
||||
The main use is to detect buffer leakage. It works by keeping track of
|
||||
number of buffer allocations and free in graph nodes and also of number
|
||||
of buffers received in input frames and in output frames. The formula to
|
||||
compute the number of “buffered” buffers in a node is simply: #buffered
|
||||
= #alloc + #input - #free - #output Note: monitoring will impact
|
||||
performances.
|
||||
|
||||
Basic usage
|
||||
-----------
|
||||
|
||||
1. Turn buffer traces on:
|
||||
|
||||
::
|
||||
|
||||
~# vppctl set buffer traces on
|
||||
|
||||
2. Monitor buffer usage:
|
||||
|
||||
::
|
||||
|
||||
~# vppctl show buffer traces verbose
|
||||
|
||||
3. Turn buffer traces off:
|
||||
|
||||
::
|
||||
|
||||
~# vppctl set buffer traces off
|
Reference in New Issue
Block a user