显示正在运行的 Python 应用程序的堆栈跟踪

Question

我有一个 Python 应用程序，它时不时地卡住，而且我不知道在哪里。

有什么方法可以向 Python 解释器发出信号，向您显示正在运行的确切代码吗？

某种即时堆栈跟踪？

相关问题

• 从 Python 代码中的方法打印当前调用堆栈
• 检查正在运行的进程正在做什么：打印未检测的 Python 程序的堆栈跟踪

Answer 1

我几乎总是处理多个线程，而主线程通常不做太多事情，所以最有趣的是转储所有堆栈（这更像是Java的转储）。 以下是基于此博客的实现：

import threading, sys, traceback

def dumpstacks(signal, frame):
    id2name = dict([(th.ident, th.name) for th in threading.enumerate()])
    code = []
    for threadId, stack in sys._current_frames().items():
        code.append("\n# Thread: %s(%d)" % (id2name.get(threadId,""), threadId))
        for filename, lineno, name, line in traceback.extract_stack(stack):
            code.append('File: "%s", line %d, in %s' % (filename, lineno, name))
            if line:
                code.append("  %s" % (line.strip()))
    print("\n".join(code))

import signal
signal.signal(signal.SIGQUIT, dumpstacks)

Answer 2

获取一个未准备的Python程序的堆栈跟踪，在一个库存Python中运行没有调试符号可以通过黄铁矿。 在 Ubuntu Trusty 上对我来说就像一个魅力：（

$ sudo pip install pyrasite
$ echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope
$ sudo pyrasite 16262 dump_stacks.py # dumps stacks to stdout/stderr of the python program

向 @Albert 致敬，他的答案包含了指向这个的指针以及其他工具。）

Answer 3

安装信号处理程序的建议很好，我经常使用它。 例如，bzr 默认情况下会安装一个调用 pdb.set_trace() 的 SIGQUIT 处理程序立即将您带入 pdb 提示符。 （请参阅 bzrlib.breakin< /a> 模块的源代码以获取确切的详细信息。）使用 pdb，您不仅可以获得当前的堆栈跟踪（使用 (w)here 命令），还可以检查变量等。

但是，有时我需要调试一个我没有先见之明安装信号处理程序的进程。在 Linux 上，您可以将 gdb 附加到进程并使用一些 gdb 宏获取 python 堆栈跟踪。 把 http://svn.python.org/projects/python/trunk/Misc/ gdbinit 位于 ~/.gdbinit 中，然后：

• Attach gdb: gdb -p PID
• 获取python 堆栈跟踪：

不幸的是，它并不完全可靠，但它在大多数情况下都有效。 另请参阅 https://wiki.python.org/moin/DebuggingWithGdb

最后，附加 strace 通常可以让您很好地了解进程正在做什么。

Answer 4

>>> import traceback
>>> def x():
>>>    print traceback.extract_stack()

>>> x()
[('<stdin>', 1, '<module>', None), ('<stdin>', 2, 'x', None)]

您还可以很好地格式化堆栈跟踪，请参阅文档。

编辑：要按照 @Douglas Leeder 的建议模拟 Java 的行为，请将以下内容添加

import signal
import traceback

signal.signal(signal.SIGUSR1, lambda sig, stack: traceback.print_stack(stack))

到应用程序的启动代码中。 然后，您可以通过向正在运行的 Python 进程发送 SIGUSR1 来打印堆栈。

Answer 5

这可以通过优秀的 py-spy 来完成。 它是 Python 程序的采样分析器，因此它的工作是附加到 Python 进程并对其调用堆栈进行采样。 因此，您只需使用 py-spy dump --pid $SOME_PID 即可转储 $SOME_PID 进程中所有线程的调用堆栈。 通常它需要升级权限（以读取目标进程的内存）。

下面是一个线程 Python 应用程序的示例。

$ sudo py-spy dump --pid 31080
Process 31080: python3.7 -m chronologer -e production serve -u www-data -m
Python v3.7.1 (/usr/local/bin/python3.7)

Thread 0x7FEF5E410400 (active): "MainThread"
    _wait (cherrypy/process/wspbus.py:370)
    wait (cherrypy/process/wspbus.py:384)
    block (cherrypy/process/wspbus.py:321)
    start (cherrypy/daemon.py:72)
    serve (chronologer/cli.py:27)
    main (chronologer/cli.py:84)
    <module> (chronologer/__main__.py:5)
    _run_code (runpy.py:85)
    _run_module_as_main (runpy.py:193)
