Repository files navigation

Project home:https://pptop.bma.ai/

ppTOP is open, extensible Python injector/profiler/analyzer.

The main idea is to inject a custom code inside Python process (already runningor going to be launched) and analyze its behavior with no any codemodifications.

Say no to "prints" and garbage in debug logs - now you have ppTOP. A modern MRIscanner for Python.

  pip3 install pptop

• Python: 3.5+ is required, as ppTOP uses asyncio
• Can be injected into any Python version (tested: 2.7+)
• Injection into running processes requiresgdb (present in almostall Linux distributions)
• Only Linux systems are currently supported

ppTOP can be injected into any running Python process

or you can load Python program manually and profile its launch

To launch a program, pressCtrl+L or specify-w sec param in command lineargs to start it automatically after the specified delay.

Data from connected process is collected in real-time and displayed intable-based console UI, which can be easily extended with custom plugins.

All data tables can be scrolled, filtered, new data collection can be paused.In case of problems, any plugin can be re-injected at any time.

To start ppTOP, type

    pptop

and then select Python process you want to inject to from the list.

Alternatively, you can start it with

    pptop PID# or    pptop PID-FILE

and specify the process from the command line.

If you want to analyze program startup, just type

    pptop /path/to/program.py

The program will be loaded in waiting state, pressCtrl+L when you are ready.

To get a help for the current plugin, pressF1 to display moduledocumentation.

Plugins and keyboard shortcuts are configured by default in~/.pptop/pptop.yml file (created automatically at first launch).

• asyncio asyncio loop monitor
• ataskeratasker monitor
• env view process OS environment variables
• log inject into all Python loggers and collect log messages
• malloc trace object memory allocations
• neotaskerneotasker monitor
• open_files view process open files
• script_runner launch a custom scripts inside process
• threads view process threads
• vars variable/function watcher
• yappiyappi profiler plugin

Most of plugins contain 2 parts of code: one collects data inside profilingprocess, other display it in ppTOP UI. For the profiling process all plug-insare invisible, safe and unloadable (at least they try their best :)

With "`" button, remote Python console can be opened. It has no fullfunctionality like a standard Python console, but supports all frequently usedfeatures, like importing modules, defining functions and variables,executing functions and loops etc.

Console has own remoteglobals, which are preserved until ppTOP quit andinjected server is terminated.

If launched with "-g" option, ppTOP will grab stdout/stderr of injected processand print it to local console. You can view local console without enteringconsole mode, by pressingCtrl+O.

Configuration, troubleshooting, advanced usage, plugin development:https://pptop.bma.ai/doc/

• More plugins
• Advanced filtering
• Data snapshots
• Step-by-step debugger
• JSON API, web interface
• Charts

Enjoy! :)

p.s. Code inmaster can be completely broken, install withpip only.