diff --git a/ppx_trace/_doc-dir/CHANGES.md b/ppx_trace/_doc-dir/CHANGES.md index ae8e411..2721a13 100644 --- a/ppx_trace/_doc-dir/CHANGES.md +++ b/ppx_trace/_doc-dir/CHANGES.md @@ -1,4 +1,12 @@ +# 0.8 + +- add `trace.subscriber` instead of a separate library +- add `trace-tef.tldrs`, to trace multiple processes easily (with external rust daemon) + +- breaking: `trace-tef`: use `mtime.now`, not a counter, for multiproc +- `trace-fuchsia`: require thread-local-storage 0.2 + # 0.7 - feat: add levels to `Trace_core`. Levels are similar to `logs` levels, to help control verbosity. diff --git a/trace-fuchsia/_doc-dir/CHANGES.md b/trace-fuchsia/_doc-dir/CHANGES.md index ae8e411..2721a13 100644 --- a/trace-fuchsia/_doc-dir/CHANGES.md +++ b/trace-fuchsia/_doc-dir/CHANGES.md @@ -1,4 +1,12 @@ +# 0.8 + +- add `trace.subscriber` instead of a separate library +- add `trace-tef.tldrs`, to trace multiple processes easily (with external rust daemon) + +- breaking: `trace-tef`: use `mtime.now`, not a counter, for multiproc +- `trace-fuchsia`: require thread-local-storage 0.2 + # 0.7 - feat: add levels to `Trace_core`. Levels are similar to `logs` levels, to help control verbosity. diff --git a/trace-tef/Trace_tef/index.html b/trace-tef/Trace_tef/index.html index 81c0b10..13a2b31 100644 --- a/trace-tef/Trace_tef/index.html +++ b/trace-tef/Trace_tef/index.html @@ -1,2 +1,2 @@ -Trace_tef (trace-tef.Trace_tef)

Module Trace_tef

