ddtrace 0.7.2 → 0.8.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MWNlZDk5MDNlMGM5NzgyN2Q2Y2M1NTA5MTNiMmQ5Yzk3ZGI2YzY2Mg==
-  data.tar.gz: !binary |-
-    MmE4OWFjODQ4NjI1ZDY5MzQyNWQxODg0MjhmNzczODNhOWEzZWE2Yg==
+SHA1:
+  metadata.gz: 32267c0f9a646b5c68fec68446808b0338aee9fe
+  data.tar.gz: fe7fb33d51a89cc592aa83c6b52c0b5347d35d68
 SHA512:
-  metadata.gz: !binary |-
-    YjlkYjJlNjdlY2U1YTg1ZTE3ZmUwMTY0MzM5YzYzNzNlMWI4NGFkZTAzYTZi
-    MjJmMjNmODllNmVkNDFjYTUyOTZiMmVjZTM0MjlmZDE5YzRhOGI2NWM1MTMx
-    OTQyZjVmMDM2ZWM1MDY1NDNjNTdiMDY0YWU3NTYwYjViNTZiNjQ=
-  data.tar.gz: !binary |-
-    YzYwYmRlODlhY2YxY2E2NjJmOWI2N2M1MTQ4YTQzN2JhMWE2NTE5ODIwZDk1
-    ODNiNzk4ZTU2ZGY1ZGQyZmI3YjhkMzUyNzNjNDQyNThhZDY3YTM5MzFjMzk3
-    ZjNhNjkxMjk4Yjc4YTRmZWY5YjRiYTdiMTA0NDAyMTA1MDEzZDM=
+  metadata.gz: 477f468fb2959ad9d5e48485ec3688d8c2368ce11784903ae76c820748b1772df99f50b25818647320ae4cad7dc7811847616c551092daa18a0fdc9fae883320
+  data.tar.gz: 777c16f17819d7d32f2c4d8544761690344ddac5473bd5ac0b2af45d6428d80c4db7bbbd7129a85780d1bb6fbb6cc60d9abe402dc60d8030fdaf2796643bc18f

data/Appraisals

@@ -1,6 +1,6 @@
-if RUBY_VERSION < '2.4.0'
+if RUBY_VERSION < '2.4.0' && RUBY_PLATFORM != 'java'
   if RUBY_VERSION >= '1.9.1'
-    appraise 'rails3-mysql2' do
+    appraise 'rails32-mysql2' do
       gem 'test-unit'
       gem 'rails', '3.2.22.5'
       gem 'mysql2', '0.3.21', platform: :ruby
@@ -10,27 +10,46 @@ if RUBY_VERSION < '2.4.0'
   end
 
   if RUBY_VERSION >= '1.9.1'
-    appraise 'rails3-postgres' do
+    appraise 'rails30-postgres' do
       gem 'test-unit'
-      gem 'rails', '3.2.22.5'
+      gem 'rails', '3.0.20'
       gem 'pg', '0.15.1', platform: :ruby
       gem 'activerecord-jdbcpostgresql-adapter', platform: :jruby
     end
 
-    appraise 'rails3-postgres-redis' do
+    if RUBY_VERSION < '2.2.2'
+      appraise 'rails30-postgres-sidekiq' do
+        gem 'test-unit'
+        gem 'rails', '3.0.20'
+        gem 'pg', '0.15.1', platform: :ruby
+        gem 'activerecord-jdbcpostgresql-adapter', platform: :jruby
+        gem 'sidekiq', '4.0.0'
+      end
+    end
+
+    appraise 'rails32-postgres' do
       gem 'test-unit'
       gem 'rails', '3.2.22.5'
       gem 'pg', '0.15.1', platform: :ruby
       gem 'activerecord-jdbcpostgresql-adapter', platform: :jruby
-      gem 'redis-rails'
     end
 
-    appraise 'rails3-postgres-sidekiq' do
+    appraise 'rails32-postgres-redis' do
       gem 'test-unit'
       gem 'rails', '3.2.22.5'
       gem 'pg', '0.15.1', platform: :ruby
       gem 'activerecord-jdbcpostgresql-adapter', platform: :jruby
-      gem 'sidekiq'
+      gem 'redis-rails'
+    end
+
+    if RUBY_VERSION < '2.2.2'
+      appraise 'rails32-postgres-sidekiq' do
+        gem 'test-unit'
+        gem 'rails', '3.2.22.5'
+        gem 'pg', '0.15.1', platform: :ruby
+        gem 'activerecord-jdbcpostgresql-adapter', platform: :jruby
+        gem 'sidekiq', '4.0.0'
+      end
     end
   end
 
