mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-09 04:17:56 -04:00
Fix docs
This commit is contained in:
parent
7cd3d0321b
commit
a71fc32091
1 changed files with 10 additions and 7 deletions
|
|
@ -45,7 +45,7 @@ module Encode : sig
|
||||||
?encoder:Pbrt.Encoder.t ->
|
?encoder:Pbrt.Encoder.t ->
|
||||||
Opentelemetry_proto.Trace.resource_spans list ->
|
Opentelemetry_proto.Trace.resource_spans list ->
|
||||||
string
|
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 *)
|
@param encoder provide an encoder state to reuse *)
|
||||||
end
|
end
|
||||||
|
|
@ -53,19 +53,22 @@ end
|
||||||
(** Decode signals from protobuf encoded strings, received over the wire *)
|
(** Decode signals from protobuf encoded strings, received over the wire *)
|
||||||
module Decode : sig
|
module Decode : sig
|
||||||
val logs : string -> Opentelemetry_proto.Logs.resource_logs list
|
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
|
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
|
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
|
end
|
||||||
|
|
||||||
module Pp : sig
|
module Pp : sig
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue