From f47122e07e1ecd0151902a3cabe46c60a99bee8e Mon Sep 17 00:00:00 2001 From: Nathan Skrzypczak Date: Fri, 8 Oct 2021 14:05:35 +0200 Subject: docs: convert plugins doc md->rst Type: improvement Change-Id: I7e821cce1feae229e1be4baeed249b9cca658135 Signed-off-by: Nathan Skrzypczak --- src/plugins/bufmon/bufmon_doc.md | 24 ------------------------ src/plugins/bufmon/bufmon_doc.rst | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+), 24 deletions(-) delete mode 100644 src/plugins/bufmon/bufmon_doc.md create mode 100644 src/plugins/bufmon/bufmon_doc.rst (limited to 'src/plugins/bufmon') 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 -``` diff --git a/src/plugins/bufmon/bufmon_doc.rst b/src/plugins/bufmon/bufmon_doc.rst new file mode 100644 index 00000000000..34d5bd35474 --- /dev/null +++ b/src/plugins/bufmon/bufmon_doc.rst @@ -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 -- cgit 1.2.3-korg