diff options
author | Ben Gamari <ben@smart-cactus.org> | 2020-12-16 12:21:46 -0500 |
---|---|---|
committer | Ben Gamari <ben@smart-cactus.org> | 2020-12-16 13:51:01 -0500 |
commit | 02bc4b4f1a4fe07a46018738e7e12ec861aaf3df (patch) | |
tree | 4f289e9a4d3f608aeff18722787f67738f86e075 /docs/users_guide | |
parent | b58cb63afd3353beb3a6e11ba7fa557fdedb8941 (diff) | |
download | haskell-wip/eventlog-flush-interval.tar.gz |
rts: Introduce --eventlog-flush-interval flagwip/eventlog-flush-interval
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/users_guide')
-rw-r--r-- | docs/users_guide/runtime_control.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/users_guide/runtime_control.rst b/docs/users_guide/runtime_control.rst index 701ad9422b..d148d67de7 100644 --- a/docs/users_guide/runtime_control.rst +++ b/docs/users_guide/runtime_control.rst @@ -1238,6 +1238,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 |