From c766592a42e8810b3762073d845bbd4fcc50d986 Mon Sep 17 00:00:00 2001 From: c-cube Date: Thu, 14 Sep 2023 03:43:02 +0000 Subject: [PATCH] deploy: d8e6b83987b7a9457b3276edc5b2393099fbdad2 --- .../Catapult_client/Backend/index.html | 2 ++ .../Catapult_client/Connection/index.html | 11 +++++++ .../Catapult_client/index.html | 12 +++++++- .../Catapult_sqlite/Backend/Make/index.html | 2 +- .../Catapult_sqlite/Backend/index.html | 2 +- .../Catapult_sqlite/Ev_to_json/index.html | 2 -- .../Catapult_sqlite/Writer/index.html | 16 +++++++--- .../Catapult_sqlite/index.html | 10 ++++++- .../Catapult/Adapt_backend/index.html | 2 ++ .../module-type-BACKEND/index.html | 15 ++++++++++ dev/catapult/Catapult/Arg/index.html | 2 -- .../Catapult/Tracing/Control/index.html | 2 -- .../Catapult/Tracing/Syntax/index.html | 2 -- dev/catapult/Catapult/Tracing/index.html | 11 ------- dev/catapult/Catapult/index.html | 2 +- .../Catapult/module-type-BACKEND/index.html | 2 +- .../Catapult_utils/Ev_to_json/index.html | 2 ++ .../Catapult_utils/Gc_stats/index.html | 2 +- .../Catapult_utils/Json_out/index.html | 30 +++++++++++++++++-- .../Catapult_utils/Ser/Arg/index.html | 2 +- .../Catapult_utils/Ser/Arg_value/index.html | 2 +- .../Ser/Client_close_trace/index.html | 2 +- .../Catapult_utils/Ser/Client_emit/index.html | 2 +- .../Ser/Client_message/index.html | 2 +- .../Ser/Client_open_trace/index.html | 2 +- .../Catapult_utils/Ser/Event/index.html | 2 +- .../Catapult_utils/Ser/Extra/index.html | 2 +- dev/catapult/Catapult_utils/index.html | 2 +- 28 files changed, 105 insertions(+), 42 deletions(-) create mode 100644 dev/catapult-client/Catapult_client/Backend/index.html create mode 100644 dev/catapult-client/Catapult_client/Connection/index.html delete mode 100644 dev/catapult-sqlite/Catapult_sqlite/Ev_to_json/index.html create mode 100644 dev/catapult/Catapult/Adapt_backend/index.html create mode 100644 dev/catapult/Catapult/Adapt_backend/module-type-BACKEND/index.html delete mode 100644 dev/catapult/Catapult/Arg/index.html delete mode 100644 dev/catapult/Catapult/Tracing/Control/index.html delete mode 100644 dev/catapult/Catapult/Tracing/Syntax/index.html delete mode 100644 dev/catapult/Catapult/Tracing/index.html create mode 100644 dev/catapult/Catapult_utils/Ev_to_json/index.html diff --git a/dev/catapult-client/Catapult_client/Backend/index.html b/dev/catapult-client/Catapult_client/Backend/index.html new file mode 100644 index 0000000..e930bb5 --- /dev/null +++ b/dev/catapult-client/Catapult_client/Backend/index.html @@ -0,0 +1,2 @@ + +Backend (catapult-client.Catapult_client.Backend)

Module Catapult_client.Backend

\ No newline at end of file diff --git a/dev/catapult-client/Catapult_client/Connection/index.html b/dev/catapult-client/Catapult_client/Connection/index.html new file mode 100644 index 0000000..b71bd4c --- /dev/null +++ b/dev/catapult-client/Catapult_client/Connection/index.html @@ -0,0 +1,11 @@ + +Connection (catapult-client.Catapult_client.Connection)

Module Catapult_client.Connection

