Modulegranite-0.7.4.0GHC2021

Granite.Flame

Differential flame/icicle graphs. A FlameNode tree carries, per frame, the summed positive delta (fnPos, an increase) and the magnitude of the summed negative delta (fnNeg, a decrease, kept non-negative). flameDiff lays the tree out top→down by depth and emits a standalone <svg> document.

A frame's width is its churn (fnPos + fnNeg) relative to the root churn. Within a frame a red part (the increase) and a blue part (the decrease) are drawn side by side, so a relocation — equal +x/-x — reads as half-red/ half-blue rather than as a net regression.

2 types
2 values

Packagegranite-0.7.4.0
Exports4
LanguageGHC2021
LicenceMIT
SourceFlame.hs

datadata FlameNode

Constructors

FlameNode
- fnLabel :: Text
  Frame name.
- fnPos :: Double
  Summed positive self-delta in this subtree (an increase), in bytes (tooltips format it as MB).
- fnNeg :: Double
  Summed negative magnitude in this subtree (a decrease, >= 0), in bytes (tooltips format it as MB).
- fnChildren :: [FlameNode]

Instances2Eq, Show

Eq FlameNodeDefined in granite-0.7.4.0 · Granite.Flame
Show FlameNodeDefined in granite-0.7.4.0 · Granite.Flame

datadata FlameOpts

Constructors

FlameOpts
- foWidth :: Double
  Total SVG width in px.
- foRowH :: Double
  Height of one depth row in px.
- foMaxDepth :: Int
  Deepest depth drawn (root is depth 0).
- foTitle :: Text
  Heading drawn above the chart.
- foMinPx :: Double
  Frames narrower than this (in px) are dropped.

Instances2Eq, Show

Eq FlameOptsDefined in granite-0.7.4.0 · Granite.Flame
Show FlameOptsDefined in granite-0.7.4.0 · Granite.Flame

valuedefFlameOpts :: FlameOpts

valueflameDiff :: FlameNode -> FlameOpts -> Text

Render a differential flame graph as a full standalone <svg> document. Rows go top→down by depth; a frame's width is proportional to its churn over the root churn; children are laid left→right sorted by descending churn; frames narrower than foMinPx are dropped and recursion stops past foMaxDepth.