summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBen Gamari <ben@smart-cactus.org>2020-12-16 12:21:46 -0500
committerMarge Bot <ben+marge-bot@smart-cactus.org>2021-02-27 07:58:57 -0500
commit98dd09afdebe8d5b6def4c3b11a4c0495df47de4 (patch)
treececfb9edd7b797a2f71a0e443309df746f61a81f /docs
parenta9f23793126251844944e00bca8e84370c759aa7 (diff)
downloadhaskell-98dd09afdebe8d5b6def4c3b11a4c0495df47de4.tar.gz
rts: Introduce --eventlog-flush-interval flag
This introduces a flag, --eventlog-flush-interval, which can be used to set an upper bound on the amount of time for which an eventlog event will remain enqueued. This can be useful in real-time monitoring settings.
Diffstat (limited to 'docs')
-rw-r--r--docs/users_guide/runtime_control.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/users_guide/runtime_control.rst b/docs/users_guide/runtime_control.rst
index 50d8e4ce2b..b8da4aee01 100644
--- a/docs/users_guide/runtime_control.rst
+++ b/docs/users_guide/runtime_control.rst
@@ -1256,6 +1256,15 @@ When the program is linked with the :ghc-flag:`-eventlog` option
Sets the destination for the eventlog produced with the
:rts-flag:`-l ⟨flags⟩` flag.
+.. rts-flag:: --eventlog-flush-interval=⟨seconds⟩
+
+ :default: disabled
+ :since: 9.2
+
+ When enabled, the eventlog will be flushed periodically every
+ ⟨seconds⟩. This can be useful in live-monitoring situations where the
+ eventlog is consumed in real-time by another process.
+
.. rts-flag:: -v [⟨flags⟩]
Log events as text to standard output, instead of to the