diff options
| author | Matthew Pickering <matthewtpickering@gmail.com> | 2019-05-29 16:56:08 +0100 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2019-06-07 10:21:57 -0400 |
| commit | 0b7372f68c0bc9cafc30e227b574abf1d5b16df5 (patch) | |
| tree | f1b33e977ed5fb858ba102815260136a89d1735c /docs | |
| parent | e963beb54a243f011396942d2add644e3f3dd8ae (diff) | |
| download | haskell-0b7372f68c0bc9cafc30e227b574abf1d5b16df5.tar.gz | |
Add HEAP_PROF_SAMPLE_END event to mark end of samples
This allows a user to observe how long a sampling period lasts so that
the time taken can be removed from the profiling output.
Fixes #16697
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/users_guide/eventlog-formats.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/users_guide/eventlog-formats.rst b/docs/users_guide/eventlog-formats.rst index 6fd7d89b7e..0590fc65db 100644 --- a/docs/users_guide/eventlog-formats.rst +++ b/docs/users_guide/eventlog-formats.rst @@ -84,6 +84,14 @@ in length a single sample may need to be split among multiple ``EVENT_HEAP_PROF_SAMPLE`` events. The precise format of the census entries is determined by the break-down type. +At the end of the sample period the ``EVENT_HEAP_PROF_SAMPLE_END`` event if +emitted. This is useful to properly delimit the sampling period and to record +the total time spent profiling. + + + * ``EVENT_HEAP_PROF_SAMPLE_END`` + * ``Word64``: sample number + Cost-centre break-down ^^^^^^^^^^^^^^^^^^^^^^ |