Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/niccokunzmann/hanging_threads

Deadlocks? Detect where your threads hang in Python with one import.
https://github.com/niccokunzmann/hanging_threads

Last synced: 13 days ago
JSON representation

Deadlocks? Detect where your threads hang in Python with one import.

Host: GitHub
URL: https://github.com/niccokunzmann/hanging_threads
Owner: niccokunzmann
License: mit
Created: 2016-12-04T18:10:52.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2024-02-17T17:29:47.000Z (9 months ago)
Last Synced: 2024-10-04T12:14:25.028Z (about 1 month ago)
Language: Python
Homepage: https://pypi.python.org/pypi/hanging_threads
Size: 65.4 KB
Stars: 50
Watchers: 3
Forks: 9
Open Issues: 14
Metadata Files:
- Readme: README.rst
- License: LICENSE

Awesome Lists containing this project

README

hanging_threads
===============

Deadlocks? Detect where your threads hang in Python.

.. image:: https://travis-ci.org/niccokunzmann/hanging_threads.svg
:target: https://travis-ci.org/niccokunzmann/hanging_threads
:alt: Build Status

.. image:: https://badge.fury.io/py/hanging_threads.svg
:target: https://pypi.python.org/pypi/hanging_threads
:alt: Python Package Index

Installation
------------

Install the module with pip:

.. code:: bash

pip install hanging_threads

If installing with **Windows**, open the command line program "cmd" and type

.. code:: bash

py -m pip install hanging_threads

Usage
-----

Monitoring is as simple as calling the start_monitoring() function.

.. code:: python

from hanging_threads import start_monitoring
monitoring_thread = start_monitoring()

You may also pass additional parameters.

.. code:: python

monitoring_thread = start_monitoring(seconds_frozen=10, test_interval=100)

The values in the example are defaults. This mean the check will happen 10
times per second. If a thread is frozen for at least 10 seconds then the stack
is dumped into standard error stream. This happens again every 10 seconds
while there is no changes in the stack registered during checks. Checks are done in
intervals of 100ms.

Note that it makes sense to save the thread object into variable so that you or
somebody else can stop the annoying dumps if needed.
For example, you may want to do this in the Python shell.

.. code:: python

monitoring_thread.stop()

Changelog
---------

- v2.0.7: Start changelog, fix crash when line number is not known.

New Releases
------------

To release a new version:

1. Edit the ``README.md`` file in the Changelog Section and add the changes. Increase the ``hanging_threads.py`` version.

.. code:: bash

git add README.rst hanging_threads.py
git commit -m"v2.0.7"
git push

2. Create a tag for the version.

.. code:: bash

git tag v2.0.7
git push origin v2.0.7

3. Notify solved issues about the release.