simon/ocaml-trace
1
0
Fork 0
mirror of https://github.com/ocaml-tracing/ocaml-trace.git synced 2026-03-07 18:37:56 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

readme

Browse source
This commit is contained in:
Simon Cruanes 2026-01-20 20:34:43 -05:00
parent 6f3b487f35
commit f1633fdcff
No known key found for this signature in database
GPG key ID: EBFFF6F283F3A2B4
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -1,7 +1,7 @@
# Trace # Trace
[![Build and Test](https://github.com/c-cube/ocaml-trace/actions/workflows/main.yml/badge.svg)](https://github.com/c-cube/ocaml-trace/actions/workflows/main.yml) [![Build and Test](https://github.com/ocaml-tracing/ocaml-trace/actions/workflows/main.yml/badge.svg)](https://github.com/ocaml-tracing/ocaml-trace/actions/workflows/main.yml)
This small library provides basic types that can be used to instrument This small library provides basic types that can be used to instrument
a library or application, either by hand or via a ppx. a library or application, either by hand or via a ppx.
@ -138,7 +138,7 @@ In your `library` or `executable` stanza, add: `(preprocess (pps ppx_trace))`.
The dependency on `trace.core` is automatically added. You still need to The dependency on `trace.core` is automatically added. You still need to
configure a backend to actually do collection. configure a backend to actually do collection.
## Backends ## Backends (collector implementations)
Concrete tracing or observability formats such as: Concrete tracing or observability formats such as:
@ -154,14 +154,15 @@ Concrete tracing or observability formats such as:
This requires the rust `tldrs` program to be in path. This requires the rust `tldrs` program to be in path.
* ~~[ ] richer bindings with [ocaml-catapult](https://github.com/imandra-ai/catapult), * ~~[ ] richer bindings with [ocaml-catapult](https://github.com/imandra-ai/catapult),
with multi-process backends, etc.~~ (subsumed by tldrs) with multi-process backends, etc.~~ (subsumed by tldrs)
- [x] Tracy (see [ocaml-tracy](https://github.com/imandra-ai/ocaml-tracy), more specifically `tracy-client.trace`) - [x] Tracy (see [ocaml-tracy](https://github.com/ocaml-tracing/ocaml-tracy), more specifically `tracy-client.trace`)
- [x] Opentelemetry (see [ocaml-opentelemetry](https://github.com/imandra-ai/ocaml-opentelemetry/), in `opentelemetry.trace`) - [x] Opentelemetry (see [ocaml-opentelemetry](https://github.com/ocaml-tracing/ocaml-opentelemetry/), in `opentelemetry.trace`)
- [ ] landmarks? - [ ] landmarks?
- [ ] native perfetto backend
- [ ] OCaml runtime events
- [ ] Logs (only for messages, obviously) - [ ] Logs (only for messages, obviously)
Collectors are now more composable and replace `trace.subscribers`.
## Subscribers ## Subscribers
The library `trace.subscriber` defines composable _subscribers_, which are sets of callbacks Not a thing anymore.
that consume tracing events.
Multiple subscribers can be aggregated together (with events being dispatched to all of them)
and be installed as a normal _collector_.