Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=ca92e7395495f73b46316607c514ce0dbe5fab129dddd9a17b353f835dcbf77d
sha512=ea2afd07c8db955364681f90388959db97d7b7f5b0836bc4045eca929968d6d77905e3aa66802226c0791c2552d0e281bdf2dbfe7ed90e9877ce3cedc343823f
Description
Added to opam-repository:
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
opentelemetryshould be used to instrument your code and possibly libraries. It doesn't communicate with anything except a backend (default: dummy backend); - library
opentelemetry-client-ocurlis a backend that communicates via http+protobuf with some collector (otelcol, datadog-agent, etc.) using cURL bindings; - library
opentelemetry-client-cohttp-lwtis a backend that communicates via http+protobuf with some collector using cohttp.
License
MIT
Features
- basic traces
- basic metrics
- basic logs
- nice API
- interface with
lwt sync collector relying on ocurl
- batching, perf, etc.
- async collector relying on ocurl-multi
- interface with
logs(carry context around) - implicit scope (via vendored
ambient-context, seeopentelemetry.ambient-context)
Use
For now, instrument traces/spans, logs, and metrics manually:
module Otel = Opentelemetry
let (let@) = (@@)
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; - optionally configure [ambient-context][] with the appropriate storage for your environment — TLS, Lwt, Eio…;
- and install a
Collector(usually by calling your collector'swith_setupfunction.)
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();
Opentelemetry_ambient_context.set_storage_provider (Opentelemetry_ambient_context_lwt.storage ());
Opentelemetry_client_ocurl.with_setup () @@ fun () ->
(* … *)
foo ();
(* … *)[ambient-context]: now vendored as opentelemetry.ambient-context, formerly https://v3.ocaml.org/p/ambient-context
Configuration
The library is configurable via Opentelemetry.Config, via the standard opentelemetry env variables, or with some custom environment variables.
OTEL_EXPORTER_OTLP_ENDPOINTsets the http endpoint to send signals toOTEL_OCAML_DEBUG=1to print some debug messages from the opentelemetry library ideOTEL_RESOURCE_ATTRIBUTESsets 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).
Do note that this backend uses a thread pool and is incompatible with uses of fork on some Unixy systems. See #68 for a possible workaround.
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)
Optional Dependencies
None
Used by
None
Conflicts
None
Build status
Results of building opentelemetry-client-ocurl with each compiler on check.ci.ocaml.org, run of against opam-repository 78c202b. All results for this package.
Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.
This version is not in the latest run; the versions below are.
| Version | OCaml 4.11 | OCaml 4.14 | OCaml 5.2 | OCaml 5.4 | OCaml 5.5 |
|---|---|---|---|---|---|
| 0.92 | n/a | good | good | good | good |
| 0.91.1 | good | good | good | good | good |
- good Package successfully built
- partial One of the dependencies failed to build
- bad Package failed to build
- n/a Package is not available in this environment
- internal Internal failure