package opentelemetry
Install
Dune Dependency
Authors
Maintainers
Sources
md5=9ad1b47bf8134a97ae45420462a76e5f
sha512=1407cbee7a70dccc9bd4ab2e6414706db5ef017b862eb8aabd1bad261179dd8472f98d4177d2dd1ceb975e662c3577715401887d1ca8a79fa3afe8777c08f10a
Description
README
Opentelemetry
This project provides an API for instrumenting server software using opentelemetry, as well as connectors to talk to opentelemetry software such as jaeger.
library
opentelemetry
should be used to instrument your code and possibly libraries. It doesn't communicate with anything except a backend (default: dummy backend)library
opentelemetry-client-ocurl
is a backend that communicates via http+protobuf with some collector (otelcol, datadog-agent, etc.)
License
MIT
Features
[x] basic traces
[x] basic metrics
[x] basic logs
[ ] nice API
[x] interface with
lwt
[x] sync collector relying on ocurl
[x] batching, perf, etc.
[ ] async collector relying on ocurl-multi
[ ] interface with
logs
(carry context around)
Use
For now, instrument manually:
module Otel = Opentelemetry
let (let@) f x = f x
let foo () =
let@ scope = Otel.Trace.with_ "foo"
~attrs:["hello", `String "world"] in
do_work();
Otel.Metrics.(
emit [
gauge ~name:"foo.x" [int 42];
]);
do_more_work();
()
let main () =
Otel.Globals.service_name := "my_service";
Otel.GC_metrics.basic_setup();
Opentelemetry_client_ocurl.with_setup () @@ fun () ->
(* … *)
foo ();
(* … *)
Configuration
The library is configurable via Opentelemetry.Config
, via the standard opentelemetry env variables, or with some custom environment variables.
OTEL_EXPORTER_OTLP_ENDPOINT
sets the http endpoint to send signals toOTEL_OCAML_DEBUG=1
to print some debug messages from the opentelemetry library ideOTEL_RESOURCE_ATTRIBUTES
sets a comma separated list of custom resource attributes
Collector opentelemetry-client-ocurl
This is a synchronous collector that uses the http+protobuf format to send signals (metrics, traces) to some other collector (eg. otelcol
or the datadog agent).
License
MIT
Semantic Conventions
Not supported yet.
Dev Dependencies (1)
-
odoc
with-doc
Used by (4)
-
opentelemetry-client-cohttp-lwt
< "0.5"
-
opentelemetry-client-ocurl
= "0.4"
-
opentelemetry-cohttp-lwt
= "0.4"
-
opentelemetry-lwt
= "0.4"
Conflicts
None