apolloFER / dd-trace-py

Datadog Tracing Python Client

dd-trace-py

For API docs see http://pypi.datadoghq.com/trace/docs/

Versions

Tracing client libraries will follow semver. While we are less than version 1.0, we'll increment the minor version number for backwards incompatible and significant changes. We'll increment the bugfix version for other changes.

This library is in beta so please pin your version numbers and do phased rollouts.

changelog

Development

Testing

The test suite requires many backing services (PostgreSQL, MySQL, Redis, ...) and we're using docker and docker-compose to start the service in the CI and in the developer machine. To launch properly the test matrix, please install docker and docker-compose using the instructions provided by your platform.

The test suite requires also tox to be ran. You can install it with:

$ pip install tox

You can launch the test matrix using the following rake command:

$ rake test

Or launch single tests manually:

$ docker-compose up -d
$ tox -e '{py36}-redis{210}'

Continuous Integration

We rely on CircleCI 2.0 for our tests. If you want to test how the CI behaves locally, you can use the CircleCI Command Line Interface as described here: https://circleci.com/docs/2.0/local-jobs/

After installing the circleci CLI, simply:

$ circleci build --job django

Benchmarks

When two or more approaches must be compared, please write a benchmark in the tests/benchmark.py module so that we can keep track of the most efficient algorithm. To run your benchmark, just:

$ python -m tests.benchmark