From dbc848b97d2d783c8cc28a4c1df89ac6af7da2a7 Mon Sep 17 00:00:00 2001 From: Vladimir Dementyev Date: Thu, 24 Oct 2019 18:42:39 +0300 Subject: [PATCH] Add note about required raw:true for json reports Some viewers, e.g., speedscope, require raw data. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e9564850..844a41e0 100644 --- a/README.md +++ b/README.md @@ -329,7 +329,7 @@ Option | Meaning `out` | the target file, which will be overwritten `interval` | mode-relative sample rate [c.f.](#sampling) `aggregate` | defaults: `true` - if `false` disables [aggregation](#aggregation) -`raw` | defaults `false` - if `true` collects the extra data required by the `--flamegraph` and `--stackcollapse` report types +`raw` | defaults `false` - if `true` collects the extra data required by the `--flamegraph` and `--stackcollapse` report types; also required for `--json` reports for some external viewers (e.g., [speedscope](https://www.speedscope.app)) `save_every`| (rack middleware only) write the target file after this many requests ## Todo