Permalink
Browse files

flesh out README a bit

  • Loading branch information...
1 parent 8a46f92 commit 5872ce28ccb8ba6abff916dc8948fe05b8f5db44 @davepacheco davepacheco committed Apr 1, 2012
Showing with 20 additions and 4 deletions.
  1. +20 −4 README.md
View
@@ -3,15 +3,31 @@
Stackvis is a JavaScript library for visualizing call stacks. For an example
of the kind of data we're talking about, see:
- http://www.cs.brown.edu/~dap/agg-flamegraph.svg
+ http://www.cs.brown.edu/~dap/redis-flamegraph.svg
-but this was not generated using this library. This is based heavily on
-Brendan Gregg's work on
-[FlameGraph](http://github.com/brendangregg/FlameGraph/)
+This library is based heavily on Brendan Gregg's
+[FlameGraph](http://github.com/brendangregg/FlameGraph/) tools.
The intended workflow is:
- collect data (currently using DTrace, but support for other tools can be added too)
- parse data into an intermediate format that allows for relatively simple
transformations
- emit visualizations for given representations.
+
+## TODO
+
+- Flesh out this README with descriptions of commands and modules.
+- See about dealing with multiple "silos" of a single flame graph that are
+ essentially the same, but differ in exactly one frame.
+- Experiment with flame graph coloring. Current options include random,
+ gradient, and time-based. Another possibility is to use hue to denote the
+ module and saturation to denote the size of a frame relative to others at the
+ same level of depth.
+- Tweak saturation for the existing time-based coloring: currently, the
+ saturation is determined by looking at (nsamples in frame) / (total samples),
+ but it would be better if it were (nsamples in frame) / (nsamples in row), as
+ this would cause different entries in the same row to stand out better.
+- Experiment with more interactive visualizations, such as:
+
+ http://bl.ocks.org/1005873

0 comments on commit 5872ce2

Please sign in to comment.