type t
val create : + addr:Catapult_utils.Endpoint_address.t -> + ?trace_id:string -> + unit -> + t
val send_msg : t -> pid:int -> now:float -> Catapult_utils.Ser.Event.t -> unit
val close : t -> unit
val with_ : + addr:Catapult_utils.Endpoint_address.t -> + ?trace_id:string -> + unit -> + (t -> 'a) -> + 'a
\ No newline at end of file diff --git a/dev/catapult-client/Catapult_client/index.html b/dev/catapult-client/Catapult_client/index.html index 0c0779e..8665fc2 100644 --- a/dev/catapult-client/Catapult_client/index.html +++ b/dev/catapult-client/Catapult_client/index.html @@ -1,2 +1,12 @@ -Catapult_client (catapult-client.Catapult_client)

Module Catapult_client

Backend for Catapult, using a connection to the daemon.

include Catapult.IMPL
val setup : unit -> unit

Install the catapult logger as a profiling backend.

val teardown : unit -> unit
val with_setup : (unit -> 'a) -> 'a
module Endpoint_address = Catapult_utils.Endpoint_address
val enable : unit -> unit
val enabled : unit -> bool
val set_trace_id : string -> unit

Must be called before the setup.

val get_trace_id : unit -> string
val default_endpoint : Endpoint_address.t
val get_endpoint : unit -> Endpoint_address.t
val set_endpoint : Endpoint_address.t -> unit

Must be called before the setup.

val set_tcp_endpoint : string -> int -> unit
val set_ipc_endpoint : string -> unit
\ No newline at end of file +Catapult_client (catapult-client.Catapult_client)

Module Catapult_client

Backend for Catapult, using a connection to the daemon.

module Endpoint_address = Catapult_utils.Endpoint_address
module Backend : sig ... end
module Connection : sig ... end
val default_endpoint : Endpoint_address.t
val with_conn : + addr:Catapult_utils.Endpoint_address.t -> + ?trace_id:string -> + unit -> + (Connection.t -> 'a) -> + 'a
val backend_of_conn : Connection.t -> Catapult.backend
val addr_of_string_exn : string -> Endpoint_address.t

Parse a remote address.

val trace_collector_of_conn : Connection.t -> Trace_core.collector

Obtain a trace collector from a network connection

val with_ : + addr:Catapult_utils.Endpoint_address.t -> + ?trace_id:string -> + unit -> + (unit -> 'a) -> + 'a

with_ ~addr () f runs f() in an environment where a connection to addr has been established and is used to forward tracing events to the remote daemon.

\ No newline at end of file diff --git a/dev/catapult-sqlite/Catapult_sqlite/Backend/Make/index.html b/dev/catapult-sqlite/Catapult_sqlite/Backend/Make/index.html index aded768..fd96872 100644 --- a/dev/catapult-sqlite/Catapult_sqlite/Backend/Make/index.html +++ b/dev/catapult-sqlite/Catapult_sqlite/Backend/Make/index.html @@ -7,7 +7,7 @@ pid:int -> cat:string list option -> ts_us:float -> - args:(string * Catapult.Arg.t) list option -> + args:(string * [< Catapult__.Backend.arg ]) list option -> stack:string list option -> dur:float option -> ?extra:(string * string) list -> diff --git a/dev/catapult-sqlite/Catapult_sqlite/Backend/index.html b/dev/catapult-sqlite/Catapult_sqlite/Backend/index.html index d5441f2..021e241 100644 --- a/dev/catapult-sqlite/Catapult_sqlite/Backend/index.html +++ b/dev/catapult-sqlite/Catapult_sqlite/Backend/index.html @@ -1,2 +1,2 @@ -Backend (catapult-sqlite.Catapult_sqlite.Backend)

Module Catapult_sqlite.Backend

module type ARG = sig ... end
\ No newline at end of file +Backend (catapult-sqlite.Catapult_sqlite.Backend)

Module Catapult_sqlite.Backend

module type ARG = sig ... end
\ No newline at end of file diff --git a/dev/catapult-sqlite/Catapult_sqlite/Ev_to_json/index.html b/dev/catapult-sqlite/Catapult_sqlite/Ev_to_json/index.html deleted file mode 100644 index cd469f8..0000000 --- a/dev/catapult-sqlite/Catapult_sqlite/Ev_to_json/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Ev_to_json (catapult-sqlite.Catapult_sqlite.Ev_to_json)

Module Catapult_sqlite.Ev_to_json

val to_json : Stdlib.Buffer.t -> Catapult_utils.Ser.Event.t -> string
\ No newline at end of file diff --git a/dev/catapult-sqlite/Catapult_sqlite/Writer/index.html b/dev/catapult-sqlite/Catapult_sqlite/Writer/index.html index ed032c0..8093d5a 100644 --- a/dev/catapult-sqlite/Catapult_sqlite/Writer/index.html +++ b/dev/catapult-sqlite/Catapult_sqlite/Writer/index.html @@ -1,9 +1,17 @@ -Writer (catapult-sqlite.Catapult_sqlite.Writer)

Module Catapult_sqlite.Writer

type t
val create : +Writer (catapult-sqlite.Catapult_sqlite.Writer)

Module Catapult_sqlite.Writer

DB writer.

type t

DB writer. This holds a sqlite DB and writes new events to it.

val create : ?sync:[ `OFF | `NORMAL | `FULL ] -> ?append:bool -> ?file:string -> - trace_id:string -> - dir:string -> + ?trace_id:string -> + ?dir:string -> unit -> - t

Open writer into a database file.

  • parameter append

    if true, append to existing records (default false)

  • parameter file

    if provided, path to the file

  • parameter dir

    directory into which to place the file if file not provided

  • parameter trace_id

    basename for the file if file not provided

  • parameter sync

    controls "PRAGMA SYNCHRONOUS". Default is `NORMAL which is safe; `OFF is much faster but might corrupt DB if the machin crashes. See https://sqlite.org/pragma.html#pragma_synchronous

val cycle_stmt : t -> unit

Close and recreate internal state.

val close : t -> unit

Close writer.

val write_string_l : t -> string list -> unit
val write_string : t -> string -> unit

Send a json encoded event. Thread safe.

\ No newline at end of file + t

Open writer into a database file.

  • parameter append

    if true, append to existing records (default false)

  • parameter file

    if provided, path to the file

  • parameter dir

    directory into which to place the file if file not provided

  • parameter trace_id

    basename for the file if file not provided

  • parameter sync

    controls "PRAGMA SYNCHRONOUS". Default is `NORMAL which is safe; `OFF is much faster but might corrupt DB if the machin crashes. See https://sqlite.org/pragma.html#pragma_synchronous

val cycle_stmt : t -> unit

Close and recreate internal state.

val close : t -> unit

Close writer.

val with_ : + ?sync:[ `OFF | `NORMAL | `FULL ] -> + ?append:bool -> + ?file:string -> + ?trace_id:string -> + ?dir:string -> + unit -> + (t -> 'a) -> + 'a
val write_string_l : t -> string list -> unit
val write_string : t -> string -> unit

Send a json encoded event. Thread safe.

\ No newline at end of file diff --git a/dev/catapult-sqlite/Catapult_sqlite/index.html b/dev/catapult-sqlite/Catapult_sqlite/index.html index 51ddc5b..db78ddf 100644 --- a/dev/catapult-sqlite/Catapult_sqlite/index.html +++ b/dev/catapult-sqlite/Catapult_sqlite/index.html @@ -1,2 +1,10 @@ -Catapult_sqlite (catapult-sqlite.Catapult_sqlite)

Module Catapult_sqlite

Backend that writes directly to a Sqlite database.

The database path is either directly provided with "TRACE_DB" or set_file, or it's a file named after the trace ID in the directory set by set_dir (or the default directory otherwise).

The trace ID is determined by "TRACE_ID" if present, otherwise auto-generated or set via set_trace_id.

include Catapult.IMPL
val setup : unit -> unit

Install the catapult logger as a profiling backend.

val teardown : unit -> unit
val with_setup : (unit -> 'a) -> 'a
val set_sqlite_sync : [ `OFF | `NORMAL | `FULL ] -> unit

Set level of crash safety for sqlite. See Writer.create for more details.

val enable : unit -> unit
val enabled : unit -> bool
val set_trace_id : string -> unit
val get_trace_id : unit -> string
val set_multiproc : bool -> unit

Multiprocess mode? If true, then the file will not be truncated.

val set_dir : string -> unit

Set directory in which to store the database by its trace ID.

val set_file : string -> unit

Set database path to use. If not specified, it will be picked from the trace ID, and the directory set_dir.

module Writer : sig ... end
module Backend : sig ... end
module Ev_to_json : sig ... end
\ No newline at end of file +Catapult_sqlite (catapult-sqlite.Catapult_sqlite)

Module Catapult_sqlite

Backend that writes directly to a Sqlite database.

Creating the database is done via Writer.create or Writer.with_. Then Backend can be used to turn this Writer.t into a Tracing collector.

module Writer : sig ... end

DB writer.

module Backend : sig ... end
val backend_of_writer : Writer.t -> Catapult.backend
val trace_collector_of_writer : Writer.t -> Trace_core.collector

Turn a writer into a Trace collector.

val with_ : + ?sync:[ `FULL | `NORMAL | `OFF ] -> + ?append:bool -> + ?file:string -> + ?trace_id:string -> + ?dir:string -> + unit -> + (unit -> 'a) -> + 'a

with_ () f runs f() in a scope where a connection to a Sqlite DB has been established and is used to store tracing events emitted from within f ().

\ No newline at end of file diff --git a/dev/catapult/Catapult/Adapt_backend/index.html b/dev/catapult/Catapult/Adapt_backend/index.html new file mode 100644 index 0000000..c812469 --- /dev/null +++ b/dev/catapult/Catapult/Adapt_backend/index.html @@ -0,0 +1,2 @@ + +Adapt_backend (catapult.Catapult.Adapt_backend)

Module Catapult.Adapt_backend

module type BACKEND = sig ... end
module type COLLECTOR = Trace_core.Collector.S
val adapt : (module BACKEND) -> (module COLLECTOR)

Adapt a Catapult backend as a Trace collector

\ No newline at end of file diff --git a/dev/catapult/Catapult/Adapt_backend/module-type-BACKEND/index.html b/dev/catapult/Catapult/Adapt_backend/module-type-BACKEND/index.html new file mode 100644 index 0000000..1a43982 --- /dev/null +++ b/dev/catapult/Catapult/Adapt_backend/module-type-BACKEND/index.html @@ -0,0 +1,15 @@ + +BACKEND (catapult.Catapult.Adapt_backend.BACKEND)

Module type Adapt_backend.BACKEND

val emit : + id:string option -> + name:string -> + ph:Event_type.t -> + tid:int -> + pid:int -> + cat:string list option -> + ts_us:float -> + args:(string * [< Catapult__.Backend.arg ]) list option -> + stack:string list option -> + dur:float option -> + ?extra:(string * string) list -> + unit -> + unit

Emit an event.

val tick : unit -> unit

Function that can be called regularly to ensure background work is done. Potentially useful for long-running processes.

val teardown : unit -> unit

Tear down backend once the program is shutting down.

\ No newline at end of file diff --git a/dev/catapult/Catapult/Arg/index.html b/dev/catapult/Catapult/Arg/index.html deleted file mode 100644 index 864fa56..0000000 --- a/dev/catapult/Catapult/Arg/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Arg (catapult.Catapult.Arg)

Module Catapult.Arg

Custom arguments.

These arguments can be emitted as part of most events, and can be used to store custom data, debug messages, etc.

type t = [
  1. | `Int of int
  2. | `String of string
  3. | `Float of float
  4. | `Bool of bool
  5. | `Null
]

Custum argument for events, spans, instants, etc.

\ No newline at end of file diff --git a/dev/catapult/Catapult/Tracing/Control/index.html b/dev/catapult/Catapult/Tracing/Control/index.html deleted file mode 100644 index 0819199..0000000 --- a/dev/catapult/Catapult/Tracing/Control/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Control (catapult.Catapult.Tracing.Control)

Module Tracing.Control

Controls the current backend.

val setup : backend option -> unit
val teardown : unit -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult/Tracing/Syntax/index.html b/dev/catapult/Catapult/Tracing/Syntax/index.html deleted file mode 100644 index e3f9909..0000000 --- a/dev/catapult/Catapult/Tracing/Syntax/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Syntax (catapult.Catapult.Tracing.Syntax)

Module Tracing.Syntax

val let@ : ('a -> 'b) -> 'a -> 'b
\ No newline at end of file diff --git a/dev/catapult/Catapult/Tracing/index.html b/dev/catapult/Catapult/Tracing/index.html deleted file mode 100644 index f973877..0000000 --- a/dev/catapult/Catapult/Tracing/index.html +++ /dev/null @@ -1,11 +0,0 @@ - -Tracing (catapult.Catapult.Tracing)

Module Catapult.Tracing

Profiling probes.

This is the main API. The user can insert probes into their code, and at runtime, these probes will use the Backend (if present) to emit tracing events to be replayed later. If no backend is present, the probes will do nothing.

type backend = (module Catapult__.Backend.S)
type arg = [
  1. | `Int of int
  2. | `String of string
  3. | `Float of float
  4. | `Bool of bool
  5. | `Null
]
type 'a emit_fun_base = - ?pid:int -> - ?tid:int -> - ?args:(string * arg) list -> - string -> - 'a

Emitter function, without timestamp. See emit_fun for more details.

type 'a with_cat = ?cat:string list -> 'a
type 'a with_ts_us = ?ts_us:float -> 'a
type 'a with_stack = ?stack:string list -> 'a

Function that can take a stack trace

type 'a emit_fun = 'a emit_fun_base with_cat with_ts_us

An emitter function. The positional string argument is the name.

  • parameter cat

    list of categories for filtering the event

  • parameter pid

    the process ID

  • parameter tid

    the thread ID

  • parameter arguments

    list of arguments for the event, with a name for each

  • parameter ts_us

    timestamp in microseconds

  • parameter name

    the name of this event

type span_start

Represents the beginning of a span, to emit compact spans

val null_span : span_start
val enabled : unit -> bool

Is tracing enabled?

val emit : (?dur:float -> Event_type.t -> unit) emit_fun with_stack

Emit a generic event.

val begin_ : unit -> span_start

Emit a "X" event with duration computed from the given span start

val with_ : ((unit -> 'a) -> 'a) emit_fun_base with_cat
val with1 : (('a -> 'b) -> 'a -> 'b) emit_fun_base with_cat
val with2 : (('a -> 'b -> 'c) -> 'a -> 'b -> 'c) emit_fun_base with_cat
val with3 : - (('a -> 'b -> 'c -> 'd) -> 'a -> 'b -> 'c -> 'd) emit_fun_base with_cat
val begin' : unit emit_fun with_stack

Emit a "B" event

val exit' : unit emit_fun with_stack

Emit a "E" event

val span : (dur:float -> unit) emit_fun with_stack

Emit a "X" event

val obj_new : (id:string -> unit) emit_fun with_stack
val obj_snap : (snapshot:string -> id:string -> unit) emit_fun with_stack
val obj_delete : (id:string -> unit) emit_fun with_stack
val obj_with : (id:string -> (unit -> 'a) -> 'a) emit_fun
val obj_with1 : (id:string -> ('a -> 'b) -> 'a -> 'b) emit_fun
val a_begin : (cat:string list -> id:string -> unit) emit_fun_base with_ts_us
val a_exit : (cat:string list -> id:string -> unit) emit_fun_base with_ts_us
val a_snap : (cat:string list -> id:string -> unit) emit_fun_base with_ts_us
val a_with : - (cat:string list -> id:string -> (unit -> 'a) -> 'a) emit_fun_base with_ts_us
val a_with1 : - (cat:string list -> id:string -> ('a -> 'b) -> 'a -> 'b) emit_fun_base - with_ts_us
val f_begin : (id:string -> unit) emit_fun
val f_exit : (id:string -> unit) emit_fun
val f_step : (id:string -> unit) emit_fun
val instant : unit emit_fun with_stack
val counter : (cs:(string * int) list -> unit) emit_fun
val meta_thread_name : string -> unit
val meta_process_name : string -> unit
val tick : unit -> unit

Depending on the tracing backend, this needs to be called regularly to ensure background work is done.

module Syntax : sig ... end
include module type of Syntax
val let@ : ('a -> 'b) -> 'a -> 'b
module Control : sig ... end

Controls the current backend.

\ No newline at end of file diff --git a/dev/catapult/Catapult/index.html b/dev/catapult/Catapult/index.html index 41f0012..2cab648 100644 --- a/dev/catapult/Catapult/index.html +++ b/dev/catapult/Catapult/index.html @@ -1,2 +1,2 @@ -Catapult (catapult.Catapult)

Module Catapult

Catapult-based tracing.

A nice profiling format based on json, useful for visualizing what goes on. This library is the instrumentation part; see catapult-client, catapult-file, or use a custom BACKEND to actually record traces.

If a trace is obtained in, say, the file "trace.json.gz", it can be opened in chrome/chromium at "chrome://tracing".

Tracy can import (uncompressed) trace files with a nice native trace explorer.

See the documentation of TEF

module type BACKEND = sig ... end
module type IMPL = sig ... end
module Arg : sig ... end

Custom arguments.

module Control = Tracing.Control
module Event_type : sig ... end

Event types.

module Nil_impl : sig ... end

Nil implementation.

module Tracing : sig ... end

Profiling probes.

\ No newline at end of file +Catapult (catapult.Catapult)

Module Catapult

Catapult-based tracing.

A nice profiling format based on json, useful for visualizing what goes on. This library is the instrumentation part; see catapult-client, catapult-file, or use a custom BACKEND to actually record traces.

If a trace is obtained in, say, the file "trace.json.gz", it can be opened in chrome/chromium at "chrome://tracing".

Tracy can import (uncompressed) trace files with a nice native trace explorer.

See the documentation of TEF

module type BACKEND = sig ... end
module type IMPL = sig ... end
type backend = (module BACKEND)
type arg = [
  1. | `Float of float
  2. | Trace_core.user_data
]
module Adapt_backend : sig ... end
module Event_type : sig ... end

Event types.

module Nil_impl : sig ... end

Nil implementation.

val trace_collector_of_backend : backend -> Trace_core.collector

Turn a catapult backend into a Trace collector

\ No newline at end of file diff --git a/dev/catapult/Catapult/module-type-BACKEND/index.html b/dev/catapult/Catapult/module-type-BACKEND/index.html index 5d1a5c6..a89f8df 100644 --- a/dev/catapult/Catapult/module-type-BACKEND/index.html +++ b/dev/catapult/Catapult/module-type-BACKEND/index.html @@ -7,7 +7,7 @@ pid:int -> cat:string list option -> ts_us:float -> - args:(string * Arg.t) list option -> + args:(string * [< Catapult__.Backend.arg ]) list option -> stack:string list option -> dur:float option -> ?extra:(string * string) list -> diff --git a/dev/catapult/Catapult_utils/Ev_to_json/index.html b/dev/catapult/Catapult_utils/Ev_to_json/index.html new file mode 100644 index 0000000..fead2a1 --- /dev/null +++ b/dev/catapult/Catapult_utils/Ev_to_json/index.html @@ -0,0 +1,2 @@ + +Ev_to_json (catapult.Catapult_utils.Ev_to_json)

Module Catapult_utils.Ev_to_json

val to_json : Stdlib.Buffer.t -> Ser.Event.t -> string
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Gc_stats/index.html b/dev/catapult/Catapult_utils/Gc_stats/index.html index db38010..1fef1d4 100644 --- a/dev/catapult/Catapult_utils/Gc_stats/index.html +++ b/dev/catapult/Catapult_utils/Gc_stats/index.html @@ -1,2 +1,2 @@ -Gc_stats (catapult.Catapult_utils.Gc_stats)

Module Catapult_utils.Gc_stats

val set_gc_interval_us : float -> unit

Set the interval, in microseconds, between 2 successive gathering of GC statistics, to be emitted as catapult counters.

val maybe_emit : now:float -> pid:int -> unit -> unit

This checks whether it has been long enough since we last emitted counters for the GC. If it has, then it emits the event and resets the clock.

  • parameter now

    latest timestamp in microseconds (See Catapult.Clock.now_us)

  • parameter pid

    PID of the current process

\ No newline at end of file +Gc_stats (catapult.Catapult_utils.Gc_stats)

Module Catapult_utils.Gc_stats

Utils to reflect GC statistics in traces

val set_gc_interval_us : float -> unit

Set the interval, in microseconds, between 2 successive gathering of GC statistics, to be emitted as catapult counters.

val maybe_emit : now:float -> pid:int -> unit -> unit

This checks whether it has been long enough since we last emitted counters for the GC. If it has, then it emits the event and resets the clock.

  • parameter now

    latest timestamp in microseconds (See Catapult.Clock.now_us)

  • parameter pid

    PID of the current process

\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Json_out/index.html b/dev/catapult/Catapult_utils/Json_out/index.html index 6a7f461..b11007e 100644 --- a/dev/catapult/Catapult_utils/Json_out/index.html +++ b/dev/catapult/Catapult_utils/Json_out/index.html @@ -1,9 +1,33 @@ -Json_out (catapult.Catapult_utils.Json_out)

Module Catapult_utils.Json_out

Basic output of json values to a buffer

val char : Stdlib.Buffer.t -> char -> unit
val raw_string : Stdlib.Buffer.t -> string -> unit
val int : Stdlib.Buffer.t -> int -> unit
val int64 : Stdlib.Buffer.t -> int64 -> unit
val float : Stdlib.Buffer.t -> float -> unit
val bool : Stdlib.Buffer.t -> bool -> unit
val null : Stdlib.Buffer.t -> unit
val str_val : Stdlib.Buffer.t -> string -> unit
val arg : +Json_out (catapult.Catapult_utils.Json_out)

Module Catapult_utils.Json_out

Basic output of json values to a buffer

type 'a arg = [ Catapult.arg | `List of 'a list ] as 'a

Extended kind of argument

val char : Stdlib.Buffer.t -> char -> unit
val raw_string : Stdlib.Buffer.t -> string -> unit
val int : Stdlib.Buffer.t -> int -> unit
val int64 : Stdlib.Buffer.t -> int64 -> unit
val float : Stdlib.Buffer.t -> float -> unit
val bool : Stdlib.Buffer.t -> bool -> unit
val null : Stdlib.Buffer.t -> unit
val str_val : Stdlib.Buffer.t -> string -> unit
val arg : Stdlib.Buffer.t -> [< `Bool of bool | `Float of float | `Int of int - | `Null - | `String of string ] -> + | `List of + [ `Bool of bool + | `Float of float + | `Int of int + | `List of 'b + | `None + | `String of string ] + list as 'b & 'a list + | `None + | `String of string ] as 'a -> + unit
val list : + Stdlib.Buffer.t -> + [< `Bool of bool + | `Float of float + | `Int of int + | `List of + [ `Bool of bool + | `Float of float + | `Int of int + | `List of 'b + | `None + | `String of string ] + list as 'b & 'a + | `None + | `String of string ] + list as 'a -> unit
val char_val : Stdlib.Buffer.t -> char -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Ser/Arg/index.html b/dev/catapult/Catapult_utils/Ser/Arg/index.html index b562121..d018d40 100644 --- a/dev/catapult/Catapult_utils/Ser/Arg/index.html +++ b/dev/catapult/Catapult_utils/Ser/Arg/index.html @@ -1,2 +1,2 @@ -Arg (catapult.Catapult_utils.Ser.Arg)

Module Ser.Arg

type t = {
  1. key : string;
  2. value : Arg_value.t;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file +Arg (catapult.Catapult_utils.Ser.Arg)

Module Ser.Arg

type t = {
  1. key : string;
  2. value : Arg_value.t;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Ser/Arg_value/index.html b/dev/catapult/Catapult_utils/Ser/Arg_value/index.html index 57275f6..f2d7b31 100644 --- a/dev/catapult/Catapult_utils/Ser/Arg_value/index.html +++ b/dev/catapult/Catapult_utils/Ser/Arg_value/index.html @@ -1,2 +1,2 @@ -Arg_value (catapult.Catapult_utils.Ser.Arg_value)

Module Ser.Arg_value

type t =
  1. | Int64 of int64
  2. | String of string
  3. | Bool of bool
  4. | Float64 of float
  5. | Void
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file +Arg_value (catapult.Catapult_utils.Ser.Arg_value)

Module Ser.Arg_value

type t =
  1. | Int64 of int64
  2. | String of string
  3. | Bool of bool
  4. | Float64 of float
  5. | Void
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Ser/Client_close_trace/index.html b/dev/catapult/Catapult_utils/Ser/Client_close_trace/index.html index f7e0c3e..e4502e0 100644 --- a/dev/catapult/Catapult_utils/Ser/Client_close_trace/index.html +++ b/dev/catapult/Catapult_utils/Ser/Client_close_trace/index.html @@ -1,2 +1,2 @@ -Client_close_trace (catapult.Catapult_utils.Ser.Client_close_trace)

Module Ser.Client_close_trace

type t = {
  1. trace_id : string;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file +Client_close_trace (catapult.Catapult_utils.Ser.Client_close_trace)

Module Ser.Client_close_trace

type t = {
  1. trace_id : string;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Ser/Client_emit/index.html b/dev/catapult/Catapult_utils/Ser/Client_emit/index.html index 40ba1df..42dea58 100644 --- a/dev/catapult/Catapult_utils/Ser/Client_emit/index.html +++ b/dev/catapult/Catapult_utils/Ser/Client_emit/index.html @@ -1,2 +1,2 @@ -Client_emit (catapult.Catapult_utils.Ser.Client_emit)

Module Ser.Client_emit

type t = {
  1. trace_id : string;
  2. ev : Event.t;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file +Client_emit (catapult.Catapult_utils.Ser.Client_emit)

Module Ser.Client_emit

type t = {
  1. trace_id : string;
  2. ev : Event.t;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Ser/Client_message/index.html b/dev/catapult/Catapult_utils/Ser/Client_message/index.html index f0fb4b3..b734037 100644 --- a/dev/catapult/Catapult_utils/Ser/Client_message/index.html +++ b/dev/catapult/Catapult_utils/Ser/Client_message/index.html @@ -1,2 +1,2 @@ -Client_message (catapult.Catapult_utils.Ser.Client_message)

Module Ser.Client_message

type t =
  1. | Client_open_trace of Client_open_trace.t
  2. | Client_close_trace of Client_close_trace.t
  3. | Client_emit of Client_emit.t
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file +Client_message (catapult.Catapult_utils.Ser.Client_message)

Module Ser.Client_message

type t =
  1. | Client_open_trace of Client_open_trace.t
  2. | Client_close_trace of Client_close_trace.t
  3. | Client_emit of Client_emit.t
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Ser/Client_open_trace/index.html b/dev/catapult/Catapult_utils/Ser/Client_open_trace/index.html index 3d53dfb..be96e7e 100644 --- a/dev/catapult/Catapult_utils/Ser/Client_open_trace/index.html +++ b/dev/catapult/Catapult_utils/Ser/Client_open_trace/index.html @@ -1,2 +1,2 @@ -Client_open_trace (catapult.Catapult_utils.Ser.Client_open_trace)

Module Ser.Client_open_trace

type t = {
  1. trace_id : string;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file +Client_open_trace (catapult.Catapult_utils.Ser.Client_open_trace)

Module Ser.Client_open_trace

type t = {
  1. trace_id : string;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Ser/Event/index.html b/dev/catapult/Catapult_utils/Ser/Event/index.html index 1fa7990..936218e 100644 --- a/dev/catapult/Catapult_utils/Ser/Event/index.html +++ b/dev/catapult/Catapult_utils/Ser/Event/index.html @@ -1,2 +1,2 @@ -Event (catapult.Catapult_utils.Ser.Event)

Module Ser.Event

type t = {
  1. id : string option;
  2. name : string;
  3. ph : int;
  4. pid : int64;
  5. tid : int64;
  6. cat : string array option;
  7. ts_us : float;
  8. args : Arg.t array option;
  9. stack : string array option;
  10. dur : float option;
  11. extra : Extra.t array option;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file +Event (catapult.Catapult_utils.Ser.Event)

Module Ser.Event

type t = {
  1. id : string option;
  2. name : string;
  3. ph : int;
  4. pid : int64;
  5. tid : int64;
  6. cat : string array option;
  7. ts_us : float;
  8. args : Arg.t array option;
  9. stack : string array option;
  10. dur : float option;
  11. extra : Extra.t array option;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/Ser/Extra/index.html b/dev/catapult/Catapult_utils/Ser/Extra/index.html index 485211d..02c15f9 100644 --- a/dev/catapult/Catapult_utils/Ser/Extra/index.html +++ b/dev/catapult/Catapult_utils/Ser/Extra/index.html @@ -1,2 +1,2 @@ -Extra (catapult.Catapult_utils.Ser.Extra)

Module Ser.Extra

type t = {
  1. key : string;
  2. value : string;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
val pp : Stdlib.Format.formatter -> t -> unit
\ No newline at end of file +Extra (catapult.Catapult_utils.Ser.Extra)

Module Ser.Extra

type t = {
  1. key : string;
  2. value : string;
}
val decode : Bare.Decode.t -> t
  • raises Invalid_argument

    in case of error.

val encode : Bare.Encode.t -> t -> unit
\ No newline at end of file diff --git a/dev/catapult/Catapult_utils/index.html b/dev/catapult/Catapult_utils/index.html index 7fc5565..c60d018 100644 --- a/dev/catapult/Catapult_utils/index.html +++ b/dev/catapult/Catapult_utils/index.html @@ -1,2 +1,2 @@ -Catapult_utils (catapult.Catapult_utils)

Module Catapult_utils

module Bare_encoding : sig ... end

BARE runtime library.

module Endpoint_address : sig ... end

Address for the daemon

module Gc_stats : sig ... end
module Json_out : sig ... end

Basic output of json values to a buffer

module Ser : sig ... end
module Thread_local : sig ... end

Basic thread-local storage.

\ No newline at end of file +Catapult_utils (catapult.Catapult_utils)

Module Catapult_utils

module Bare_encoding : sig ... end

BARE runtime library.

module Endpoint_address : sig ... end

Address for the daemon

module Ev_to_json : sig ... end
module Gc_stats : sig ... end

Utils to reflect GC statistics in traces

module Json_out : sig ... end

Basic output of json values to a buffer

module Ser : sig ... end
module Thread_local : sig ... end

Basic thread-local storage.

\ No newline at end of file