Thread 0x7FEF55636700 (active): "_TimeoutMonitor"
    run (cherrypy/process/plugins.py:518)
    _bootstrap_inner (threading.py:917)
    _bootstrap (threading.py:885)
Thread 0x7FEF54B35700 (active): "HTTPServer Thread-2"
    accept (socket.py:212)
    tick (cherrypy/wsgiserver/__init__.py:2075)
    start (cherrypy/wsgiserver/__init__.py:2021)
    _start_http_thread (cherrypy/process/servers.py:217)
    run (threading.py:865)
    _bootstrap_inner (threading.py:917)
    _bootstrap (threading.py:885)
...
Thread 0x7FEF2BFFF700 (idle): "CP Server Thread-10"
    wait (threading.py:296)
    get (queue.py:170)
    run (cherrypy/wsgiserver/__init__.py:1586)
    _bootstrap_inner (threading.py:917)
    _bootstrap (threading.py:885)  

Answer 6

您可以尝试faulthandler 模块。 使用 pip install failurehandler 安装它并

import faulthandler, signal
faulthandler.register(signal.SIGUSR1)

在程序开头添加：。 然后将 SIGUSR1 发送到您的进程（例如：kill -USR1 42）以将所有线程的 Python 回溯显示到标准输出。 阅读文档以获取更多选项（例如：登录到文件）以及显示回溯的其他方法。

该模块现在是 Python 3.3 的一部分。 对于 Python 2，请参阅 http://faulthandler.readthedocs.org/

Answer 7

traceback 模块有一些不错的功能，其中他们： print_stack：

import traceback

traceback.print_stack()

Answer 8

您可以使用 PuDB（带有 curses 接口的 Python 调试器）来执行此操作。 只需添加

from pudb import set_interrupt_handler; set_interrupt_handler()

到您的代码中并在您想要中断时使用 Ctrl-C 即可。 如果您错过了并想重试，可以使用 c 继续并多次中断。

Answer 9

pyringe 是一个调试器，可以与正在运行的 python 进程交互、打印堆栈跟踪、变量等，无需任何操作先验设置。

虽然我过去经常使用信号处理程序解决方案，但在某些环境中重现问题通常仍然很困难。

Answer 10

从 Austin 3.3 开始，您可以使用 -w/--where 选项发出当前堆栈跟踪。 请参阅 https://stackoverflow.com/a/70905181/1838793

