Overview#

_images/logo.png _images/output.png

Memray is a memory profiler for Python. It can track memory allocations in Python code, in native extension modules, and in the Python interpreter itself. It can generate several different types of reports to help you analyze the captured memory usage data. While commonly used as a CLI tool, it can also be used as a library to perform more fine-grained profiling tasks.

Notable features:

  • ๐Ÿ•ต๏ธโ€โ™€๏ธ Traces every function call so it can accurately represent the call stack, unlike sampling profilers.

  • โ„ญ Also handles native calls in C/C++ libraries so the entire call stack is present in the results.

  • ๐ŸŽ Blazing fast! Profiling causes minimal slowdown in the application. Tracking native code is somewhat slower, but this can be enabled or disabled on demand.

  • ๐Ÿ“ˆ It can generate various reports about the collected memory usage data, like flame graphs.

  • ๐Ÿงต Works with Python threads.

  • ๐Ÿ‘ฝ๐Ÿงต Works with native-threads (e.g. C++ threads in native extensions)

Memray can help with the following problems:

  • Analyze allocations in applications to help discover the cause of high memory usage.

  • Find memory leaks.

  • Find hotspots in code which cause a lot of allocations.

_images/quotes.png

Note

Memray only works on Linux and MacOS, and cannot be installed on other platforms.