zuul
/
zuul
Code Issues Proposed changes

Merge "Add notes on thread dumping and yappi"

This commit is contained in:
Zuul 2020-01-18 08:37:26 +00:00 committed by Gerrit Code Review
parent 5ef1de5cb4 3375209402
commit 194d311b8b
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/source/howtos/troubleshooting.rst
View File

@ -39,3 +39,21 @@ form ``FUNCTION\tTOTAL\tRUNNING\tAVAILABLE_WORKERS``::
zuul:tenant_sql_connection 0 0 1
executor:resume:ze09.openstack.org 0 0 1
...
Thread Dumps and Profiling
==========================
If you send a SIGUSR2 to one of the daemon processes, it will dump a
stack trace for each running thread into its debug log. It is written
under the log bucket ``zuul.stack_dump``. This is useful for tracking
down deadlock or otherwise slow threads::
sudo kill -USR2 `cat /var/run/zuul/executor.pid`
view /var/log/zuul/executor-debug.log +/zuul.stack_dump
When `yappi <https://code.google.com/p/yappi/>`_ (Yet Another Python
Profiler) is available, additional functions' and threads' stats are
emitted as well. The first SIGUSR2 will enable yappi, on the second
SIGUSR2 it dumps the information collected, resets all yappi state and
stops profiling. This is to minimize the impact of yappi on a running
system.