diff --git a/trace-fuchsia/Trace_fuchsia_write/Argument/index.html b/trace-fuchsia/Trace_fuchsia_write/Argument/index.html index 480eeaf..6bb8043 100644 --- a/trace-fuchsia/Trace_fuchsia_write/Argument/index.html +++ b/trace-fuchsia/Trace_fuchsia_write/Argument/index.html @@ -1,5 +1,13 @@ -Argument (trace-fuchsia.Trace_fuchsia_write.Argument)

Module Trace_fuchsia_write.Argument

type 'a t = string * [< user_data | `Kid of int ] as 'a
val check_valid : 'a -> unit
val is_i32_ : int -> bool
val size_word : +Argument (trace-fuchsia.Trace_fuchsia_write.Argument)

Module Trace_fuchsia_write.Argument

type 'a t = string * [< user_data | `Kid of int ] as 'a
val check_valid_ : + [< `Bool of bool + | `Float of float + | `Int of int + | `Kid of int + | `None + | `String of string ] + t -> + unit
val is_i32_ : int -> bool
val size_word : [< `Bool of bool & 'a | `Float of float & 'b | `Int of int diff --git a/trace-fuchsia/Trace_fuchsia_write/Output/index.html b/trace-fuchsia/Trace_fuchsia_write/Output/index.html index 41b51bc..bbcb4fc 100644 --- a/trace-fuchsia/Trace_fuchsia_write/Output/index.html +++ b/trace-fuchsia/Trace_fuchsia_write/Output/index.html @@ -1,2 +1,2 @@ -Output (trace-fuchsia.Trace_fuchsia_write.Output)

Module Trace_fuchsia_write.Output

type t = {
  1. mutable buf : Buf.t;
  2. mutable send_buf : Buf.t -> unit;
  3. buf_pool : Buf_pool.t;
}
val create : buf_pool:Buf_pool.t -> send_buf:(Buf.t -> unit) -> unit -> t
val flush : t -> unit
val get_buf : t -> available_word:int -> Buf.t

Obtain a buffer with at least available bytes

val into_buffer : buf_pool:Buf_pool.t -> Stdlib.Buffer.t -> t
val dispose : t -> unit
\ No newline at end of file +Output (trace-fuchsia.Trace_fuchsia_write.Output)

Module Trace_fuchsia_write.Output

type t = {
  1. mutable buf : Buf.t;
  2. mutable send_buf : Buf.t -> unit;
  3. buf_pool : Buf_pool.t;
}
val create : buf_pool:Buf_pool.t -> send_buf:(Buf.t -> unit) -> unit -> t
val flush : t -> unit
val max_size_word : t -> int

Maximum size available, in words, for a single message

val get_buf : t -> available_word:int -> Buf.t

Obtain a buffer with at least available bytes

val into_buffer : buf_pool:Buf_pool.t -> Stdlib.Buffer.t -> t
val dispose : t -> unit
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/Str_ref/index.html b/trace-fuchsia/Trace_fuchsia_write/Str_ref/index.html index e560878..2f2f47a 100644 --- a/trace-fuchsia/Trace_fuchsia_write/Str_ref/index.html +++ b/trace-fuchsia/Trace_fuchsia_write/Str_ref/index.html @@ -1,2 +1,2 @@ -Str_ref (trace-fuchsia.Trace_fuchsia_write.Str_ref)

Module Trace_fuchsia_write.Str_ref

type t = int

16 bits

val inline : int -> t
\ No newline at end of file +Str_ref (trace-fuchsia.Trace_fuchsia_write.Str_ref)

Module Trace_fuchsia_write.Str_ref

type t = int

16 bits

val inline_fail_ : unit -> 'a
val inline : int -> t
\ No newline at end of file diff --git a/trace-fuchsia/Trace_fuchsia_write/index.html b/trace-fuchsia/Trace_fuchsia_write/index.html index ced7cc2..213080d 100644 --- a/trace-fuchsia/Trace_fuchsia_write/index.html +++ b/trace-fuchsia/Trace_fuchsia_write/index.html @@ -1,2 +1,2 @@ -Trace_fuchsia_write (trace-fuchsia.Trace_fuchsia_write)

Module Trace_fuchsia_write

Write fuchsia events into buffers.

Reference: https://fuchsia.dev/fuchsia-src/reference/tracing/trace-format

module Util : sig ... end
module Buf : sig ... end
module Output : sig ... end
module Buf_pool : sig ... end
type user_data = Trace_core.user_data
module I64 : sig ... end
module Str_ref : sig ... end
module Thread_ref : sig ... end
module Metadata : sig ... end

record type = 0

module Argument : sig ... end
module Arguments : sig ... end
module Thread_record : sig ... end

record type = 3

module Event : sig ... end

record type = 4

module Kernel_object : sig ... end

record type = 7

\ No newline at end of file +Trace_fuchsia_write (trace-fuchsia.Trace_fuchsia_write)

Module Trace_fuchsia_write

Write fuchsia events into buffers.

Reference: https://fuchsia.dev/fuchsia-src/reference/tracing/trace-format

module Util : sig ... end
module Buf : sig ... end
module Output : sig ... end
module Buf_pool : sig ... end
type user_data = Trace_core.user_data
module I64 : sig ... end
module Str_ref : sig ... end
val truncate_string : string -> string

truncate_string s truncates s to the maximum length allowed for strings. If s is already short enough, no allocation is done.

module Thread_ref : sig ... end
module Metadata : sig ... end

record type = 0

module Argument : sig ... end
module Arguments : sig ... end
module Thread_record : sig ... end

record type = 3

module Event : sig ... end

record type = 4

module Kernel_object : sig ... end

record type = 7

\ No newline at end of file diff --git a/trace/Trace_core/Collector/index.html b/trace/Trace_core/Collector/index.html deleted file mode 100644 index 015d582..0000000 --- a/trace/Trace_core/Collector/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Collector (trace.Trace_core.Collector)

Module Trace_core.Collector

A global collector.

The collector, if present, is responsible for collecting messages and spans, and storing them, recording them, forward them, or offering them to other services and processes.

val dummy_span : int64
val dummy_explicit_span : Trace_core__.Types.explicit_span
module type S = sig ... end

Signature for a collector.

\ No newline at end of file diff --git a/trace/Trace_core/Collector/module-type-S/index.html b/trace/Trace_core/Collector/module-type-S/index.html deleted file mode 100644 index 74c76cd..0000000 --- a/trace/Trace_core/Collector/module-type-S/index.html +++ /dev/null @@ -1,95 +0,0 @@ - -S (trace.Trace_core.Collector.S)

Module type Collector.S

Signature for a collector.

This is only relevant to implementors of tracing backends; to instrument your code you only need to look at the Trace module.

val with_span : - __FUNCTION__:string option -> - __FILE__:string -> - __LINE__:int -> - data: - (string - * [ `Int of int - | `String of string - | `Bool of bool - | `Float of float - | `None ]) - list -> - string -> - (int64 -> 'a) -> - 'a

Run the function in a new span.

This replaces the previous enter_span and exit_span which were too flexible to be efficient to implement in async contexts.

  • since 0.3
val enter_span : - __FUNCTION__:string option -> - __FILE__:string -> - __LINE__:int -> - data: - (string - * [ `Int of int - | `String of string - | `Bool of bool - | `Float of float - | `None ]) - list -> - string -> - int64

Enter a new implicit span. For many uses cases, with_span will be easier to use.

  • since 0.6
val exit_span : int64 -> unit

Exit span. This should be called on the same thread as the corresponding enter_span, and nest properly with other calls to enter/exit_span and with_span.

  • since 0.6
val enter_manual_span : - parent:Trace_core__.Types.explicit_span option -> - flavor:[ `Sync | `Async ] option -> - __FUNCTION__:string option -> - __FILE__:string -> - __LINE__:int -> - data: - (string - * [ `Int of int - | `String of string - | `Bool of bool - | `Float of float - | `None ]) - list -> - string -> - Trace_core__.Types.explicit_span

Enter an explicit span. Surrounding scope, if any, is provided by parent, and this function can store as much metadata as it wants in the hmap in the explicit_span's meta field.

This means that the collector doesn't need to implement contextual storage mapping span to scopes, metadata, etc. on its side; everything can be transmitted in the explicit_span.

  • since 0.3
val exit_manual_span : Trace_core__.Types.explicit_span -> unit

Exit an explicit span.

  • since 0.3
val add_data_to_span : - int64 -> - (string - * [ `Int of int - | `String of string - | `Bool of bool - | `Float of float - | `None ]) - list -> - unit
  • since Adds data to the current span.

0.4

val add_data_to_manual_span : - Trace_core__.Types.explicit_span -> - (string - * [ `Int of int - | `String of string - | `Bool of bool - | `Float of float - | `None ]) - list -> - unit

Adds data to the given span.

  • since 0.4
val message : - ?span:int64 -> - data: - (string - * [ `Int of int - | `String of string - | `Bool of bool - | `Float of float - | `None ]) - list -> - string -> - unit

Emit a message with associated metadata.

val name_thread : string -> unit

Give a name to the current thread.

val name_process : string -> unit

Give a name to the current process.

val counter_int : - data: - (string - * [ `Int of int - | `String of string - | `Bool of bool - | `Float of float - | `None ]) - list -> - string -> - int -> - unit

Integer counter.

val counter_float : - data: - (string - * [ `Int of int - | `String of string - | `Bool of bool - | `Float of float - | `None ]) - list -> - string -> - float -> - unit

Float counter.

val shutdown : unit -> unit

Shutdown collector, possibly waiting for it to finish sending data.

\ No newline at end of file diff --git a/trace/Trace_core/Meta_map/Key/index.html b/trace/Trace_core/Meta_map/Key/index.html deleted file mode 100644 index 727dd7f..0000000 --- a/trace/Trace_core/Meta_map/Key/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Key (trace.Trace_core.Meta_map.Key)

Module Meta_map.Key

Keys with a type witness.

type 'a t

A key of type 'a t is used to access the portion of the map or table that associates keys of type 'a to values.

val create : unit -> 'a t

Make a new key. This is generative, so calling create () twice with the same return type will produce incompatible keys that cannot see each other's bindings.

val equal : 'a t -> 'a t -> bool

Compare two keys that have compatible types.

\ No newline at end of file diff --git a/trace/Trace_core/Meta_map/index.html b/trace/Trace_core/Meta_map/index.html deleted file mode 100644 index 27abef0..0000000 --- a/trace/Trace_core/Meta_map/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Meta_map (trace.Trace_core.Meta_map)

Module Trace_core.Meta_map

Associative containers with Heterogeneous Values

module Key : sig ... end

Keys with a type witness.

type pair =
  1. | Pair : 'a Key.t * 'a -> pair
type t

Immutable map from Key.t to values

val empty : t
val mem : _ Key.t -> t -> bool
val add : 'a Key.t -> 'a -> t -> t
val remove : _ Key.t -> t -> t
val length : t -> int
val cardinal : t -> int
val find : 'a Key.t -> t -> 'a option
val find_exn : 'a Key.t -> t -> 'a
  • raises Not_found

    if the key is not in the table.

val iter : (pair -> unit) -> t -> unit
val add_list : t -> pair list -> t
val of_list : pair list -> t
val to_list : t -> pair list
\ No newline at end of file diff --git a/trace/Trace_private_util/B_queue/index.html b/trace/Trace_private_util/B_queue/index.html deleted file mode 100644 index 193dbc8..0000000 --- a/trace/Trace_private_util/B_queue/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -B_queue (trace.Trace_private_util.B_queue)

Module Trace_private_util.B_queue

Basic Blocking Queue

type 'a t
val create : unit -> _ t
exception Closed
val push : 'a t -> 'a -> unit

push q x pushes x into q, and returns ().

  • raises Closed

    if close q was previously called.

val pop_all : 'a t -> 'a list

pop_all bq returns all items presently in bq, in the same order, and clears bq. It blocks if no element is in bq.

val close : _ t -> unit

Close the queue, meaning there won't be any more push allowed.

\ No newline at end of file diff --git a/trace/Trace_private_util/Domain_util/index.html b/trace/Trace_private_util/Domain_util/index.html deleted file mode 100644 index 2448442..0000000 --- a/trace/Trace_private_util/Domain_util/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Domain_util (trace.Trace_private_util.Domain_util)

Module Trace_private_util.Domain_util

val cpu_relax : unit -> unit
val n_domains : unit -> int
\ No newline at end of file diff --git a/trace/Trace_private_util/Mpsc_bag/index.html b/trace/Trace_private_util/Mpsc_bag/index.html deleted file mode 100644 index 0d8f1c5..0000000 --- a/trace/Trace_private_util/Mpsc_bag/index.html +++ /dev/null @@ -1,2 +0,0 @@ - -Mpsc_bag (trace.Trace_private_util.Mpsc_bag)

Module Trace_private_util.Mpsc_bag

A multi-producer, single-consumer bag

type 'a t
val create : unit -> 'a t
val add : 'a t -> 'a -> unit

add q x adds x in the bag.

val pop_all : 'a t -> 'a list option

Return all current items in the insertion order.

\ No newline at end of file