@@ -53,17 +72,9 @@ if RUBY_VERSION < '2.4.0'
       gem 'activerecord-jdbcpostgresql-adapter', platform: :jruby
       gem 'redis-rails'
     end
-
-    appraise 'rails4-postgres-sidekiq' do
-      gem 'rails', '4.2.7.1'
-      gem 'pg', platform: :ruby
-      gem 'activerecord-jdbcpostgresql-adapter', platform: :jruby
-      gem 'sidekiq'
-      gem 'activejob'
-    end
   end
 
-  if RUBY_VERSION >= '2.2.2' && RUBY_PLATFORM != 'java'
+  if RUBY_VERSION >= '2.2.2'
     appraise 'rails5-mysql2' do
       gem 'rails', '5.0.1'
       gem 'mysql2', platform: :ruby
@@ -84,12 +95,20 @@ if RUBY_VERSION < '2.4.0'
       gem 'rails', '5.0.1'
       gem 'pg', platform: :ruby
       gem 'sidekiq'
-      gem "activejob"
+      gem 'activejob'
+    end
+
+    appraise 'rails4-postgres-sidekiq' do
+      gem 'rails', '4.2.7.1'
+      gem 'pg', platform: :ruby
+      gem 'activerecord-jdbcpostgresql-adapter', platform: :jruby
+      gem 'sidekiq'
+      gem 'activejob'
     end
   end
 end
 
-if RUBY_VERSION >= '2.2.2'
+if RUBY_VERSION >= '2.2.2' && RUBY_PLATFORM != 'java'
   appraise 'contrib' do
     gem 'elasticsearch-transport'
     gem 'grape'

data/README.md

