Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add dev notes. #114

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add dev notes. #114

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions DEV.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.