Coloration Schemes

The output color of ProfileSVG can be customized with the functions provided by the FlameGraphs package. See the FlameGraphs docmentation for details.

Default scheme

ProfileSVG.view()

or

using FlameGraphs
ProfileSVG.view(FlameColors())

The default scheme uses cycling colors to distinguish different stack frames, while coloring runtime dispatch "red" and garbage-collection "orange". The run-time dispatch (aka, dynamic dispatch, run-time method lookup, or a virtual call) often has a significant impact on performance.

Stack frame category

You can colorize the stack frames based on their category, or module-of-origin.

using FlameGraphs
ProfileSVG.view(StackFrameCategory())

In the default StackFrameCategory scheme, "gray" indicates time spent in Core.Compiler (mostly inference), "dark gray" in other Core, "yellow" in LLVM, "orange" in other ccalls, "light blue" in Base, and "red" is uncategorized (mostly package code).

bgcolor and fontcolor options

ProfileSVG.view and ProfileSVG.save have optional keyword arguments for specifying the SVG styles.

The bgcolor option specifies the background color style and the fontcolor option specifies the font color style.

One of the following symbols is available for bgcolor:

• :fcolor
  • fcolor(:bg) (default)
• :classic
  • pale color gradation which comes from the original Flame Graphs
• :transparent
  • fully transparent

One of the following symbols is available for fontcolor:

• :fcolor
  • fcolor(:font) (default)
• :classic
  • black
• :currentcolor
  • the currentcolor CSS keyword
• :bw
  • black or white depending on the frame color

:fcolor (default)

using FlameGraphs, Colors
fcolor = FlameColors(colorbg=colorant"steelblue", colorfont=colorant"lightyellow")

ProfileSVG.view(fcolor)

:classic

ProfileSVG.view(bgcolor=:classic, fontcolor=:classic)

:transparent and :currentcolor

ProfileSVG.view(bgcolor=:transparent, fontcolor=:currentcolor)

:bw

modcat(mod) = nothing
loccat(sf) = occursin("#", string(sf.func)) ? colorant"navy" : colorant"powderblue"

mysfc = StackFrameCategory(modcat, loccat, colorant"dimgray", colorant"red")

ProfileSVG.view(mysfc, fontcolor=:bw)

frameopacity option

The frameopacity option specifyies the opacity of frames in [0, 1]. This option affects only the background of the frame, not the texts or the viewport background.

ProfileSVG.view(frameopacity=0.5, bgcolor=:transparent, fontcolor=:currentcolor)