@@ -84,6 +84,19 @@ you can activate it. The example above would become:
     end
 ```
 
+This will automatically trace any app inherited from `Sinatra::Application`.
+To trace apps inherited from `Sinatra::Base`, you should manually register
+the tracer inside your class.
+
+```ruby
+    require "ddtrace"
+    require "ddtrace/contrib/sinatra/tracer"
+
+    class App < Sinatra::Base
+      register Datadog::Contrib::Sinatra::Tracer
+    end
+```
+
 To know if a given framework or lib is supported by our client,
 please consult our [integrations][contrib] list.
 

data/Rakefile

@@ -123,10 +123,9 @@ task :ci do
   # check: https://circleci.com/docs/parallel-manual-setup/#env-splitting
   case ENV['CIRCLE_NODE_INDEX'].to_i
   when 0
-    sh 'rvm $MRI_VERSIONS,$MRI_OLD_VERSIONS --verbose do rake test:main'
+    sh 'rvm $MRI_VERSIONS,$MRI_OLD_VERSIONS,$JRUBY_VERSIONS --verbose do rake test:main'
     sh 'rvm $LAST_STABLE --verbose do rake benchmark'
   when 1
-    sh 'rvm $MRI_VERSIONS --verbose do appraisal contrib rake test:monkey'
     sh 'rvm $MRI_VERSIONS --verbose do appraisal contrib rake test:elasticsearch'
     sh 'rvm $MRI_VERSIONS --verbose do appraisal contrib rake test:http'
     sh 'rvm $MRI_VERSIONS --verbose do appraisal contrib rake test:redis'
@@ -142,16 +141,17 @@ task :ci do
     sh 'rvm $MRI_OLD_VERSIONS --verbose do appraisal contrib-old rake test:rack'
     sh 'rvm $SIDEKIQ_OLD_VERSIONS --verbose do appraisal contrib-old rake test:sidekiq'
   when 2
-    sh 'rvm $RAILS3_VERSIONS --verbose do appraisal rails3-mysql2 rake test:rails'
-    sh 'rvm $RAILS3_VERSIONS --verbose do appraisal rails3-postgres rake test:rails'
-    sh 'rvm $RAILS3_VERSIONS --verbose do appraisal rails3-postgres-redis rake test:railsredis'
+    sh 'rvm $RAILS3_VERSIONS --verbose do appraisal rails30-postgres rake test:rails'
+    sh 'rvm $RAILS3_VERSIONS --verbose do appraisal rails32-mysql2 rake test:rails'
+    sh 'rvm $RAILS3_VERSIONS --verbose do appraisal rails32-postgres rake test:rails'
+    sh 'rvm $RAILS3_VERSIONS --verbose do appraisal rails32-postgres-redis rake test:railsredis'
     sh 'rvm $RAILS4_VERSIONS --verbose do appraisal rails4-mysql2 rake test:rails'
     sh 'rvm $RAILS4_VERSIONS --verbose do appraisal rails4-postgres rake test:rails'
     sh 'rvm $RAILS4_VERSIONS --verbose do appraisal rails4-postgres-redis rake test:railsredis'
-    # Test Rails3/Sidekiq with Rails4 versions (3 vs 4) as Sidekiq requires >= 2.0 and Rails3 should support 1.9
-    sh 'rvm $RAILS4_VERSIONS --verbose do appraisal rails3-postgres-sidekiq rake test:railssidekiq'
-    sh 'rvm $RAILS4_VERSIONS --verbose do appraisal rails4-postgres-sidekiq rake test:railssidekiq'
-    sh 'rvm $RAILS4_VERSIONS --verbose do appraisal rails4-postgres-sidekiq rake test:railsactivejob'
+    sh 'rvm $RAILS3_SIDEKIQ_VERSIONS --verbose do appraisal rails30-postgres-sidekiq rake test:railssidekiq'
+    sh 'rvm $RAILS3_SIDEKIQ_VERSIONS --verbose do appraisal rails32-postgres-sidekiq rake test:railssidekiq'
+    sh 'rvm $RAILS4_SIDEKIQ_VERSIONS --verbose do appraisal rails4-postgres-sidekiq rake test:railssidekiq'
+    sh 'rvm $RAILS4_SIDEKIQ_VERSIONS --verbose do appraisal rails4-postgres-sidekiq rake test:railsactivejob'
     sh 'rvm $RAILS5_VERSIONS --verbose do appraisal rails5-mysql2 rake test:rails'
     sh 'rvm $RAILS5_VERSIONS --verbose do appraisal rails5-postgres rake test:rails'
     sh 'rvm $RAILS5_VERSIONS --verbose do appraisal rails5-postgres-redis rake test:railsredis'

data/circle.yml

@@ -2,15 +2,17 @@ machine:
   services:
     - docker
   environment:
-    # FIXME: Disabled $JRUBY_VERSIONS tests because of a Java incompatibility
-    LAST_STABLE: 2.4.0
-    EARLY_STABLE: 2.2.6
-    MRI_VERSIONS: 2.4.0,2.3.3,2.2.6
+    LAST_STABLE: 2.4.1
+    EARLY_STABLE: 2.2.7
+    MRI_VERSIONS: 2.4.1,2.3.4,2.2.7
     MRI_OLD_VERSIONS: 2.1.10,2.0.0,1.9.3
     SIDEKIQ_OLD_VERSIONS: 2.1.10,2.0.0
-    RAILS3_VERSIONS: 2.3.3,2.2.6,2.1.10,2.0.0,1.9.3
-    RAILS4_VERSIONS: 2.3.3,2.2.6,2.1.10
-    RAILS5_VERSIONS: 2.3.3,2.2.6
+    RAILS3_VERSIONS: 2.3.4,2.2.7,2.1.10,2.0.0,1.9.3
+    RAILS4_VERSIONS: 2.3.4,2.2.7,2.1.10
+    RAILS5_VERSIONS: 2.3.4,2.2.7
+    RAILS3_SIDEKIQ_VERSIONS: 2.1.10,2.0.0
+    RAILS4_SIDEKIQ_VERSIONS: 2.3.4,2.2.7
+    JRUBY_VERSIONS: jruby-9.1.5.0
     AGENT_BUILD_PATH: "/home/ubuntu/agent"
     TEST_DATADOG_INTEGRATION: 1
 
@@ -30,11 +32,12 @@ dependencies:
     - bundle install
     # configure Ruby interpreters
     - rvm get head
-    - rvm install $MRI_VERSIONS
+    - rvm install $MRI_VERSIONS,$MRI_OLD_VERSIONS,$JRUBY_VERSIONS
   override:
-    - rvm $MRI_VERSIONS,$MRI_OLD_VERSIONS --verbose do gem update --system=2.6.11
-    - rvm $MRI_VERSIONS,$MRI_OLD_VERSIONS --verbose do gem install bundler
-    - rvm $MRI_VERSIONS,$MRI_OLD_VERSIONS --verbose do bundle install
+    - rvm $MRI_VERSIONS,$MRI_OLD_VERSIONS,$JRUBY_VERSIONS --verbose do gem update --system=2.6.11
+    - rvm $MRI_VERSIONS,$MRI_OLD_VERSIONS,$JRUBY_VERSIONS --verbose do gem install bundler
+    - rvm $MRI_VERSIONS,$MRI_OLD_VERSIONS,$JRUBY_VERSIONS --verbose do bundle install
+    # [FIXME] appraisal does not work with jruby (problem with native ext, eg sqlite3)
     - rvm $MRI_VERSIONS,$MRI_OLD_VERSIONS --verbose do appraisal install
 
 test:

data/ddtrace.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ddtrace/version'

data/docs/GettingStarted.md

@@ -160,6 +160,18 @@ To start using the middleware in your generic Rack application, add it to your `
 
     run app
 
