実行中のPythonアプリケーションからのスタックトレースの表示

このPythonアプリケーションがときどき動かなくなり、どこにあるのかわかりません。

実行中の正確なコードを表示するようにPythonインタープリターに通知する方法はありますか？

ある種のオンザフライのスタックトレース？

関連する質問：

• Pythonコードのメソッドから現在の呼び出しスタックを出力する
• 実行中のプロセスが何をしているかを確認する：計装されていないPythonプログラムのスタックトレースを出力する

私はこのような状況で使用するモジュールを持っています-プロセスが長時間実行されますが、未知の再現不可能な理由で時々スタックします。これは少しハックで、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（）関数を呼び出し（すべてのpythonプログラムに使用させるために、この関数をsite.pyに貼り付けることもできます）、それを実行させます。いつでも、プロセスにkillを使用して、またはpythonでSIGUSR1シグナルを送信します。

    os.kill(pid, signal.SIGUSR1)

これにより、プログラムが現在のポイントでpythonコンソールにブレークし、スタックトレースが表示され、変数を操作できるようになります。実行を継続するには、control-d（EOF）を使用します（ただし、通知した時点でI / Oなどを中断する可能性があるため、完全に非侵入型ではありません）。

同じことを行う別のスクリプトがありますが、パイプを介して実行中のプロセスと通信します（バックグラウンドプロセスのデバッグを可能にするためなど）。ここに投稿するには少し大きいですが、私はそれをpythonクックブックのレシピとして追加しました。

シグナルハンドラをインストールするという提案は良いものであり、私はそれを頻繁に使用しています。たとえば、bzrはデフォルトでSIGQUITハンドラーをインストールpdb.set_trace()し、pdbプロンプトにすぐに移動します。（正確な詳細については、bzrlib.breakinモジュールのソースを参照してください。）pdbを使用すると、現在のスタックトレースを取得できるだけでなく、変数なども検査できます。

ただし、シグナルハンドラーをインストールするための洞察力のないプロセスをデバッグする必要がある場合があります。Linuxでは、gdbをプロセスにアタッチして、いくつかのgdbマクロを使用してpythonスタックトレースを取得できます。http://svn.python.org/projects/python/trunk/Misc/gdbinitをに入れて~/.gdbinitから、

• gdbをアタッチします。 gdb -p PID
• Pythonスタックトレースを取得します。 pystack

残念ながら完全に信頼できるわけではありませんが、ほとんどの場合機能します。

最後に、アタッチstraceすることで、プロセスが何をしているのかをよく知ることができます。

私はほとんど常に複数のスレッドを扱っており、メインスレッドは一般的にあまり機能しません。そのため、最も興味深いのは、すべてのスタックをダンプすることです（これは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)

スタックトレースの取得準備ができていない株式pythonで実行されている、Pythonプログラムをシンボルデバッグなしで行うことができますpyrasiteを。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へのヒントには、これへのポインタが含まれていました。）

>>> 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))

アプリケーションのスタートアップコードに追加します。次にSIGUSR1、実行中のPythonプロセスに送信してスタックを印刷できます。

トレースバックモジュールは、それらの間で、いくつかの素晴らしい機能を持っていますprint_stackを：

import traceback

traceback.print_stack()

faulthandlerモジュールを試すことができます。を使用してインストールしpip install faulthandler、追加します。

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

プログラムの始めに。次に、SIGUSR1をプロセス（例：）に送信してkill -USR1 42、すべてのスレッドのPythonトレースバックを標準出力に表示します。その他のオプション（例：ファイルへのログイン）およびトレースバックを表示するその他の方法については、ドキュメントを参照してください。

モジュールはPython 3.3の一部になりました。Python 2の場合は、http：//faulthandler.readthedocs.org/を参照してください。

ここで私を本当に助けたのは、準備されていない Pythonプロセスからスタックトレースを取得するためのspivのヒント（評判ポイントがある場合は投票してコメントする）です。ただし、gdbinitスクリプトを変更するまで機能しませんでした。そう：

• http://svn.python.org/projects/python/trunk/Misc/gdbinitをダウンロードして、~/.gdbinit

• 変更、それを編集PyEval_EvalFrameしますPyEval_EvalFrameEx[編集：もう必要ありません。リンクされたファイルには2010-01-14の時点ですでにこの変更があります]

• gdbをアタッチします。 gdb -p PID

• Pythonスタックトレースを取得します。 pystack

これをコメントとして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)

python -dv yourscript.py

これにより、インタープリターがデバッグモードで実行され、インタープリターが行っていることのトレースが得られます。

コードをインタラクティブにデバッグする場合は、次のように実行する必要があります。

