package opentelemetry-lwt
Install
Dune Dependency
Authors
Maintainers
Sources
md5=bb3860b2d9941bbb3680aef45f8db3d8
sha512=a66f9781fdef825addefa3a9c425a454c98f388ae0e476cf216a555d1573291347668a9aa6461ae17074b17504622cd77bbb2302edb55d18b32324d112e782ff
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)[x] implicit scope (via ambient-context)
Use
For now, instrument traces/spans, logs, and metrics 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();
()
Setup
If you're writing a top-level application, you need to perform some initial configuration.
Set the
service_name
;configure our ambient-context dependency with the appropriate storage for your environment — TLS, Lwt, Eio ... (see their docs for more details);
and install a
Collector
(usually by calling your collector'swith_setup
function.)
For example, if your application is using Lwt, and you're using ocurl
as your collector, you might do something like this:
let main () =
Otel.Globals.service_name := "my_service";
Otel.GC_metrics.basic_setup();
Ambient_context.with_storage_provider (Ambient_context_lwt.storage ()) @@ fun () ->
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, logs) to some other collector (eg. otelcol
or the datadog agent).
Collector opentelemetry-client-cohttp-lwt
This is a Lwt-friendly collector that uses cohttp to send signals to some other collector (e.g. otelcol
). It must be run inside a Lwt_main.run
scope.
Opentelemetry-trace
The optional library opentelemetry.trace
, present if trace is installed, provides a collector for trace
. This collector forwards and translates events from trace
into opentelemetry
. It's only useful if there also is also a OTEL collector.
License
MIT
Semantic Conventions
Not supported yet.
Dependencies (6)
-
lwt_ppx
>= "2.0"
-
lwt
>= "5.3"
-
opentelemetry
= version
- ambient-context
-
ocaml
>= "4.08"
-
dune
>= "2.7"
Dev Dependencies (5)
-
opentelemetry-client-ocurl
with-test & = version
-
opentelemetry-client-cohttp-lwt
with-test & = version
-
alcotest
with-test
-
odoc
with-doc
-
cohttp-lwt-unix
with-test
Used by (1)
-
opentelemetry-cohttp-lwt
= "0.6"
Conflicts
None