+Experimental distributed tracing support is available for this library.
+You need to set the ``:distributed_tracing_enabled`` option to true, for example:
+
+    use Datadog::Contrib::Rack::TraceMiddleware, distributed_tracing_enabled: true
+
+    app = proc do |env|
+      # trace and read 'x-datadog-trace-id' and 'x-datadog-parent-id'
+      [ 200, {'Content-Type' => 'text/plain'}, "OK" ]
+    end
+
+See [distributed tracing](#Distributed_Tracing) for details.
+
 #### Configure the tracer
 
 To modify the default middleware configuration, you can use middleware options as follows:
@@ -256,6 +268,31 @@ Net::HTTP module.
 
     content = Net::HTTP.get(URI('http://127.0.0.1/index.html'))
 
+Experimental distributed tracing support is available for this library.
+By default, this is disabled. You need to enable it, either on a per-connection basis,
+by setting the ``:distributed_tracing_enabled`` config entry to ``true`` using
+the ``Pin`` object attached to the client. Example:
+
+    require 'net/http'
+    require 'ddtrace'
+
+    Datadog::Monkey.patch_module(:http) # explicitly patch it
+
+    client = Net::HTTP.new(host, port)
+    Datadog::Pin.get_from(client).config = { distributed_tracing_enabled: true }
+    response = client.get('foo') # trace and send 'x-datadog-trace-id' and 'x-datadog-parent-id'
+
+Or, by enabling distributed tracing for all HTTP calls:
+
+    require 'net/http'
+    require 'ddtrace'
+
+    Datadog::Monkey.patch_module(:http) # explicitly patch it
+
+    Datadog::Contrib::HTTP.distributed_tracing_enabled = true
+
+See [distributed tracing](#Distributed_Tracing) for details.
+
 ### Redis
 
 The Redis integration will trace simple calls as well as pipelines.
@@ -350,12 +387,17 @@ to trace requests to the home page:
 
         # add some attributes and metrics
         span.set_tag('http.method', request.request_method)
-        span.set_metric('posts.count', len(@posts))
+        span.set_tag('posts.count', @posts.length)
 
         # trace the template rendering
         tracer.trace('template.render') do
           erb :index
         end
+
+        # trace using start_span (fine-grain control, requires explicit call to finish)
+        child = tracer.start_span('child', child_of: span)
+        # do something
+        child.finish
       end
     end
 
@@ -440,7 +482,7 @@ You can use this object to instrument your own code:
     class MyWebSite
       def initialize
         pin = Datadog::Pin.new('my-web-site', app_type: Datadog::Ext::AppTypes::WEB)
-        Datadog::Pin.onto(self)
+        pin.onto(self)
       end
 
       def serve(something)
@@ -479,6 +521,20 @@ for the first time:
 Remember that the debug mode may affect your application performance and so it must not be used
 in a production environment.
 
+### Using a custom logger
+
+By default, all logs are processed by the default Ruby logger.
+Typically, when using Rails, you should see the messages in your application log file.
+Datadog client log messages are marked with ``[ddtrace]`` so you should be able
+to isolate them from other messages.
+
+Additionally, it is possible to override the default logger and replace it by a
+custom one. This is done using the ``log`` attribute of the tracer.
+
+    f = File.new("my-custom.log", "w+")           # Log messages should go there
+    Datadog::Tracer.log = Logger.new(f)           # Overriding the default tracer
+    Datadog::Tracer.log.info { "this is typically called by tracing code" }
+
 ### Environment and tags
 
 By default, the trace agent (not this library, but the program running in
@@ -537,8 +593,8 @@ On the client:
 
     Datadog.tracer.trace('web.call') do |span|
       req = Net::HTTP::Get.new(uri)
-      req['x-ddtrace-parent_trace_id'] = span.trace_id.to_s
-      req['x-ddtrace-parent_span_id'] = span.span_id.to_s
+      req['x-datadog-trace-id'] = span.trace_id.to_s
+      req['x-datadog-parent-id'] = span.span_id.to_s
 
       response = Net::HTTP.start(uri.hostname, uri.port) do |http|
         http.request(req)
@@ -556,8 +612,8 @@ On the server:
     # require 'ddtrace/contrib/sinatra/tracer'
 
     get '/' do
-      parent_trace_id = request.env['HTTP_X_DDTRACE_PARENT_TRACE_ID']
-      parent_span_id = request.env['HTTP_X_DDTRACE_PARENT_SPAN_ID']
+      parent_trace_id = request.env['HTTP_X_DATADOG_TRACE_ID']
+      parent_span_id = request.env['HTTP_X_DATADOG_PARENT_ID']
 
       Datadog.tracer.trace('web.work') do |span|
          if parent_trace_id && parent_span_id
@@ -569,6 +625,40 @@ On the server:
       end
     end
 
+[Rack](#Rack) and [Net/HTTP](#Net_HTTP) have experimental support for this, they
+can send and receive these headers automatically and tie spans together automatically,
+provided you pass a ``:distributed_tracing_enabled`` option set to ``true``.
+
+This is disabled by default.
+
+### Troubleshooting
+
+#### Logs
+
+Your application log should contain informations and report problems
+such as agent not being up and running. All logs generated by this
+library should contain ``[ddtrace]``. Also see [how to use a custom logger](#Using_a_custom_logger)
+to redirect these messages elsewhere.
+
+The [Datadog Trace Agent](https://github.com/DataDog/datadog-trace-agent)
+should by default be listening for traces on port 8126.
+
+#### Hello World
+
+Sometimes, setting up a complete application is complex, so in doubt,
+try the small program below, which should be able to report traces
+for a ``tracegen`` service:
+
+    require 'ddtrace'
+
+    loop do
+        Datadog.tracer.trace('hello-world') do |span|
+            span.service = 'tracegen'
+            span.resource = 'ruby'
+            sleep 1
+        end
+    end
+
 ### Supported Versions
 
 #### Ruby interpreters

data/gemfiles/rails30_postgres.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "test-unit"
+gem "rails", "3.0.20"
+gem "pg", "0.15.1", platform: :ruby
+gem "activerecord-jdbcpostgresql-adapter", platform: :jruby
+
+gemspec path: "../"

data/gemfiles/rails30_postgres_sidekiq.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "test-unit"
+gem "rails", "3.0.20"
+gem "pg", "0.15.1", platform: :ruby
+gem "activerecord-jdbcpostgresql-adapter", platform: :jruby
+gem "sidekiq", "4.0.0"
+
+gemspec path: "../"

data/gemfiles/{rails3_postgres_sidekiq.gemfile → rails32_postgres_sidekiq.gemfile}

@@ -6,6 +6,6 @@ gem "test-unit"
 gem "rails", "3.2.22.5"
 gem "pg", "0.15.1", platform: :ruby
 gem "activerecord-jdbcpostgresql-adapter", platform: :jruby
-gem "sidekiq"
+gem "sidekiq", "4.0.0"
 
 gemspec path: "../"

data/lib/ddtrace/buffer.rb

@@ -1,31 +1,6 @@
 require 'thread'
 
 module Datadog
-  # Buffer used to store active spans
-  class SpanBuffer
-    # ensure that a new SpanBuffer clears the thread spans
-    def initialize
-      Thread.current[:datadog_span] = nil
-    end
-
-    # Set the current active span.
-    def set(span)
-      Thread.current[:datadog_span] = span
-    end
-
-    # Return the current active span or nil.
-    def get
-      Thread.current[:datadog_span]
-    end
-
-    # Pop the current active span.
-    def pop
-      span = get()
-      set(nil)
-      span
-    end
-  end
-
   # Trace buffer that stores application traces. The buffer has a maximum size and when
   # the buffer is full, a random trace is discarded. This class is thread-safe and is used
   # automatically by the ``Tracer`` instance when a ``Span`` is finished.
@@ -65,7 +40,7 @@ module Datadog
       end
     end
 
-    # Stored traces are returned and the local buffer is reset
+    # Stored traces are returned and the local buffer is reset.
     def pop
       @mutex.synchronize do
         traces = @traces