From 7b8942a648b4f5189ee774f72de6d0b917a88d9f Mon Sep 17 00:00:00 2001 From: Pablo Hoffman Date: Thu, 16 Feb 2012 15:14:17 -0200 Subject: [PATCH] updated StackTraceDump extension doc --- docs/topics/extensions.rst | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/topics/extensions.rst b/docs/topics/extensions.rst index b227fa493..d00bfdc01 100644 --- a/docs/topics/extensions.rst +++ b/docs/topics/extensions.rst @@ -370,18 +370,22 @@ Stack trace dump extension .. class:: scrapy.contrib.debug.StackTraceDump -Dumps the stack trace and Scrapy engine status of a runnning process when a -`SIGQUIT`_ or `SIGUSR2`_ signal is received. After the stack trace and engine -status is dumped, the Scrapy process continues running normally. +Dumps information about the running process when a `SIGQUIT`_ or `SIGUSR2`_ +signal is received. The information dumped is the following: -The dump is sent to standard output. +1. engine status (using ``scrapy.utils.engine.get_engine_status()``) +2. live references (see :ref:`topics-leaks-trackrefs`) +3. stack trace of all threads -This extension only works on POSIX-compliant platforms (ie. not Windows). +After the stack trace and engine status is dumped, the Scrapy process continues +running normally. + +This extension only works on POSIX-compliant platforms (ie. not Windows), +because the `SIGQUIT`_ and `SIGUSR2`_ signals are not available on Windows. There are at least two ways to send Scrapy the `SIGQUIT`_ signal: 1. By pressing Ctrl-\ while a Scrapy process is running (Linux only?) - 2. By running this command (assuming ```` is the process id of the Scrapy process)::