Debug.Trace.String

ghc-trace-events-0.1.2.9: Faster traceEvent and traceMarker, and binary object logging for eventlog

Safe Haskell | None
Language | Haskell2010

Debug.Trace.String

Contents

- Eventlog tracing
- Execution phase markers

Description

Drop-in replacement for the event tracing functions in Debug.Trace but are faster when user tracing is disabled.

Synopsis

- traceEvent :: String -> a -> a
- traceEventIO :: String -> IO ()
- traceMarker :: String -> a -> a
- traceMarkerIO :: String -> IO ()

# Eventlog tracing

Eventlog tracing is a performance profiling system. These functions emit extra events into the eventlog. In combination with eventlog profiling tools these functions can be used for monitoring execution and investigating performance problems.

traceEvent :: String -> a -> a #

Drop-in replacement for `traceEvent` but is more efficient if user tracing in eventlog is disabled.

Note that this function doesn't evaluate the `String` if user tracing in eventlog is disabled.

The input should be shorter than \(2^{16}\) bytes. Otherwise the RTS generates a broken eventlog.

traceEventIO :: String -> IO () #

Drop-in replacement for `traceEventIO` but is more efficient if user tracing in eventlog is disabled.

Note that this function doesn't evaluate the `String` if user tracing in eventlog is disabled.

The input should be shorter than \(2^{16}\) bytes. Otherwise the RTS generates a broken eventlog.

# Execution phase markers

When looking at a profile for the execution of a program we often want to be able to mark certain points or phases in the execution and see that visually in the profile.

For example, a program might have several distinct phases with different performance or resource behaviour in each phase. To properly interpret the profile graph we really want to see when each phase starts and ends.

Markers let us do this: we can annotate the program to emit a marker at an appropriate point during execution and then see that in a profile.

traceMarker :: String -> a -> a #

Drop-in replacement for `traceMarker` but is more efficient if user tracing in eventlog is disabled.

Note that this function doesn't evaluate the `String` if user tracing in eventlog is disabled.

The input should be shorter than \(2^{16}\) bytes. Otherwise the RTS generates a broken eventlog.

traceMarkerIO :: String -> IO () #

Drop-in replacement for `traceMarkerIO` but is more efficient if user tracing in eventlog is disabled.

Note that this function doesn't evaluate the `String` if user tracing in eventlog is disabled.

The input should be shorter than \(2^{16}\) bytes. Otherwise the RTS generates a broken eventlog.