simon/sidekick
1
0
Fork 0
mirror of https://github.com/c-cube/sidekick.git synced 2025-12-09 12:45:48 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

more doc

Browse source
This commit is contained in:
Simon Cruanes 2021-06-10 14:20:27 -04:00
parent 8a4747d5d1
commit 96d1ff5775
1 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/tef/Sidekick_tef.mli
View file

@ -2,9 +2,23 @@
(** {1 Tracing Event Format}
A nice profiling format based on json, useful for visualizing what goes on.
See https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/
It provides a backend for {!Sidekick_util.Profile} so that
profiling probes will emit TEF events.
Profiling is enabled if {!setup} is called, and if
the environment variable "TEF" is set to "1" or "true".
The trace is emitted in the file "trace.json.gz" in the directory
where the solver is launched; you can open it in
chrome/chromium at "chrome://tracing".
{{: https://github.com/wolfpld/tracy} Tracy} can import (uncompressed)
trace files with a nice native trace explorer.
See {{: https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/}
the documentation of TEF}
*)
val setup : unit -> unit
(** Install the TEF logger as a profiling backend. *)
val teardown : unit -> unit