Update factory_prof.md

test-prof · Dec 12, 2023 · 2861592 · 2861592
1 parent 4a2bde1
commit 2861592
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -378,3 +378,4 @@ See [changelog](https://github.com/test-prof/test-prof/blob/v0.8.0/CHANGELOG.md)
 [@peret]: https://github.com/peret
 [@bf4]: https://github.com/bf4
 [@Vankiru]: https://github.com/Vankiru
+[@uzushino]: https://github.com/uzushino
diff --git a/docs/profilers/factory_prof.md b/docs/profilers/factory_prof.md
@@ -54,6 +54,25 @@ And for every test run see the overall factories usage:
 [TEST PROF INFO] Time spent in factories: 04:31.222 (54% of total time)
 ```
 
+### Exporting profile results to a JSON file
+
+FactoryProf can save profile results as a JSON file.
+
+To use this feature, set the `FPROF` environment variable to `json`:
+
+```sh
+FPROF=json rspec
+
+# or
+FPROF=json bundle exec rake test
+```
+
+Example output:
+
+```
+[TEST PROF INFO] Profile results to JSON: tmp/test_prof/test-prof.result.json
+```
+
 ## Factory Flamegraph
 
 The most useful feature of FactoryProf is the _FactoryFlame_ report. That's the special interpretation of Brendan Gregg's [flame graphs](http://www.brendangregg.com/flamegraphs.html) which allows you to identify _factory cascades_.