如果您想要查看正在运行的 Python 应用程序，以类似顶部的方式查看“实时”调用堆栈，您可以使用 austin-tui (https://github.com/p403n1x87/austin-tui）。 您可以使用例如从 PyPI 安装它，请

pipx install austin-tui

注意，它需要 austin 二进制文件才能工作（https://github.com/ p403n1x87/austin），但是你可以使用以下命令附加到正在运行的 Python 进程

austin-tui -p <pid>

Answer 11

我编写了一些工具，将其附加到正在运行的 Python 进程中，并注入一些代码来获取 Python shell。

请参阅此处：https://github.com/albertz/pydbattach

Answer 12

值得一看 Pydb，“松散地基于 gdb 命令集的 Python 调试器的扩展版本”。 它包括信号管理器，可以在发送指定信号时负责启动调试器。

2006 年 Summer of Code 项目着眼于在名为 的模块中向 pydb 添加远程调试功能mpdb。

Answer 13

我一直在寻找一个解决方案来调试我的线程，多亏了haridsv，我在这里找到了它。 我使用稍微简化的版本，使用traceback.print_stack()：

import sys, traceback, signal
import threading
import os

def dumpstacks(signal, frame):
  id2name = dict((th.ident, th.name) for th in threading.enumerate())
  for threadId, stack in sys._current_frames().items():
    print(id2name[threadId])
    traceback.print_stack(f=stack)

signal.signal(signal.SIGQUIT, dumpstacks)

os.killpg(os.getpgid(0), signal.SIGQUIT)

根据我的需要，我还按名称过滤线程。

Answer 14

如果您使用的是 Linux 系统，请将 gdb 的强大功能与 Python 调试扩展结合使用（可以位于 python-dbg 或 python-debuginfo 中）包裹）。 它还有助于多线程应用程序、GUI 应用程序和 C 模块。

运行您的程序：

$ gdb -ex r --args python <programname>.py [arguments]

这指示 gdb 准备 python .py 并run 它。

现在，当您的程序挂起时，切换到 gdb 控制台，按 Ctr+C 并执行：

(gdb) thread apply all py-list

请参阅 示例会话和更多信息此处 和此处。

Answer 15

在 Solaris 上，您可以使用 pstack(1) 无需更改 python 代码。 例如。

# pstack 16000 | grep : | head
16000: /usr/bin/python2.6 /usr/lib/pkg.depotd --cfg svc:/application/pkg/serv
[ /usr/lib/python2.6/vendor-packages/cherrypy/process/wspbus.py:282 (_wait) ]
[ /usr/lib/python2.6/vendor-packages/cherrypy/process/wspbus.py:295 (wait) ]
[ /usr/lib/python2.6/vendor-packages/cherrypy/process/wspbus.py:242 (block) ]
[ /usr/lib/python2.6/vendor-packages/cherrypy/_init_.py:249 (quickstart) ]
[ /usr/lib/pkg.depotd:890 (<module>) ]
[ /usr/lib/python2.6/threading.py:256 (wait) ]
[ /usr/lib/python2.6/Queue.py:177 (get) ]
[ /usr/lib/python2.6/vendor-packages/pkg/server/depot.py:2142 (run) ]
[ /usr/lib/python2.6/threading.py:477 (run)
etc.

Answer 16

真正对我有帮助的是 spiv 的提示 （如果我有声誉点，我会投票并发表评论）从未准备的Python进程中获取堆栈跟踪。 但直到我 修改 gdbinit 脚本。 所以：

• 下载https://svn.python.org/projects/ python/trunk/Misc/gdbinit 并将其放入 ~/.gdbinit

• 编辑它，将 PyEval_EvalFrame 更改为 PyEval_EvalFrameEx [编辑：不再需要； 截至 2010 年 1 月 14 日，链接文件已进行此更改]

• 附加 gdb：gdb -p PID

• 获取 python 堆栈跟踪：pystack

Answer 17

python -dv yourscript.py

这将使解释器在调试模式下运行，并让您跟踪解释器正在做什么。

如果你想交互式地调试代码，你应该像这样运行它：

python -m pdb yourscript.py

这告诉 python 解释器使用模块“pdb”运行你的脚本，该模块是 python 调试器，如果你像这样运行它，解释器将以交互模式执行，就像 GDB 一样

Answer 18

我会将其作为评论添加到 haridsv 的响应，但我缺乏这样做的声誉：

我们中的一些人仍然停留在 2.6 之前的 Python 版本上（Thread.ident 需要），所以我让代码在 Python 2.5 中工作（尽管没有线程名称）显示）如下：

import traceback
import sys
def dumpstacks(signal, frame):
    code = []
    for threadId, stack in sys._current_frames().items():
            code.append("\n# Thread: %d" % (threadId))
        for filename, lineno, name, line in traceback.extract_stack(stack):
            code.append('File: "%s", line %d, in %s' % (filename, lineno, name))
            if line:
                code.append("  %s" % (line.strip()))
    print "\n".join(code)

import signal
signal.signal(signal.SIGQUIT, dumpstacks)

Answer 19

看一下 faulthandler 模块， Python 3.3 中的新功能。 PyPI 上提供了用于 Python 2 的 faulthandler 向后移植。

Answer 20

您可以使用 hypno 包，如下所示：

hypno <pid> "import traceback; traceback.print_stack()"

这会将堆栈跟踪打印到程序的标准输出中。

或者，如果您不想将任何内容打印到标准输出，或者您无权访问它（例如守护进程），您可以使用 madbg 包，它是一个 python 调试器，允许您附加到正在运行的 python 程序并在当前终端中对其进行调试。 它类似于 pyrasite 和 pyringe，但更新，不需要 gdb，并使用 IPython 作为调试器（这意味着颜色和自动完成） ）。

要查看正在运行的程序的堆栈跟踪，您可以运行：

madbg attach <pid>

在调试器 shell 中输入：
bt

免责声明 - 这两个包都是我写的

Answer 21

我属于 GDB 阵营，有 python 扩展。 关注 https://wiki.python.org/moin/DebuggingWithGdb，即

1. dnf install gdb python-debuginfo 或 sudo apt-get install gdb python2.7-dbg
2. gdb python <运行进程的pid>
3. py- bt

还要考虑信息线程 和线程应用所有py-bt。

Answer 22

如何在控制台中调试任何函数：

创建函数，在其中使用 pdb.set_trace()，然后调用您想要调试的函数。

>>> import pdb
>>> import my_function

>>> def f():
...     pdb.set_trace()
...     my_function()
... 

然后调用创建的函数：

>>> f()
> <stdin>(3)f()
(Pdb) s
--Call--
> <stdin>(1)my_function()
(Pdb) 

快乐调试:)

Answer 23

如果您需要使用 uWSGI 执行此操作，它内置了 Python Tracebacker -in ，只需在配置中启用它即可（数字附加到每个工作人员的名称上）：

py-tracebacker=/var/run/uwsgi/pytrace

完成此操作后，您可以通过连接到套接字来简单地打印回溯：

uwsgi --connect-and-read /var/run/uwsgi/pytrace1

Answer 24

使用检查模块。

<块引用>
<块引用>

导入检查
帮助（检查.stack）
模块检查中函数堆栈的帮助：

stack(context=1)
返回调用者框架上方堆栈的记录列表。

我发现它确实非常有帮助。

Answer 25

在 Python 3 中，第一次在调试器中使用 c(ont(inue)) 时，pdb 将自动安装信号处理程序。 之后按 Control-C 会让你回到那里。 在 Python 2 中，这里有一个单行代码，即使在相对较旧的版本中也应该可以工作（在 2.7 中进行了测试，但我检查了 Python 源代码回到 2.4，它看起来还不错）：

import pdb, signal
signal.signal(signal.SIGINT, lambda sig, frame: pdb.Pdb().set_trace(frame))

如果您花大量时间调试 Python，pdb 是值得学习的。 该界面有点迟钝，但使用过类似工具（例如 gdb）的任何人都应该熟悉。

Answer 26

我不知道有什么类似于 java 对 SIGQUIT 的响应，因此您可能必须将其构建到您的应用程序中。 也许您可以在另一个线程中创建一个服务器，该服务器可以获得对某种消息的响应的堆栈跟踪？

Answer 27

没有办法挂钩正在运行的 python 进程并获得合理的结果。 如果进程锁定，我要做的就是连接 strace 并尝试找出到底发生了什么。

不幸的是，strace 通常是“修复”竞争条件的观察者，因此输出在那里也毫无用处。

Answer 28

在代码运行时，您可以插入这个小片段来查看格式良好的打印堆栈跟踪。 它假设您的项目根目录中有一个名为 logs 的文件夹。

# DEBUG: START DEBUG -->
import traceback

with open('logs/stack-trace.log', 'w') as file:
    traceback.print_stack(file=file)
# DEBUG: END DEBUG --!

Answer 29

我有一个用于这种情况的模块 - 一个进程将运行很长时间，但有时会因未知和不可重现的原因而卡住。 它有点hacky，并且仅适用于unix（需要信号）：

import code, traceback, signal

def debug(sig, frame):
    """Interrupt running process, and provide a python prompt for
    interactive debugging."""
    d={'_frame':frame}         # Allow access to frame object.
    d.update(frame.f_globals)  # Unless shadowed by global
    d.update(frame.f_locals)

    i = code.InteractiveConsole(d)
    message  = "Signal received : entering python shell.\nTraceback:\n"
    message += ''.join(traceback.format_stack(frame))
    i.interact(message)

def listen():
    signal.signal(signal.SIGUSR1, debug)  # Register handler

要使用，只需在程序启动时调用listen()函数（您甚至可以将其粘贴在site.py中以使所有python程序都使用它），然后让它运行。 在任何时候，使用kill或在python中向进程发送SIGUSR1信号：

    os.kill(pid, signal.SIGUSR1)

这将导致程序在当前所在的位置中断到python控制台，向您显示堆栈跟踪，并让您操作变量。 使用 control-d (EOF) 继续运行（但请注意，您可能会在发出信号时中断任何 I/O 等，因此它并不是完全非侵入性的。

我有另一个脚本可以执行相同的操作，除了它通过管道与正在运行的进程进行通信（以允许调试后台进程等）之外，在此处发布它有点大，但我已将其添加为 Python 食谱。