matthieu/frr
1
0
Fork 0
forked from Mirror/frr
Code Pull requests Activity

doc: document --perf and --perf-options, and a bit of cleanup

Browse source 
Signed-off-by: Christian Hopps <chopps@labn.net>
This commit is contained in:
Christian Hopps 2023-04-23 21:56:38 -04:00
parent e6079f4fa4
commit a3e8e1aacb
1 changed files with 23 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
doc/developer/topotests.rst
View file

@ -296,14 +296,14 @@ Execute single test
.. code:: shell
cd test_to_be_run
./test_to_be_run.py
sudo -E pytest ./test_to_be_run.py
For example, and assuming you are inside the frr directory:
.. code:: shell
cd tests/topotests/bgp_l3vpn_to_bgp_vrf
./test_bgp_l3vpn_to_bgp_vrf.py
sudo -E pytest ./test_bgp_l3vpn_to_bgp_vrf.py
For further options, refer to pytest documentation.
@ -576,6 +576,27 @@ memleak detection is enabled.
sudo -E pytest --valgrind-memleaks all-protocol-startup
Collecting Performance Data using perf(1)
"""""""""""""""""""""""""""""""""""""""""
Topotest can automatically launch any daemon under ``perf(1)`` to collect
performance data. The daemon is run in non-daemon mode with ``perf record -g``.
The ``perf.data`` file will be saved in the router specific directory under the
tests run directoy.
Here's an example of collecting performance data from ``mgmtd`` on router ``r1``
during the config_timing test.
.. code:: console
$ sudo -E pytest --perf=mgmtd,r1 config_timing
...
$ find /tmp/topotests/ -name '*perf.data*'
/tmp/topotests/config_timing.test_config_timing/r1/perf.data
To specify different arguments for ``perf record``, one can use the
``--perf-options`` this will replace the ``-g`` used by default.
.. _topotests_docker:
Running Tests with Docker