ghc-events

Library and tool for parsing .eventlog files from GHC

Version on this page:0.6.0
LTS Haskell 22.39:0.19.0.1@rev:2
Stackage Nightly 2024-10-31:0.19.0.1@rev:2
Latest on Hackage:0.19.0.1@rev:2

See all snapshots ghc-events appears in

BSD-3-Clause licensed by Donnie Jones, Simon Marlow, Paul Bone, Mischa Dieterle, Thomas Horstmeyer, Duncan Coutts, Nicolas Wu, Jost Berthold <[email protected]> Mikolaj Konarski <[email protected]> Karolis Velicka
Maintained by Simon Marlow
This version can be pinned in stack with:ghc-events-0.6.0@sha256:5df1f0d5d0dce00924ff348b8f56277b2e7baf2a42ef92c8b5178b69acfb2b1e,3968

Module documentation for 0.6.0

Used by 1 package in lts-9.21(full list with versions):
ghc-events

ghc-events

Build Status Hackage Hackage-Deps

A Haskell library for parsing .eventlog files emitted by the GHC runtime system. The package also includes an executable, ghc-events that can be used to display the contents of .eventlog files

TODO

  • Add example usage/tutorial of the new API to this readme

Known Issues

  • Writing event logs back to file does not work. It is hard to say how long has this been broken or how difficult will it be to fix (#14)

Changes

Change Log

Unreleased

0.6.0 - 2017-05-31

This contains breaking changes.

  • The deprecation notice on readEventLogFromFile has been retracted
  • The incremental API has been refactored

The details are as follows:

  • Update bug tracker URL (#10)
  • New test for Eden events (#11)
  • Relax version bound for binary (#15)
  • Enable Travis CI (#19)
  • Refactor the incremental API which was introduced in 0.5.0.0 (#22)
  • Some speed/memory usage improvements (#18, #22)

0.5.0.0 - unreleased

  • Readme added :)
  • Old parser replaced with an incremental implementation
  • General overhaul of the codebase
  • Partial Haddock coverage

The 0.5.* releases should be able to handle large event logs and logs that have been cut off abruptly, e.g. from executable runs that resulted in crashes.

This release should be mostly backwards compatible, however the “old” way of reading event logs, namely the readEventLogFromFile function is now deprecated.

NOTE: Users parsing large logs may notice that this version of the library is noticably slower than the older versions. The incremental parser is at fault here - previous versions of the libray used a “trick” that would let them essentially skip the first step of the mergesort algorithm since EventBlocks were already sorted in time order. The new parser reads the file incrementally and cannot take the advantage of this. Apologies for any inconvenience this may have caused.