Debug Openstack code Local / Remote with Eclipse and PyDev Plug-In

Yatin Kumbhare — Thu, 30 May 2013 14:55:18 +0000

This article is a result of my exhaustive search for finding a concrete way to debug Openstack. After referring several places, I have come up with a manual of my own on how to setup eclipse environment to debug and understand openstack code flow. It should be a good read if you have similar questions as posted below in your mind.

Is it possible to debug openstack code end-to-end?
Should I debug locally (everything configure inside eclipse)?
How to debug remotely running openstack services?Or, combination of above two?
What developer tools/IDEs to use for debugging? (eclipse +pydev, pdb, winpdb, pycharm)?
What’s the best/easiest/more sophisticated method, to get set everything quickly?

And there’s bunch of other questions, followed by multiple alternatives to chose from.

Here in this post, I have tried debugging using Eclipse with pydev plug-in.

Development Environment:

Linux Distro: centos/ ubuntu, (I used VM workstation)

Install eclipse as per os type 32/64 bit on one of the VM: http://www.eclipse.org/

Install pydev plugin: http://pydev.org/manual_101_install.html

Configure python Interpreter in eclipse.

Install git plugin (only for local debug): http://download.eclipse.org/egit/updates, add this in Help-> install new software

How to Debug Openstack Services Locally?

To begin with, you can try with keystone in eclipse.

Check out: http://wiki.openstack.org/Setup%20keystone%20in%20Eclipse

Also, setup environment variables under debug configuration for keystone service to pick up.

OS_USERNAME,

OS_PASSWORD,

OS_TENANT_NAME,

OS_REGION_NAME,

OS_AUTH_URL

Optionally, Setup keystone.conf file as argument under debug configuration dialog.

For example, to test setup, put a break-point at:

File: keystone/identity/core.py

Method: def get_all_tenants(self, context, **kw):

Now, execute keystone-all (debug as-> python run) from eclipse

As you have already install keystoneclient by following above link, from terminal execute:

$keystone tenant-list

(check db is running, iptables service not blocking port – just in case if get 500 error with tenant-list)

This should hit break-point in keystone service running in eclipse and ask to move to debug perspective.

Voila, You have just got setup for local debugging.

Remote Debugging:

Development Environment:

In this case, I have used two VMs, one is centos and other is ubuntu 12.04.

Ubuntu VM- running eclipse IDE with pydev plug-in.

Centos VM – openstack services running.

Configure python Interpreter in eclipse.

Configure pydev debug server in eclipse.

To Remote debug, following link has most of the answers:

http://pydev.org/manual_adv_remote_debugger.html

Now, copy /pysrc directory from ubuntu vm to centos vm.

/pysrc – will be found in eclipse installation plugins/org.python.pydev_/pysrc

On centos (Remote machine), preferred place to copy under python site-package.

Ex: /usr/lib/python2.6/site-packages/pysrc/

Example-1: Remote debug keystone

Run the debug server in eclipse, note the debug server port.

File: keystone/keystone/identity/core.py

Function: def get_all_tenants(self, context, **kw): # gives tenant-list

Under this function add line:

import pydevd;pydevd.settrace(, port=8765, stdoutToServer=True, stderrToServer=True,suspend=True)

Next,File: /keystone/bin/keystone-all

To add pysrc to PYTHONPATH: add following line after “import sys” line

sys.path.append(‘/usr/lib/python2.6/site-packages/pysrc/’)

eventlet.patcher.monkey_patch(all=False, socket=True, time=True, thread=monkeypatch_thread)

Comment out above this line, and add following line:

eventlet.patcher.monkey_patch(all=False, socket=True, time=True, thread=False)

This most important for debugging, otherwise you will received “ThreadSuspended” error in eclipse.

As, the debug server listen to single thread, above line will take away green threading of thread module.

Restart keystone service

$service keystone restart

$keystone tenant-list

On eclipse, switch to debug perspective.

You should be able to hit break-point in core.py file, and step through further debug execution.

Example-2: Debugging keystone(get auth-token) + nova-api

$nova flavor-list #will debug this cli

File: /keystone/keystone/service.py
Class: class TokenController
Method:def authenticate(self, context, auth=None):

Add following line:
import pydevd;pydevd.settrace(‘’, port=8765, stdoutToServer=True, stderrToServer=True,suspend=True)

Next,File: /keystone/bin/keystone-all

To add pysrc to PYTHONPATH: add following line after “import sys” line

sys.path.append(‘/usr/lib/python2.6/site-packages/pysrc/’)

eventlet.patcher.monkey_patch(all=False, socket=True, time=True, thread=monkeypatch_thread)

Comment this line, and add following line:

eventlet.patcher.monkey_patch(all=False, socket=True, time=True, thread=False)

This most important for debugging, otherwise you will received “ThreadSuspended” error in eclipse.

As, the debug server listen to single thread, above line will take away green threading of thread module.

Restart keystone service

Next, File: nova/nova/api/openstack/compute/flavors.py

Class: class Controller(wsgi.Controller):

Method:

@wsgi.serializers(xml=FlavorsTemplate)

def detail(self, req):

Add following line under this function:

import pydevd;pydevd.settrace((, port=8765, stdoutToServer=True, stderrToServer=True,suspend=True)

File: nova/bin/nova-api

Add line after “import sys”

sys.path.append(‘/usr/lib/python2.6/site-packages/pysrc/’)

eventlet.monkey_patch(os=False)

comment above line, and change to:

eventlet.monkey_patch(all=False,socket=True,time=True,os=False,thread=False)

$service keystone restart

$service nova-api restart

$ nova flavor-list

In eclipse, this should hit break-point in service.py for keystone

After keystone token generated, control move to flavors.py

Things observed:

Path resolution:

If python paths and/or openstack code paths different on both VMs, eclipse will not be able to locate correct file to open, and respond with open file dialog, just cancel the dialog and file from remote machine get displayed. This file will get store into prsrc/temporary_file directory.
To avoid this, on server running openstack service, go to pysrc directory, and modify the file, pydevd_file_utils.py.

More info on this: http://pydev.org/manual_adv_remote_debugger.html

The whole idea for this blog post is to try out alternatives to debug openstack code.

I have taken simplest possible examples in very short time, to demonstrate, it works!!

Eclipse – iLearnStack

Debug Openstack code Local / Remote with Eclipse and PyDev Plug-In

Development Environment:

How to Debug Openstack Services Locally?

Remote Debugging:

Development Environment:

Things observed: