package trace-tef

You can search for identifiers within the package.

in-package search v0.2.0

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Trace_tef`Source

val collector : 
  out:[ `File of string | `Stderr | `Stdout ] ->
  unit ->
  Trace_core.collector

Make a collector that writes into the given output. See setup for more details.

Sourcetype output = [

]

Output for tracing.

Sourceval setup : ?out:[ output | `Env ] -> unit -> unit

setup () installs the collector depending on out.

parameter out
can take different values:
- regular output value to specify where events go
- `Env will enable tracing if the environment variable "TRACE" is set.

If it's set to "1", then the file is "trace.json".
If it's set to "stdout", then logging happens on stdout (since 0.2)
If it's set to "stderr", then logging happens on stdout (since 0.2)
Otherwise, if it's set to a non empty string, the value is taken to be the file path into which to write.

Sourceval with_setup : ?out:[ output | `Env ] -> unit -> (unit -> 'a) -> 'a

with_setup () f (optionally) sets a collector up, calls f(), and makes sure to shutdown before exiting. since 0.2 a () argument was added.