introduce heartbeat frames

2025-01-16 18:56:01 -08:00
parent 3e178fd46f
commit ff8aa68942
3 changed files with 165 additions and 36 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -14,6 +14,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
  pipeline. This can be useful, for example, to implement frame loggers or
  debuggers among other things.

+- Introduced heartbeat frames. The pipeline task can now push periodic
+  heartbeats down the pipeline when `enable_heartbeats=True`. Heartbeats are
+  system frames that are supposed to make it all the way to the end of the
+  pipeline. When a heartbeat frame is received the traversing time (i.e. the time
+  it took to go through the whole pipeline) will be displayed (with TRACE
+  logging) otherwise a warning will be shown.
+
 - Added `30-observer.py` to show how to add an Observer to a pipeline for
  debugging.