From 798f5f0917ff66adbd4be035cfebb40143a171b6 Mon Sep 17 00:00:00 2001 From: Carlos Alberto Cortez Date: Fri, 2 Aug 2024 22:31:00 +0200 Subject: [PATCH] Add dev notes. --- DEV.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 DEV.md diff --git a/DEV.md b/DEV.md new file mode 100644 index 0000000..32eaf12 --- /dev/null +++ b/DEV.md @@ -0,0 +1,28 @@ +# Development Notes + +## Makefile + +`Makefile`s are used to encapsulate the various tools in the toolchain: + +```bash +make bootstrap # install dependencies +make test # test using different Python versions +make lint # use a linter to check format +``` + +NOTE: To publish, see the [Release documentation](RELEASING.md). + +# Architecture + +For a general overview of Ligthstep Tracers, see [Lightstep Tracers Spec](https://github.com/lightstep/specs). + +This Tracer supports two transports: + +* **Protobuf/http** (preferred). +* **Thrift** (least preferred). + +Three propagation formats are supported: + +* Custom Lightstep format (see the Lightstep Tracers Spec mentioned above). +* B3. +* Custom Binary format (_very_ least preferred), based on protobuf.