src/plugins/bufmon/bufmon_doc.md

   1 # Buffers monitoring plugin {#bufmon_doc}
   2
   3 This plugin enables to track buffer utilization in the VPP graph nodes. The
   4 main use is to detect buffer leakage.
   5 It works by keeping track of number of buffer allocations and free in graph
   6 nodes and also of number of buffers received in input frames and in output
   7 frames.
   8 The formula to compute the number of "buffered" buffers in a node is simply:
   9         #buffered = #alloc + #input - #free - #output
  10 Note: monitoring will impact performances.
  11
  12 ## Basic usage
  13 1. Turn buffer traces on:
  14 ```
  15 ~# vppctl set buffer traces on
  16 ```
  17 2. Monitor buffer usage:
  18 ```
  19 ~# vppctl show buffer traces verbose
  20 ```
  21 3. Turn buffer traces off:
  22 ```
  23 ~# vppctl set buffer traces off
  24 ```