mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-10 04:35:46 -04:00
a44c50581b
- Regenerate proto bindings with yojson support - Add JSON encoding path in Resource_signal.Encode - Pass protocol from config to generic_http_consumer - Set Content-Type/Accept headers based on protocol - Remove hardcoded protobuf headers from all HTTP client implementations - Add yojson dependency
144 lines
4.1 KiB
OCaml
144 lines
4.1 KiB
OCaml
(** Constructing and managing OTel
|
|
{{:https://opentelemetry.io/docs/concepts/signals/} signals} at the resource
|
|
(batch) level *)
|
|
|
|
open Common_
|
|
|
|
(** The type of signals
|
|
|
|
This is not the principle type of signals from the perspective of what gets
|
|
encoded and sent via protocl buffers, but it is the principle type that
|
|
collector clients needs to reason about. *)
|
|
type t =
|
|
| Traces of Opentelemetry_proto.Trace.resource_spans list
|
|
| Metrics of Opentelemetry_proto.Metrics.resource_metrics list
|
|
| Logs of Opentelemetry_proto.Logs.resource_logs list
|
|
|
|
val pp : Format.formatter -> t -> unit
|
|
|
|
val of_logs :
|
|
?service_name:string ->
|
|
?attrs:OTEL.Key_value.t list ->
|
|
Proto.Logs.log_record list ->
|
|
t
|
|
|
|
val of_logs_or_empty :
|
|
?service_name:string ->
|
|
?attrs:OTEL.Key_value.t list ->
|
|
Proto.Logs.log_record list ->
|
|
t list
|
|
|
|
val of_spans :
|
|
?service_name:string -> ?attrs:OTEL.Key_value.t list -> OTEL.Span.t list -> t
|
|
|
|
val of_spans_or_empty :
|
|
?service_name:string ->
|
|
?attrs:OTEL.Key_value.t list ->
|
|
OTEL.Span.t list ->
|
|
t list
|
|
|
|
val of_metrics :
|
|
?service_name:string ->
|
|
?attrs:OTEL.Key_value.t list ->
|
|
Proto.Metrics.metric list ->
|
|
t
|
|
|
|
val of_metrics_or_empty :
|
|
?service_name:string ->
|
|
?attrs:OTEL.Key_value.t list ->
|
|
Proto.Metrics.metric list ->
|
|
t list
|
|
|
|
val of_signal_l :
|
|
?service_name:string ->
|
|
?attrs:OTEL.Key_value.t list ->
|
|
OTEL.Any_signal_l.t ->
|
|
t
|
|
|
|
val to_traces : t -> Opentelemetry_proto.Trace.resource_spans list option
|
|
|
|
val to_metrics : t -> Opentelemetry_proto.Metrics.resource_metrics list option
|
|
|
|
val to_logs : t -> Opentelemetry_proto.Logs.resource_logs list option
|
|
|
|
val is_traces : t -> bool
|
|
|
|
val is_metrics : t -> bool
|
|
|
|
val is_logs : t -> bool
|
|
|
|
type protocol = Exporter_config.protocol =
|
|
| Http_protobuf
|
|
| Http_json
|
|
|
|
(** Encode signals to protobuf or JSON encoded strings, ready to be sent over
|
|
the wire *)
|
|
module Encode : sig
|
|
val logs :
|
|
?encoder:Pbrt.Encoder.t ->
|
|
?protocol:protocol ->
|
|
Opentelemetry_proto.Logs.resource_logs list ->
|
|
string
|
|
(** [logs ls] is an encoded string of the logs [ls].
|
|
|
|
@param encoder provide an encoder state to reuse (protobuf only)
|
|
@param protocol encoding protocol to use (default: Http_protobuf) *)
|
|
|
|
val metrics :
|
|
?encoder:Pbrt.Encoder.t ->
|
|
?protocol:protocol ->
|
|
Opentelemetry_proto.Metrics.resource_metrics list ->
|
|
string
|
|
(** [metrics ms] is an encoded string of the metrics [ms].
|
|
|
|
@param encoder provide an encoder state to reuse (protobuf only)
|
|
@param protocol encoding protocol to use (default: Http_protobuf) *)
|
|
|
|
val traces :
|
|
?encoder:Pbrt.Encoder.t ->
|
|
?protocol:protocol ->
|
|
Opentelemetry_proto.Trace.resource_spans list ->
|
|
string
|
|
(** [traces ts] is an encoded string of the traces [ts].
|
|
|
|
@param encoder provide an encoder state to reuse (protobuf only)
|
|
@param protocol encoding protocol to use (default: Http_protobuf) *)
|
|
|
|
val any : ?encoder:Pbrt.Encoder.t -> ?protocol:protocol -> t -> string
|
|
end
|
|
|
|
(** Decode signals from protobuf encoded strings, received over the wire *)
|
|
module Decode : sig
|
|
val logs : string -> Opentelemetry_proto.Logs.resource_logs list
|
|
(** [logs s] is a list of log resources decoded from the protobuf encoded
|
|
string [s].
|
|
|
|
@raise Pbrt.Decoder.Failure if [s] is not a valid protobuf encoding. *)
|
|
|
|
val metrics : string -> Opentelemetry_proto.Metrics.resource_metrics list
|
|
(** [metrics s] is a list of metrics resources decoded from the protobuf
|
|
encoded string [s].
|
|
|
|
@raise Pbrt.Decoder.Failure if [s] is not a valid protobuf encoding. *)
|
|
|
|
val traces : string -> Opentelemetry_proto.Trace.resource_spans list
|
|
(** [traces s] is a list of span resources decoded from the protobuf encoded
|
|
string [s].
|
|
|
|
@raise Pbrt.Decoder.Failure if [s] is not a valid protobuf encoding. *)
|
|
end
|
|
|
|
module Pp : sig
|
|
val logs :
|
|
Format.formatter -> Opentelemetry_proto.Logs.resource_logs list -> unit
|
|
|
|
val metrics :
|
|
Format.formatter ->
|
|
Opentelemetry_proto.Metrics.resource_metrics list ->
|
|
unit
|
|
|
|
val traces :
|
|
Format.formatter -> Opentelemetry_proto.Trace.resource_spans list -> unit
|
|
|
|
val pp : Format.formatter -> t -> unit
|
|
end
|