diff options
| author | Matthew Pickering <matthewtpickering@gmail.com> | 2019-05-29 16:56:08 +0100 |
|---|---|---|
| committer | Matthew Pickering <matthewtpickering@gmail.com> | 2019-05-30 10:17:14 +0100 |
| commit | db3639399db743eff1c2bde57d9219a77aa0f59a (patch) | |
| tree | d44b8ffeec5bbcd3ec3271e0e124da7f8214220d /docs | |
| parent | 2d2aa2031b9abc3bff7b5585ab4201948c8bba7d (diff) | |
| download | haskell-wip/eventlog-heap-prof-end.tar.gz | |
Add HEAP_PROF_SAMPLE_END event to mark end of sampleswip/eventlog-heap-prof-end
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 ^^^^^^^^^^^^^^^^^^^^^^ |