simon/ocaml-trace
1
0
Fork 0
mirror of https://github.com/ocaml-tracing/ocaml-trace.git synced 2026-03-08 03:47:57 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc

Browse source
This commit is contained in:
Simon Cruanes 2024-01-19 10:02:49 -05:00
parent 23231464d1
commit d73a754189
No known key found for this signature in database
GPG key ID: EBFFF6F283F3A2B4
1 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/fuchsia/trace_fuchsia.mli
View file

@ -1,3 +1,11 @@
(** Fuchsia trace collector.
This provides a collector for traces that emits data into a file
using the compact binary
{{:https://fuchsia.dev/fuchsia-src/reference/tracing/trace-format} Fuchsia trace format}.
This reduces the tracing overhead compared to [trace-tef], at the expense of simplicity.
*)
val collector : val collector :
out:[ `File of string | `Stderr | `Stdout ] -> unit -> Trace_core.collector out:[ `File of string | `Stderr | `Stdout ] -> unit -> Trace_core.collector
(** Make a collector that writes into the given output. (** Make a collector that writes into the given output.
@ -34,7 +42,6 @@ val setup : ?out:[ output | `Env ] -> unit -> unit
val with_setup : ?out:[ output | `Env ] -> unit -> (unit -> 'a) -> 'a val with_setup : ?out:[ output | `Env ] -> unit -> (unit -> 'a) -> 'a
(** [with_setup () f] (optionally) sets a collector up, calls [f()], (** [with_setup () f] (optionally) sets a collector up, calls [f()],
and makes sure to shutdown before exiting. and makes sure to shutdown before exiting.
since 0.2 a () argument was added.
*) *)
(**/**) (**/**)