openstack/devstack
Code Issues Proposed changes

Merge "doc: How to remote-pdb under systemd"

Browse Source
This commit is contained in:
Jenkins 2017-09-08 02:24:21 +00:00 committed by Gerrit Code Review
commit 0f75c57ad6
1 changed files with 36 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
doc/source/systemd.rst
View File

@ -120,8 +120,11 @@ left/right arrow keys.
See ``man 1 journalctl`` for more.
Debugging with pdb
==================
Debugging
=========
Using pdb
---------
In order to break into a regular pdb session on a systemd-controlled
service, you need to invoke the process manually - that is, take it out
@ -143,6 +146,37 @@ Invoke the command manually::
/usr/local/bin/nova-scheduler --config-file /etc/nova/nova.conf
Using remote-pdb
----------------
`remote-pdb`_ works while the process is under systemd control.
Make sure you have remote-pdb installed::
sudo pip install remote-pdb
Inject your breakpoint in the source, e.g.::
import remote_pdb; remote_pdb.set_trace()
Restart the relevant service::
sudo systemctl restart devstack@n-api.service
The remote-pdb code configures the telnet port when ``set_trace()`` is
invoked. Do whatever it takes to hit the instrumented code path, and
inspect the logs for a message displaying the listening port::
Sep 07 16:36:12 p8-100-neo devstack@n-api.service[772]: RemotePdb session open at 127.0.0.1:46771, waiting for connection ...
Telnet to that port to enter the pdb session::
telnet 127.0.0.1 46771
See the `remote-pdb`_ home page for more options.
.. _`remote-pdb`: https://pypi.python.org/pypi/remote-pdb
Known Issues
============