type output = [
  1. | `Stdout
  2. | `Stderr
  3. | `File of string
]

Output for tracing.

  • `Stdout will enable tracing and print events on stdout
  • `Stderr will enable tracing and print events on stderr
  • `File "foo" will enable tracing and print events into file named "foo"
val subscriber : out:[< output ] -> unit -> Trace_subscriber.t

A subscriber emitting TEF traces into out.

  • since NEXT_RELEASE
val collector : out:[< output ] -> unit -> Trace_core.collector

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

val 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.
val 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.

\ No newline at end of file +Trace_tef (trace-tef.Trace_tef)

Module Trace_tef

type output = [
  1. | `Stdout
  2. | `Stderr
  3. | `File of string
]

Output for tracing.

  • `Stdout will enable tracing and print events on stdout
  • `Stderr will enable tracing and print events on stderr
  • `File "foo" will enable tracing and print events into file named "foo"
val subscriber : out:[< output ] -> unit -> Trace_subscriber.t

A subscriber emitting TEF traces into out.

  • since 0.8
val collector : out:[< output ] -> unit -> Trace_core.collector

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

val 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.
val 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.

\ No newline at end of file diff --git a/trace-tef/Trace_tef_tldrs/index.html b/trace-tef/Trace_tef_tldrs/index.html index 24f2f12..e9a32b6 100644 --- a/trace-tef/Trace_tef_tldrs/index.html +++ b/trace-tef/Trace_tef_tldrs/index.html @@ -1,2 +1,2 @@ -Trace_tef_tldrs (trace-tef.Trace_tef_tldrs)

Module Trace_tef_tldrs

Emit traces by talking to the tldrs daemon

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

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

val subscriber : out:[ `File of string ] -> unit -> Trace_subscriber.t

Make a subscriber that writes into the given output.

  • since NEXT_RELEASE
type output = [
  1. | `File of string
]

Output for tracing.

  • `File "foo" will enable tracing and print events into file named "foo". The file is only written at exit.
val 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.
val 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.

\ No newline at end of file +Trace_tef_tldrs (trace-tef.Trace_tef_tldrs)

Module Trace_tef_tldrs

Emit traces by talking to the tldrs daemon

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

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

val subscriber : out:[ `File of string ] -> unit -> Trace_subscriber.t

Make a subscriber that writes into the given output.

  • since 0.8
type output = [
  1. | `File of string
]

Output for tracing.

  • `File "foo" will enable tracing and print events into file named "foo". The file is only written at exit.
val 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.
val 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.

\ No newline at end of file diff --git a/trace-tef/_doc-dir/CHANGES.md b/trace-tef/_doc-dir/CHANGES.md index ae8e411..2721a13 100644 --- a/trace-tef/_doc-dir/CHANGES.md +++ b/trace-tef/_doc-dir/CHANGES.md @@ -1,4 +1,12 @@ +# 0.8 + +- add `trace.subscriber` instead of a separate library +- add `trace-tef.tldrs`, to trace multiple processes easily (with external rust daemon) + +- breaking: `trace-tef`: use `mtime.now`, not a counter, for multiproc +- `trace-fuchsia`: require thread-local-storage 0.2 + # 0.7 - feat: add levels to `Trace_core`. Levels are similar to `logs` levels, to help control verbosity. diff --git a/trace/Trace_subscriber/index.html b/trace/Trace_subscriber/index.html index 1c05e85..3197d51 100644 --- a/trace/Trace_subscriber/index.html +++ b/trace/Trace_subscriber/index.html @@ -1,2 +1,2 @@ -Trace_subscriber (trace.Trace_subscriber)

Module Trace_subscriber

Generic subscribers.

This defines the notion of a subscriber, a set of callbacks for every trace event. It also defines a collector that needs to be installed for the subscriber(s) to be called.

module Callbacks : sig ... end

Callbacks used for subscribers.

module Subscriber : sig ... end

Trace subscribers

type user_data =
  1. | U_bool of bool
  2. | U_float of float
  3. | U_int of int
  4. | U_none
  5. | U_string of string
    (*

    A non polymorphic-variant version of Trace_core.user_data

    *)
type flavor =
  1. | Sync
  2. | Async
    (*

    A non polymorphic-variant version of Trace_core.flavor

    *)

Main API

type t = Subscriber.t
val collector : t -> Trace_core.collector

A collector that calls the subscriber's callbacks.

It uses mtime (if available) to obtain timestamps.

\ No newline at end of file +Trace_subscriber (trace.Trace_subscriber)

Module Trace_subscriber

Generic subscribers.

This defines the notion of a subscriber, a set of callbacks for every trace event. It also defines a collector that needs to be installed for the subscriber(s) to be called.

module Callbacks : sig ... end

Callbacks used for subscribers.

module Subscriber : sig ... end

Trace subscribers

type user_data =
  1. | U_bool of bool
  2. | U_float of float
  3. | U_int of int
  4. | U_none
  5. | U_string of string
    (*

    A non polymorphic-variant version of Trace_core.user_data

    *)
type flavor =
  1. | Sync
  2. | Async
    (*

    A non polymorphic-variant version of Trace_core.flavor

    *)

Main API

type t = Subscriber.t
val collector : t -> Trace_core.collector

A collector that calls the subscriber's callbacks.

It uses mtime (if available) to obtain timestamps.

\ No newline at end of file diff --git a/trace/_doc-dir/CHANGES.md b/trace/_doc-dir/CHANGES.md index ae8e411..2721a13 100644 --- a/trace/_doc-dir/CHANGES.md +++ b/trace/_doc-dir/CHANGES.md @@ -1,4 +1,12 @@ +# 0.8 + +- add `trace.subscriber` instead of a separate library +- add `trace-tef.tldrs`, to trace multiple processes easily (with external rust daemon) + +- breaking: `trace-tef`: use `mtime.now`, not a counter, for multiproc +- `trace-fuchsia`: require thread-local-storage 0.2 + # 0.7 - feat: add levels to `Trace_core`. Levels are similar to `logs` levels, to help control verbosity.