diff options
| author |   Nathan Skrzypczak <nathan.skrzypczak@gmail.com> | 2021-10-08 14:05:35 +0200 |
|---|---|---|
| committer |   Dave Wallace <dwallacelf@gmail.com> | 2021-10-13 23:22:20 +0000 |
| commit | f47122e07e1ecd0151902a3cabe46c60a99bee8e (patch) | |
| tree | 0c28c0eca2cb17050d6f31fd8f0ca8f78299bf0d /src/plugins/bufmon/bufmon_doc.md | |
| parent | 1e4281223ab4d655b54496ae13fbdb68f867e351 (diff) | |
docs: convert plugins doc md->rst
Type: improvement
Change-Id: I7e821cce1feae229e1be4baeed249b9cca658135
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Diffstat (limited to 'src/plugins/bufmon/bufmon_doc.md')
| -rw-r--r-- | src/plugins/bufmon/bufmon_doc.md | 24 |
1 files changed, 0 insertions, 24 deletions
diff --git a/src/plugins/bufmon/bufmon_doc.md b/src/plugins/bufmon/bufmon_doc.md deleted file mode 100644 index bfa88f40a7d..00000000000 --- a/src/plugins/bufmon/bufmon_doc.md +++ /dev/null @@ -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 -``` |