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

Fix docs

Browse source
This commit is contained in:
Shon Feder 2025-07-11 17:57:14 -04:00
parent 7cd3d0321b
commit a71fc32091
No known key found for this signature in database
1 changed files with 10 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
src/client/signal.mli
View file

@ -45,7 +45,7 @@ module Encode : sig
?encoder:Pbrt.Encoder.t ->
Opentelemetry_proto.Trace.resource_spans list ->
string
(** [metrics ts] is a protobuf encoded string of the traces [ts]
(** [traces ts] is a protobuf encoded string of the traces [ts]
@param encoder provide an encoder state to reuse *)
end
@ -53,19 +53,22 @@ end
(** Decode signals from protobuf encoded strings, received over the wire *)
module Decode : sig
val logs : string -> Opentelemetry_proto.Logs.resource_logs list
(** [logs ls] is a protobuf encoded string of the logs [ls]
(** [logs s] is a list of log resources decoded from the protobuf encoded
string [s].
@param encoder provide an encoder state to reuse *)
@raise Pbrt.Decoder.Failure if [s] is not a valid protobuf encoding. *)
val metrics : string -> Opentelemetry_proto.Metrics.resource_metrics list
(** [metrics ms] is a protobuf encoded string of the metrics [ms]
(** [metrics s] is a list of metrics resources decoded from the protobuf
encoded string [s].
@param encoder provide an encoder state to reuse *)
@raise Pbrt.Decoder.Failure if [s] is not a valid protobuf encoding. *)
val traces : string -> Opentelemetry_proto.Trace.resource_spans list
(** [metrics ts] is a protobuf encoded string of the traces [ts]
(** [traces s] is a list of span resources decoded from the protobuf encoded
string [s].
@param encoder provide an encoder state to reuse *)
@raise Pbrt.Decoder.Failure if [s] is not a valid protobuf encoding. *)
end
module Pp : sig