openstack
/
octavia
Code Issues Proposed changes
octavia/doc/source/contributor/guides/remote-debugger.rst

2.6 KiB
Raw Blame History

Debugging Octavia code

This document describes how to setup and debug Octavia code using your favorite IDE (e.g. PyCharm).

Prerequisites

  • Octavia installed.
  • IDE installed and Octavia added as project.

Setup

Ensure your OpenStack and IDE environments have the PyDev library installed. If you're using PyCharm, you can find it in /path/to/pycharm/debug-eggs/pycharm-debug.egg (Python 2) and /path/to/pycharm/debug-eggs/pycharm-debug-py3k.egg (Python 3). Copy that file into your OpenStack host and install the library in your Python path:

$ sudo easy_install pycharm-debug.egg

Create a remote debugging configuration in your IDE. In PyCharm, go to Run -> Edit Configurations -> Python Remote Debug. The local host name refers to the local machine you're running your IDE from and it must be one reachable by your OpenStack environment. The port can be any available port (e.g. 5678). If the code on the OpenStack and PyCharm hosts is on different paths (likely), define a path mapping in the remote debug configuration.

Invoke the debug configuration (Run -> Debug... -> (config name)). PyCharm will begin listening on the specified host and port.

Export PYDEV_DEBUG_HOST and PYDEV_DEBUG_PORT (host and port of the system running the IDE, respectively), and start the Octavia service you want to debug. It is recommended to run only one uWSGI process/controller worker. For example, to debug the Octavia Worker service:

$ export PYDEV_DEBUG_HOST=192.168.121.1
$ export PYDEV_DEBUG_PORT=5678
$ /usr/bin/octavia-worker --config-file /etc/octavia/octavia.conf

Another example is the Octavia API service:

$ export PYDEV_DEBUG_HOST=192.168.121.1
$ export PYDEV_DEBUG_PORT=5678
$ /usr/bin/uwsgi --ini /etc/octavia/octavia-uwsgi.ini -p 1

The service will connect to your IDE, at which point remote debugging is active. Resume the program on the debugger to continue with the initialization of the service. At this point, the service should be operational and you can start debugging.