Skip to content

jpaulgs/dd-trace-rb

 
 

Repository files navigation

Datadog Trace Client

CircleCI

ddtrace is Datadog’s tracing client for Ruby. It is used to trace requests as they flow across web servers, databases and microservices so that developers have great visiblity into bottlenecks and troublesome requests.

Getting started

For a basic product overview, check out our setup documentation.

For installation, configuration, and details about using the API, check out our API documentation and gem documentation.

For descriptions of terminology used in APM, take a look at the official documentation.

Development

Testing

Configure your environment through:

$ bundle install
$ appraisal install

You can launch tests using the following Rake commands:

$ rake test:main                                      # tracer tests
$ appraisal rails<version>-<database> rake test:rails # tests Rails matrix
$ appraisal contrib rake test:redis                   # tests Redis integration
...

Run rake --tasks for the list of available Rake tasks. Run appraisal list for the list of available appraisals.

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

$ docker-compose up -d

We also enforce the Ruby community-driven style guide through Rubocop. Simply launch:

$ rake rubocop

Packages

No packages published

Languages

  • Ruby 98.9%
  • Roff 1.1%