openstack/nova
Code Issues Proposed changes

Merge "Enable remote debugging for nova"

Browse Source
This commit is contained in:
Jenkins 2013-12-17 22:49:08 +00:00 committed by Gerrit Code Review
commit d10796ce29
4 changed files with 73 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/devref/development.environment.rst
View File

@ -142,6 +142,20 @@ basis by running::
$ tools/with_venv.sh <your command>
Using a remote debugger
----------------------
Some modern IDE such as pycharm (commercial) or Eclipse (open source) support remote debugging. In order to run nova with remote debugging, start the nova process
with the following parameters
--remote_debug-host <host IP where the debugger is running>
--remote_debug-port <port it is listening on>
Before you start your nova process, start the remote debugger using the instructions for that debugger.
For pycharm - http://blog.jetbrains.com/pycharm/2010/12/python-remote-debug-with-pycharm/
For Eclipse - http://pydev.org/manual_adv_remote_debugger.html
More detailed instructions are located here - http://novaremotedebug.blogspot.com
Contributing Your Work
----------------------

21
etc/nova/nova.conf.sample
View File

@ -2460,6 +2460,27 @@
#topics=notifications
[remote_debug]
#
# Options defined in nova.service
#
# Debug host (ip or name) to connect. Note that using the
# remote debug option changes how Nova uses the eventlet
# library to support async IO. This could result in failures
# that do not occur under normal operation. Use at your own
# risk. (string value)
#host=<None>
# Debug port to connect. Note that using the remote debug
# option changes how Nova uses the eventlet library to support
# async IO. This could result in failures that do not occur
# under normal operation. Use at your own risk. (integer
# value)
#port=<None>
[conductor]
#

4
nova/cmd/__init__.py
View File

@ -31,4 +31,8 @@ os.environ['EVENTLET_NO_GREENDNS'] = 'yes'
import eventlet
if '--remote_debug-host' in sys.argv and '--remote_debug-port' in sys.argv:
# turn off thread patching to enable the remote debugger
eventlet.monkey_patch(os=False, thread=False)
else:
eventlet.monkey_patch(os=False)

33
nova/service.py
View File

@ -105,9 +105,27 @@ service_opts = [
help='maximum time since last check-in for up service'),
]
cli_opts = [
cfg.StrOpt('host',
help='Debug host (ip or name) to connect. Note '
'that using the remote debug option changes how '
'Nova uses the eventlet library to support async IO. '
'This could result in failures that do not occur '
'under normal operation. Use at your own risk.'),
cfg.IntOpt('port',
help='Debug port to connect. Note '
'that using the remote debug option changes how '
'Nova uses the eventlet library to support async IO. '
'This could result in failures that do not occur '
'under normal operation. Use at your own risk.')
]
CONF = cfg.CONF
CONF.register_opts(service_opts)
CONF.import_opt('host', 'nova.netconf')
CONF.register_cli_opts(cli_opts, 'remote_debug')
class Service(service.Service):
@ -249,6 +267,21 @@ class Service(service.Service):
periodic_enable = CONF.periodic_enable
if periodic_fuzzy_delay is None:
periodic_fuzzy_delay = CONF.periodic_fuzzy_delay
if CONF.remote_debug.host and CONF.remote_debug.port:
from pydev import pydevd
LOG = logging.getLogger('nova')
LOG.debug(_('Listening on %(host)s:%(port)s for debug connection'),
{'host': CONF.remote_debug.host,
'port': CONF.remote_debug.port})
pydevd.settrace(host=CONF.remote_debug.host,
port=CONF.remote_debug.port,
stdoutToServer=False,
stderrToServer=False)
LOG.warn(_('WARNING: Using the remote debug option changes how '
'Nova uses the eventlet library to support async IO. This '
'could result in failures that do not occur under normal '
'operation. Use at your own risk.'))
service_obj = cls(host, binary, topic, manager,
report_interval=report_interval,
periodic_enable=periodic_enable,