mirror of https://github.com/grin-compiler/haskell-code-spot.git synced 2024-07-07 09:36:23 +03:00

Visual tool to spot odd runtime behaviour of Haskell programs.

d3js debugger eventlog ghc haskell profiler starred-grin-compiler-repo starred-repo visualization web-ui

Go to file

Csaba Hruska 3a07172e99 bump version of rollup-plugin-svelte to work with newer nodejs versions		2021-11-16 13:59:09 +01:00
client	bump version of rollup-plugin-svelte to work with newer nodejs versions	2021-11-16 13:59:09 +01:00
data	GRIN eventlog with -N4	2020-06-12 21:50:06 +02:00
doc	new screenshot	2020-07-27 13:28:05 +02:00
server	make ext-stg/ghc-wpc optional ; modpak endpoints	2020-09-28 19:26:23 +02:00
.gitignore	Gitignore	2020-06-12 19:25:21 +03:00
desgin-notes	add notes	2020-07-27 12:29:08 +02:00
eventlog-notes	add notes	2020-07-27 12:29:08 +02:00
README.md	Update README.md	2021-02-24 17:52:20 +01:00

README.md

Haskell Code Spot

Visual tool to spot odd runtime behaviour of Haskell programs.
Keywords: data scientist, GHC eventlog, UI experiments, creative/live coding

NOTE: GHC-WPC is optional, Haskell Code Spot works with vanilla GHC eventlog out of the box.

Blog

WebUI for Haskell tooling!

Learn these for coding

HTML + CSS + JS (https://www.youtube.com/kepowob/featured)
Svelte (https://svelte.dev/tutorial/basics)
D3.js (https://www.youtube.com/watch?v=_8V5o2UHG0E)
D3 flame graph (https://github.com/spiermar/d3-flame-graph)
C3.js (https://c3js.org/)
CodeMirror (https://codemirror.net/doc/manual.html#api)
Scotty (https://hackage.haskell.org/package/scotty)
GHC RTS design (https://takenobu-hs.github.io/downloads/haskell_ghc_illustrated.pdf)
GHC Eventlog (https://www.well-typed.com/blog/2019/09/eventful-ghc/)
ghc-events library (https://hackage.haskell.org/package/ghc-events)
GHC HIE files (https://www.haskell.org/ghc/blog/20190626-HIEFiles.html)

Quick Start Guide

In one terminal:

$ (cd server && stack build && stack exec code-spot-server)

In another terminal:

$ (cd client/src && npm install && npm run dev)

Now open http://localhost:5000/ in your browser!

You will see a visualisation of data/grin.eventlog (change in client/src/App.svelte).

How to build your eventlog

If stack project is used, profiling must be enabled. After compiled with profiling, one need to run it with RTS options plh.

stack build --profile --executable-profiling --library-profiling
stack exec --profile EXECUTABLE -- ARGUMENTS +RTS -p -l -h

Previews:

This project is still in the proof-of-concept phase, but we had a great fun implementing the initial version of heap inspections and the step-by-step debugger. All of these features are based on visualizing the EventLog from GHC.

Heap Live

Heap Size

Cost Center based stack trace in step-by-step style. See the demo video.