python -m pdb yourscript.py

これは、Pythonインタープリターに、Pythonデバッガーであるモジュール「pdb」を使用してスクリプトを実行するように指示します。インタープリターがGDBのように対話モードで実行されるように実行すると、

faulthandlerPython 3.3の新しいモジュールを見てください。Python 2で使用するためのfaulthandlerバックポートがPyPIで利用可能です。

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.

Linuxシステムを使用している場合はgdb、Pythonデバッグ拡張機能のの素晴らしさを使用してください（python-dbgまたはpython-debuginfoパッケージ化することができます）。また、マルチスレッドアプリケーション、GUIアプリケーション、Cモジュールにも役立ちます。

以下を使用してプログラムを実行します。

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

これはgdb、準備python <programname>.py <arguments>してr解除するように指示します。

プログラムがハングしたら、gdbコンソールに切り替え、押しCtr+Cて実行します。

(gdb) thread apply all py-list

こことここで、サンプルセッションと詳細を参照してください。

私はスレッドをデバッグするための解決策をしばらく探していましたが、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)

必要に応じて、スレッドを名前でフィルタリングします。

「gdbコマンドセットに大まかに基づいたPythonデバッガーの拡張バージョン」であるPydbは一見の価値があります。これには、指定された信号が送信されたときにデバッガーを起動する処理を行うことができる信号マネージャーが含まれます。

2006年夏のコードのプロジェクトと呼ばれるモジュールにpydbにリモートデバッグ機能を追加して見mpdb。

実行中のPythonプロセスに接続し、コードを挿入してPythonシェルを取得するツールをハッキングしました。

こちらをご覧ください：https : //github.com/albertz/pydbattach

これは、優れた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)  

pyringeは、事前の設定なしで、実行中のpythonプロセス、スタックトレース、変数などを印刷できるデバッガです。

過去にシグナルハンドラーソリューションを頻繁に使用しましたが、特定の環境で問題を再現するのが難しい場合もあります。

実行中のpythonプロセスにフックして妥当な結果を得る方法はありません。プロセスがロックアップした場合の対処方法は、straceをフックして、何が起こっているのかを正確に把握しようとすることです。

残念なことに、straceは、競合状態を「修正」して出力がそこでも役に立たないようにするオブザーバーであることがよくあります。

これを行うには、cursesインターフェースを備えたPythonデバッガーであるPuDBを使用できます。追加するだけ

from pudb import set_interrupt_handler; set_interrupt_handler()

あなたのコードにあなたがブレークしたいときにCtrl-Cを使用してください。c見逃して再試行したい場合は、続行して何度も中断できます。

私はPython拡張機能を使ってGDBキャンプにいます。フォローhttps://wiki.python.org/moin/DebuggingWithGdb、手段

1. dnf install gdb python-debuginfo または sudo apt-get install gdb python2.7-dbg
2. gdb python <pid of running process>
3. py-bt

も考慮info threadsしてくださいthread apply all py-bt。

コンソールで関数をデバッグする方法：

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) 

幸せなデバッグ:)

私はSIGQUITに対するjavaの応答に似たものを知りません。そのため、アプリケーションに組み込む必要があるかもしれません。たぶん、ある種のメッセージへの応答でスタックトレースを取得できる別のスレッドでサーバーを作成できますか？

inspectモジュールを使用します。

import inspect help（inspect.stack）help in function stack in module inspect：

stack（context = 1）呼び出し元のフレームの上のスタックのレコードのリストを返します。

本当に助かります。

Python 3では、デバッガーでc（ont（inue））を初めて使用するときに、pdbが自動的にシグナルハンドラーをインストールします。その後Control-Cを押すと、そこに戻ります。Python 2で、比較的古いバージョンでも動作するはずの1行です（2.7でテスト済みですが、Pythonソースを2.4に戻し、問題がないように見えました）。

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

Pythonのデバッグに時間を費やす場合は、pdbを学ぶ価値があります。インターフェースは少し鈍いですが、gdbなどの同様のツールを使用したことがある人なら誰でもよく知っているはずです。

uWSGIでこれを行う必要がある場合は、Python Tracebackerが組み込まれており、構成で有効にするだけです（番号は各ワーカーの名前に付加されます）。

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

これを実行したら、ソケットに接続するだけでバックトレースを印刷できます。

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

コードが実行された時点で、この小さなスニペットを挿入して、適切にフォーマットされた印刷スタックトレースを表示できます。logsプロジェクトのルートディレクトリに呼び出されるフォルダーがあることを前提としています。

# DEBUG: START DEBUG -->
import traceback

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