diff options
| author | Sean Dague <sean@dague.net> | 2015-01-09 11:27:55 -0500 |
|---|---|---|
| committer | Sean Dague <sean@dague.net> | 2015-01-09 15:38:48 -0500 |
| commit | df35680b673eabe0b664f17663f2272711b2e5b4 (patch) | |
| tree | 2233b5d2d4ec71e5742022322df3721a645bf227 /doc | |
| parent | 18bcbe2ef86f025413a8284d6aaf10336b78e72c (diff) | |
| download | oslo-concurrency-df35680b673eabe0b664f17663f2272711b2e5b4.tar.gz | |
add watchdog module
This provides the watchdog.watch function which is a contextmanager
that can be used before doing operations that have a high risk of
deadlocking or aberrantly taking huge amounts of time to complete
(which could be the root cause for other issues).
Unit tests require the use of sleep to make the timers pop either
before or after the event in question. There is 1 second buffer that's
encoded into each scenario which should be sufficient for unit tests
(even in busy systems). If that turns into an issue later, the buffer
can be increased (I was only seeing real skew of 1-2 ms locally).
Change-Id: I79e39f8a4aa702627ca39bea3e6fc672134b8a72
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/api/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/api/watchdog.rst | 8 |
2 files changed, 9 insertions, 0 deletions
diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst index 33aadc4..2ee39d8 100644 --- a/doc/source/api/index.rst +++ b/doc/source/api/index.rst @@ -5,3 +5,4 @@ lockutils opts processutils + watchdog diff --git a/doc/source/api/watchdog.rst b/doc/source/api/watchdog.rst new file mode 100644 index 0000000..feccaeb --- /dev/null +++ b/doc/source/api/watchdog.rst @@ -0,0 +1,8 @@ +================================== + :mod:`oslo_concurrency.watchdog` +================================== + +.. automodule:: oslo_concurrency.watchdog + :members: + :undoc-members: + :show-inheritance: |