From d0f06265e0f0b096593aecfb14fe53c4bffd3229 Mon Sep 17 00:00:00 2001 From: Antoine Musso Date: Wed, 4 Jun 2014 09:54:24 +0200 Subject: [PATCH] Document usage of yappi profiler ff4eeec introduced support for yappi, a python profiler, which is used when generating stack dumps (via SIGUSR2). The commit forgot to update the related documentation. Change-Id: Iee1d680cf7b2df4c702666aaf778991c696c3274 --- doc/source/zuul.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/source/zuul.rst b/doc/source/zuul.rst index 6cb5d59027..9c5b8e0a7b 100644 --- a/doc/source/zuul.rst +++ b/doc/source/zuul.rst @@ -1045,3 +1045,10 @@ recheck changes for the gate and check pipelines respectively:: If you send a SIGUSR2 to the zuul-server process, Zuul will dump a stack trace for each running thread into its debug log. This is useful for tracking down deadlock or otherwise slow threads. + +When `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.