Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khamidou/lptrace
Trace any Python program, anywhere!
https://github.com/khamidou/lptrace
Last synced: about 1 month ago
JSON representation
Trace any Python program, anywhere!
- Host: GitHub
- URL: https://github.com/khamidou/lptrace
- Owner: khamidou
- License: gpl-3.0
- Created: 2016-10-14T04:40:20.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-26T07:37:03.000Z (about 6 years ago)
- Last Synced: 2024-10-01T13:08:29.071Z (2 months ago)
- Language: Python
- Homepage: http://khamidou.com/lptrace/
- Size: 26.4 KB
- Stars: 701
- Watchers: 29
- Forks: 43
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-python-resources - GitHub - 41% open · ⏱️ 24.02.2017): (调试工具)
- awesome-robotic-tooling - lptrace - It lets you see in real-time what functions a Python program is running. (Development Environment / Debugging and Tracing)
- awesome-discoveries - lptrace - trace any Python program, anywhere! _(`Python`)_ (Python Hacks)
- starred-awesome - lptrace - Trace any Python program, anywhere! (Python)
README
# lptrace
lptrace is strace for Python programs. It lets you see in real-time
what functions a Python program is running. It's particularly useful
to debug weird issues on production.
For example, let's debug a non-trivial program, the Python SimpleHTTPServer.
First, let's run the server:
```
vagrant@precise32:/vagrant$ python -m SimpleHTTPServer 8080 &
[1] 1818
vagrant@precise32:/vagrant$ Serving HTTP on 0.0.0.0 port 8080 ...
```
Now let's connect lptrace to it:
```
vagrant@precise32:/vagrant$ sudo python lptrace -p 1818
...
fileno (/usr/lib/python2.7/SocketServer.py:438)
meth (/usr/lib/python2.7/socket.py:223)
fileno (/usr/lib/python2.7/SocketServer.py:438)
meth (/usr/lib/python2.7/socket.py:223)
_handle_request_noblock (/usr/lib/python2.7/SocketServer.py:271)
get_request (/usr/lib/python2.7/SocketServer.py:446)
accept (/usr/lib/python2.7/socket.py:201)
__init__ (/usr/lib/python2.7/socket.py:185)
verify_request (/usr/lib/python2.7/SocketServer.py:296)
process_request (/usr/lib/python2.7/SocketServer.py:304)
finish_request (/usr/lib/python2.7/SocketServer.py:321)
__init__ (/usr/lib/python2.7/SocketServer.py:632)
setup (/usr/lib/python2.7/SocketServer.py:681)
makefile (/usr/lib/python2.7/socket.py:212)
__init__ (/usr/lib/python2.7/socket.py:246)
makefile (/usr/lib/python2.7/socket.py:212)
__init__ (/usr/lib/python2.7/socket.py:246)
handle (/usr/lib/python2.7/BaseHTTPServer.py:336)
handle_one_request (/usr/lib/python2.7/BaseHTTPServer.py:301)
^CReceived Ctrl-C, quitting
vagrant@precise32:/vagrant$
```
You can see that the server is handling the request in real time! After pressing Ctrl-C, the trace is removed and the program
execution resumes normally.
# How it works
gdb is an awesome debugger. It lets you attach to any running program, as long as you're root. It
also lets you call any C function this program exposes.
What's interesting is that among the C functions the Python interpreter exposes,
one function `PyRun\_SimpleString`, lets you run a single expression of Python code.
We use this function to ask the Python process to read a temporary file `lptrace` created. This file
contains a hook to the `sys.settrace` function, which allows us to get notified whenever a function is
called.
Finally, we need to output the tracing data somewhere. We could do this in the program we're tracing
but that wouldn't be very useful. Instead, we write it to a FIFO so that `lptrace` can display it in
its own window.
That's about it. I encourage you to read the source --- it's short and pretty simple!
# Running lptrace
lptrace was written to be run on production servers. Because of this,
you only need `lptrace` to run the whole program. You can get `lptrace` by installing the `lptrace` [PyPI package](https://pypi.python.org/pypi/lptrace) or simply by downloading the [main source file](https://raw.githubusercontent.com/khamidou/lptrace/master/lptrace).
# Usage
## Tracing a Python program
```
sudo python lptrace -p
```
## Getting a pdb prompt inside a Python program
Sometimes it's useful to get a pdb prompt inside a Python program.
Note that this requires that the Python program you're attaching to
has access to stdin.
```
sudo python lptrace -p -d
```
# Requirements
lptrace requires Python 2.7.x and GDB 7.x. It has been tested on Linux
successfully, and it should run on most recent Unices.
# Issues
Please open a ticket [here](https://github.com/khamidou/lptrace/issues)
# Security
lptrace is a debugging tool. It uses temporary files, so it may be vulnerable to some race conditions. Caveat emptor!
# Special Thanks
I'd like to thank the [Pyrasite project](http://pyrasite.com/) for coming up with
the idea to inject code into a running Python process.