diff options
| author | Ivan Yelizariev <iel@odoo.com> | 2021-04-12 08:39:44 +0000 |
|---|---|---|
| committer | Ivan Yelizariev <iel@odoo.com> | 2021-04-12 08:52:00 +0000 |
| commit | 9864fb6a159f5f145421b4e51b6125e25a69e7c9 (patch) | |
| tree | 8e2ab155585e245e690ae591eeb8129438e83122 /doc | |
| parent | 80c28189ae6b10ad17c4de2a781233a8ffe663a6 (diff) | |
[IMP] doc: replace pyflame with py-spy
pyflame is archived and not maintained since July 2018
https://github.com/uber-archive/pyflame/commits/master
closes odoo/odoo#69109
Signed-off-by: Adrian Torres (adt) <adt@odoo.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/howtos/profilecode.rst | 41 |
1 files changed, 20 insertions, 21 deletions
diff --git a/doc/howtos/profilecode.rst b/doc/howtos/profilecode.rst index 3519cadd299..dcb86338c8a 100644 --- a/doc/howtos/profilecode.rst +++ b/doc/howtos/profilecode.rst @@ -91,42 +91,41 @@ Tracing code execution ====================== Instead of sending the SIGQUIT signal to an Odoo process often enough, to check -where the processes are performing worse than expected, we can use the pyflame tool to +where the processes are performing worse than expected, we can use the `py-spy`_ tool to do it for us. -Install pyflame and flamegraph ------------------------------- +Install py-spy +-------------- .. code:: bash - # These instructions are given for Debian/Ubuntu distributions - sudo apt install autoconf automake autotools-dev g++ pkg-config python-dev python3-dev libtool make - git clone https://github.com/uber/pyflame.git - git clone https://github.com/brendangregg/FlameGraph.git - cd pyflame - ./autogen.sh - ./configure - make - sudo make install + python3 -m pip install py-spy Record executed code -------------------- -As pyflame is installed, we now record the executed code lines with pyflame. +As py-spy is installed, we now record the executed code lines. This tool will record, multiple times a second, the stacktrace of the process. -Once done, we'll display them as an execution graph. .. code:: bash - pyflame --exclude-idle -s 3600 -r 0.2 -p <PID> -o test.flame + # record to raw file + py-spy record -o profile.json -f speedscope --pid <PID> -where <PID> is the process ID of the odoo process you want to graph. This will -wait until the dead of the process, with a maximum of one hour, and and get 5 -traces a second. With the output of pyflame, we can produce an SVG graph with -the flamegraph tool: + # OR record directly to svg + py-spy record -o profile.svg --pid <PID> -.. code:: bash +where <PID> is the process ID of the odoo process you want to graph. + +To open profile.json you can use online tool `speedscope.app`_. + +To open profile.svg you should use browser, because other viewer may not +support interactive part. - flamegraph.pl ./test.flame > ~/mycode.svg .. image:: profile/flamegraph.svg + + +.. _py-spy: https://github.com/benfred/py-spy + +.. _speedscope.app: https://www.speedscope.app/ |