ddtrace 0.19.0 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f812f568118b7998a52208ffdb4c90a253edfd67
-  data.tar.gz: 914ce035245993d7535152437c720c8c3cca3c2e
+  metadata.gz: 52ce2b14a7143fb0f53beba225ad73d018397eb7
+  data.tar.gz: 793d9001870488465a243c87d1476db4f73a299d
 SHA512:
-  metadata.gz: '08f6d5fe32d68feb4c38ef89ef43908c76884d1b92b30929fc3edd7c50fad58674d21f7e00ff97e4731b008213e9e0584106691d52ed8b1feb16b0dbdac877a0'
-  data.tar.gz: 8b452ada6e2cfb91d1ee170600dc3fc7cd17c0b37042c6a3a746cc5739da038b37457204194f8ecdbc802a85d5afcdb4e79d13bf31293c2226aa0d62dcd0fa66
+  metadata.gz: 7f80807b947c9130e3946b260065af504f77759af8b883f4ec3e3dda3d5f0df24a33faf4ca7ae3b3d73b29c2ee62272982f1408c244aea2048640158964a3f61
+  data.tar.gz: dc887bb9c6f66ed29cd5176f9d82be384c0d089ff9413d600e8c8e5b8ca410124cf5d0ec2da9cc296c23e181828be5f3b235d593176235a4ccca5c2b78481a7d

data/Appraisals

@@ -86,7 +86,7 @@ elsif Gem::Version.new('1.9.3') <= Gem::Version.new(RUBY_VERSION) \
       gem 'sequel', '~> 4.0', '< 4.37'
       gem 'sidekiq', '~> 3.5.4'
       gem 'sinatra', '1.4.5'
-      gem 'sqlite3'
+      gem 'sqlite3', '~> 1.3.6'
       gem 'sucker_punch'
       gem 'timers', '< 4.2'
     end
@@ -171,7 +171,7 @@ elsif Gem::Version.new('2.0.0') <= Gem::Version.new(RUBY_VERSION) \
       gem 'sequel', '~> 4.0', '< 4.37'
       gem 'sidekiq', '~> 3.5.4'
       gem 'sinatra', '1.4.5'
-      gem 'sqlite3'
+      gem 'sqlite3', '~> 1.3.6'
       gem 'sucker_punch'
       gem 'timers', '< 4.2'
     end
@@ -277,7 +277,7 @@ elsif Gem::Version.new('2.1.0') <= Gem::Version.new(RUBY_VERSION) \
       gem 'shoryuken'
       gem 'sidekiq', '~> 3.5.4'
       gem 'sinatra', '1.4.5'
-      gem 'sqlite3'
+      gem 'sqlite3', '~> 1.3.6'
       gem 'sucker_punch'
       gem 'timers', '< 4.2'
     end
@@ -417,7 +417,7 @@ elsif Gem::Version.new('2.2.0') <= Gem::Version.new(RUBY_VERSION) \
       gem 'shoryuken'
       gem 'sidekiq'
       gem 'sinatra'
-      gem 'sqlite3'
+      gem 'sqlite3', '~> 1.3.6'
       gem 'sucker_punch'
     end
   end
@@ -556,7 +556,7 @@ elsif Gem::Version.new('2.3.0') <= Gem::Version.new(RUBY_VERSION) \
       gem 'shoryuken'
       gem 'sidekiq'
       gem 'sinatra'
-      gem 'sqlite3'
+      gem 'sqlite3', '~> 1.3.6'
       gem 'sucker_punch'
     end
   end
@@ -589,7 +589,7 @@ elsif Gem::Version.new('2.4.0') <= Gem::Version.new(RUBY_VERSION)
       gem 'shoryuken'
       gem 'sidekiq'
       gem 'sinatra'
-      gem 'sqlite3'
+      gem 'sqlite3', '~> 1.3.6'
       gem 'sucker_punch'
     end
   end

data/CHANGELOG.md

@@ -4,6 +4,20 @@
 
 ## [Unreleased (beta)]
 
+## [0.19.1] - 2019-02-07
+
+Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.19.1
+
+Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.19.0...v0.19.1
+
+### Added
+
+- Documentation for Lograge implementation (#683, #687) (@nic-lan)
+
+### Fixed
+
+- Priority sampling dropping spans (#686)
+
 ## [0.19.0] - 2019-01-22
 
 Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.19.0
@@ -12,12 +26,12 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.18.3...v0.19.0
 
 ### Added
 
- - Tracer#active_correlation for adding correlation IDs to logs. (#660, #664, #673)
- - Opt-in support for `event_sample_rate` tag for some integrations. (#665, #666)
+- Tracer#active_correlation for adding correlation IDs to logs. (#660, #664, #673)
+- Opt-in support for `event_sample_rate` tag for some integrations. (#665, #666)
 
 ### Changed
 
- - Priority sampling enabled by default. (#654)
+- Priority sampling enabled by default. (#654)
 
 ## [0.18.3] - 2019-01-17
 
@@ -60,15 +74,15 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.17.3...v0.18.0
 
 ### Added
 
- - Shoryuken integration (#538, #626, #655) (@steveh, @JustSnow)
- - Sidekiq client integration (#602, #650) (@dirk)
- - Datadog::Shim for adding instrumentation (#648)
+- Shoryuken integration (#538, #626, #655) (@steveh, @JustSnow)
+- Sidekiq client integration (#602, #650) (@dirk)
+- Datadog::Shim for adding instrumentation (#648)
 
 ### Changed
 
- - Use `DD_AGENT_HOST` and `DD_TRACE_AGENT_PORT` env vars if available (#631)
- - Inject `:connection` into `sql.active_record` event (#640, #649, #656) (@guizmaii)
- - Return default configuration instead of `nil` on miss (#651)
+- Use `DD_AGENT_HOST` and `DD_TRACE_AGENT_PORT` env vars if available (#631)
+- Inject `:connection` into `sql.active_record` event (#640, #649, #656) (@guizmaii)
+- Return default configuration instead of `nil` on miss (#651)
 
 ## [0.17.3] - 2018-11-29
 
@@ -111,18 +125,18 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.16.1...v0.17.0
 
 ### Added
 
- - [BETA] Span memory `allocations` attribute (#597) (@dasch)
+- [BETA] Span memory `allocations` attribute (#597) (@dasch)
 
 ### Changed
 
- - Use Rack Env to update resource in Rails (#580) (@dasch)
- - Expand support for Sidekiq to 3.5.4+ (#593)
- - Expand support for mysql2 to 0.3.21+ (#578)
+- Use Rack Env to update resource in Rails (#580) (@dasch)
+- Expand support for Sidekiq to 3.5.4+ (#593)
+- Expand support for mysql2 to 0.3.21+ (#578)
 
 ### Refactored
 
- - Upgraded integrations to new API (#544)
- - Encoding classes into modules (#598)
+- Upgraded integrations to new API (#544)
+- Encoding classes into modules (#598)
 
 ## [0.16.1] - 2018-10-17
 
@@ -266,7 +280,7 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.13.1...v0.13.2
 
 ### Fixed
 
- - Context propagation for distributed traces when context is full (#502)
+- Context propagation for distributed traces when context is full (#502)
 
 ## [0.13.1] - 2018-07-17
 
@@ -276,15 +290,15 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.13.0...v0.13.1
 
 ### Changed
 
- - Configuration class variables don't lazy load (#477)
- - Default tracer host `localhost` --> `127.0.0.1` (#466, #480) (@NobodysNightmare)
+- Configuration class variables don't lazy load (#477)
+- Default tracer host `localhost` --> `127.0.0.1` (#466, #480) (@NobodysNightmare)
 
 ### Fixed
 
- - Workers not shutting down quickly in some short running processes (#475)
- - Missing documentation for mysql2 and Rails (#476, #488)
- - Missing variable in rescue block (#481) (@kitop)
- - Unclosed spans in ActiveSupport::Notifications with multithreading (#431, #478) (@senny)
+- Workers not shutting down quickly in some short running processes (#475)
+- Missing documentation for mysql2 and Rails (#476, #488)
+- Missing variable in rescue block (#481) (@kitop)
+- Unclosed spans in ActiveSupport::Notifications with multithreading (#431, #478) (@senny)
 
 ## [0.13.0] - 2018-06-20
 
@@ -327,6 +341,7 @@ Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.13.0.beta1
 Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.12.0...v0.13.0.beta1
 
 ### Added
+
 - Sequel integration (supporting Ruby 2.0+) (#171, #367) (@randy-girard, @twe4ked, @palin)
 - gRPC integration (supporting Ruby 2.2+) (#379, #403) (@Jared-Prime)
 - ActiveModelSerializers integration (#340) (@sullimander)
@@ -337,6 +352,7 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.12.0...v0.13.0.beta1
 - Request and response header tags to Rack (#389)
 
 ### Refactored
+
 - Hash quantization into core library (#410)
 
 ## [0.12.1] - 2018-06-12
@@ -346,20 +362,23 @@ Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.12.1
 Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.12.0...v0.12.1
 
 ### Changed
- - Cache configuration `Proxy` objects (#446)
- - `freeze` more constant strings, to improve memory usage (#446)
+
+- Cache configuration `Proxy` objects (#446)
+- `freeze` more constant strings, to improve memory usage (#446)
  - `Utils#truncate` to use slightly less memory (#446)
 
 ### Fixed
- - Net/HTTP integration not permitting `service_name` to be overridden. (#407, #430) (@undergroundwebdesigns)
- - Block not being passed through Elasticsearch client initialization. (#421) (@shayonj)
- - Devise raising `NoMethodError` when bad login attempts are made. (#419, #420) (@frsantos)
- - AWS spans using wrong resource name (#374, #377) (@jfrancoist)
- - ActionView `NoMethodError` on very long traces. (#445, #447) (@jvalanen)
+
+- Net/HTTP integration not permitting `service_name` to be overridden. (#407, #430) (@undergroundwebdesigns)
+- Block not being passed through Elasticsearch client initialization. (#421) (@shayonj)
+- Devise raising `NoMethodError` when bad login attempts are made. (#419, #420) (@frsantos)
+- AWS spans using wrong resource name (#374, #377) (@jfrancoist)
+- ActionView `NoMethodError` on very long traces. (#445, #447) (@jvalanen)
 
 ### Refactored
- - ActionController patching strategy using modules. (#439)
- - ActionView tracing strategy. (#445, #447)
+
+- ActionController patching strategy using modules. (#439)
+- ActionView tracing strategy. (#445, #447)
 
 ## [0.12.0] - 2018-05-08
 
@@ -368,6 +387,7 @@ Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.12.0
 Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.11.4...v0.12.0
 
 ### Added
+
 - GraphQL integration (supporting graphql 1.7.9+) (#295)
 - ActiveRecord object instantiation tracing (#311, #334)
 - Subscriber module for ActiveSupport::Notifications tracing (#324, #380, #390, #395) (@dasch)
@@ -375,20 +395,24 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.11.4...v0.12.0
 - Partial flushing option to tracer (#247, #397)
 
 ### Changed
+
 - Rack applies URL quantization by default (#371)
 - Elasticsearch applies body quantization by default (#362)
 - Context for a single trace now has hard limit of 100,000 spans (#247)
 - Tags with `rails.db.x` to `active_record.db.x` instead (#396)
 
 ### Fixed
+
 - Loading the ddtrace library after Rails has fully initialized can result in load errors. (#357)
 - Some scenarios where `middleware_names` could result in bad resource names (#354)
 - ActionController instrumentation conflicting with some gems that monkey patch Rails (#391)
 
 ### Deprecated
+
 - Use of `:datadog_rack_request_span` variable in favor of `'datadog.rack_request_span'` in Rack. (#365, #392)
 
 ### Refactored
+
 - Racecar to use ActiveSupport::Notifications Subscriber module (#381)
 - Rails to use ActiveRecord integration instead of its own implementation (#396)
 - ActiveRecord to use ActiveSupport::Notifications Subscriber module (#396)
@@ -400,6 +424,7 @@ Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.12.0.rc1
 Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.11.4...v0.12.0.rc1
 
 ### Added
+
 - GraphQL integration (supporting graphql 1.7.9+) (#295)
 - ActiveRecord object instantiation tracing (#311, #334)
 - Subscriber module for ActiveSupport::Notifications tracing (#324, #380, #390, #395) (@dasch)
@@ -407,20 +432,24 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.11.4...v0.12.0.rc1
 - Partial flushing option to tracer (#247, #397)
 
 ### Changed
+
 - Rack applies URL quantization by default (#371)
 - Elasticsearch applies body quantization by default (#362)
 - Context for a single trace now has hard limit of 100,000 spans (#247)
 - Tags with `rails.db.x` to `active_record.db.x` instead (#396)
 
 ### Fixed
+
 - Loading the ddtrace library after Rails has fully initialized can result in load errors. (#357)
 - Some scenarios where `middleware_names` could result in bad resource names (#354)
 - ActionController instrumentation conflicting with some gems that monkey patch Rails (#391)
 
 ### Deprecated
+
 - Use of `:datadog_rack_request_span` variable in favor of `'datadog.rack_request_span'` in Rack. (#365, #392)
 
 ### Refactored
+
 - Racecar to use ActiveSupport::Notifications Subscriber module (#381)
 - Rails to use ActiveRecord integration instead of its own implementation (#396)
 - ActiveRecord to use ActiveSupport::Notifications Subscriber module (#396)
@@ -432,6 +461,7 @@ Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.12.0.beta2
 Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.12.0.beta1...v0.12.0.beta2
 
 ### Fixed
+
 - Loading the ddtrace library after Rails has fully initialized can result in load errors. (#357)
 
 ## [0.12.0.beta1] - 2018-02-09
@@ -441,6 +471,7 @@ Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.12.0.beta1
 Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.11.2...v0.12.0.beta1
 
 ### Added
+
 - GraphQL integration (supporting graphql 1.7.9+) (#295)
 - ActiveRecord object instantiation tracing (#311, #334)
 - `http.request_id` tag to Rack spans (#335)
@@ -452,6 +483,7 @@ Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.11.4
 Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.11.3...v0.11.4
 
 ### Fixed
+
 - Transport body parsing when downgrading (#369)
 - Transport incorrectly attempting to apply sampling to service metadata (#370)
 - `sql.active_record` traces showing incorrect adapter settings when non-default adapter used (#383)
@@ -463,11 +495,13 @@ Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.11.3
 Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.11.2...v0.11.3
 
 ### Added
+
 - CHANGELOG.md (#350, #363) (@awendt)
 - `http.request_id` tag to Rack spans (#335)
 - Tracer configuration to README.md (#332) (@noma4i)
 
 ### Fixed
+
 - Extra indentation in README.md (#349) (@ck3g)
 - `http.url` when Rails raises exceptions (#351, #353)
 - Rails from being patched twice (#352)
@@ -486,6 +520,7 @@ Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.11.2
 Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.11.1...v0.11.2
 
 ### Deprecated
+
 - `Datadog::Monkey` to be no-op and print deprecation warnings.
 
 ## [0.11.1] - 2018-01-29
@@ -495,18 +530,22 @@ Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.11.1
 Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.11.0...v0.11.1
 
 ### Added
+
 - `http.base_url` tag for Rack applications (#301, #327)
 - `distributed_tracing` option to Sinatra (#325)
 - `exception_controller` option to Rails (#320)
 
 ### Changed
+
 - Decoupled Sinatra and ActiveRecord integrations (#328, #330) (@hawknewton)
 - Racecar uses preferred ActiveSupport::Notifications strategy (#323)
 
 ### Removed
+
 - `Datadog::Monkey` in favor of newer configuration API (#322)
 
 ### Fixed
+
 - Custom resource names from Rails controllers being overridden (#321)
 - Custom Rails exception controllers reporting as the resource (#320)
 
@@ -642,8 +681,9 @@ Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.3.1
 
 Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 
-[Unreleased (stable)]: https://github.com/DataDog/dd-trace-rb/compare/v0.19.0...master
-[Unreleased (beta)]: https://github.com/DataDog/dd-trace-rb/compare/v0.19.0...0.20-dev
+[Unreleased (stable)]: https://github.com/DataDog/dd-trace-rb/compare/v0.19.1...master
+[Unreleased (beta)]: https://github.com/DataDog/dd-trace-rb/compare/v0.19.1...0.20-dev
+[0.19.1]: https://github.com/DataDog/dd-trace-rb/compare/v0.19.0...v0.19.1
 [0.19.0]: https://github.com/DataDog/dd-trace-rb/compare/v0.18.3...v0.19.0
 [0.18.3]: https://github.com/DataDog/dd-trace-rb/compare/v0.18.2...v0.18.3
 [0.18.2]: https://github.com/DataDog/dd-trace-rb/compare/v0.18.1...v0.18.2

data/ddtrace.gemspec

@@ -46,7 +46,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'webmock', '~> 2.0'
   spec.add_development_dependency 'builder'
   spec.add_development_dependency 'ruby-prof'
-  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'sqlite3', '~> 1.3.6'
 
   # locking transitive dependency of webmock
   spec.add_development_dependency 'addressable', '~> 2.4.0'

data/docs/GettingStarted.md

@@ -1635,14 +1635,53 @@ correlation.trace_id # => 0
 correlation.span_id # => 0
 ```
 
+#### For logging in Rails applications using Lograge (recommended)
+
+After [setting up Lograge in a Rails application](https://docs.datadoghq.com/logs/log_collection/ruby/), modify the `custom_options` block in your environment configuration file (e.g. `config/environments/production.rb`) to add the trace IDs:
+
+```ruby
+config.lograge.custom_options = lambda do |event|
+  # Retrieves trace information for current thread
+  correlation = Datadog.tracer.active_correlation
+
+  {
+    # Adds IDs as tags to log output
+    :dd => {
+      :trace_id => correlation.trace_id,
+      :span_id => correlation.span_id
+    },
+    :ddsource => ["ruby"],
+    :params => event.payload[:params].reject { |k| %w(controller action).include? k }
+  }
+end
+```
+
+#### For logging in Rails applications
+
+Rails applications which are configured with a `ActiveSupport::TaggedLogging` logger can append correlation IDs as tags to log output. The default Rails logger implements this tagged logging, making it easier to add correlation tags.
+
+In your Rails environment configuration file, add the following:
+
+```ruby
+Rails.application.configure do
+  config.log_tags = [proc { Datadog.tracer.active_correlation.to_s }]
+end
+
+# Web requests will produce:
+# [dd.trace_id=7110975754844687674 dd.span_id=7518426836986654206] Started GET "/articles" for 172.22.0.1 at 2019-01-16 18:50:57 +0000
+# [dd.trace_id=7110975754844687674 dd.span_id=7518426836986654206] Processing by ArticlesController#index as */*
+# [dd.trace_id=7110975754844687674 dd.span_id=7518426836986654206]   Article Load (0.5ms)  SELECT "articles".* FROM "articles"
+# [dd.trace_id=7110975754844687674 dd.span_id=7518426836986654206] Completed 200 OK in 7ms (Views: 5.5ms | ActiveRecord: 0.5ms)
+```
+
 #### For logging in Ruby applications
 
 To add correlation IDs to your logger, add a log formatter which retrieves the correlation IDs with `Datadog.tracer.active_correlation`, then add them to the message.
 
-To properly correlate with Datadog logging, be sure the following is present:
+To properly correlate with Datadog logging, be sure the following is present in the log message:
 
- - `dd.trace_id=<TRACE_ID>`: Where `<TRACE_ID>` is equal to `Datadog.tracer.active_correlation.trace_id` or `0` if no trace is active.
- - `dd.span_id=<SPAN_ID>`: Where `<SPAN_ID>` is equal to `Datadog.tracer.active_correlation.span_id` or `0` if no trace is active.
+ - `dd.trace_id=<TRACE_ID>`: Where `<TRACE_ID>` is equal to `Datadog.tracer.active_correlation.trace_id` or `0` if no trace is active during logging.
+ - `dd.span_id=<SPAN_ID>`: Where `<SPAN_ID>` is equal to `Datadog.tracer.active_correlation.span_id` or `0` if no trace is active during logging.
 
 By default, `Datadog::Correlation::Identifier#to_s` will return `dd.trace_id=<TRACE_ID> dd.span_id=<SPAN_ID>`.
 
@@ -1667,24 +1706,6 @@ Datadog.tracer.trace('my.operation') { logger.warn('This is a traced operation.'
 # [2019-01-16 18:38:41 +0000][my_app][WARN][dd.trace_id=8545847825299552251 dd.span_id=3711755234730770098] This is a traced operation.
 ```
 
-#### For logging in Rails applications
-
-Rails applications which are configured with a `ActiveSupport::TaggedLogging` logger can append correlation IDs as tags to log output. The default Rails logger implements this tagged logging, making it easier to add correlation tags.
-
-In your Rails environment configuration file, add the following:
-
-```ruby
-Rails.application.configure do
-  config.log_tags = [proc { Datadog.tracer.active_correlation.to_s }]
-end
-
-# Web requests will produce:
-# [dd.trace_id=7110975754844687674 dd.span_id=7518426836986654206] Started GET "/articles" for 172.22.0.1 at 2019-01-16 18:50:57 +0000
-# [dd.trace_id=7110975754844687674 dd.span_id=7518426836986654206] Processing by ArticlesController#index as */*
-# [dd.trace_id=7110975754844687674 dd.span_id=7518426836986654206]   Article Load (0.5ms)  SELECT "articles".* FROM "articles"
-# [dd.trace_id=7110975754844687674 dd.span_id=7518426836986654206] Completed 200 OK in 7ms (Views: 5.5ms | ActiveRecord: 0.5ms)
-```
-
 ### OpenTracing
 
 For setting up Datadog with OpenTracing, see out [Quickstart for OpenTracing](#quickstart-for-opentracing) section for details.

data/lib/ddtrace/sampler.rb

@@ -5,14 +5,22 @@ require 'ddtrace/ext/priority'
 module Datadog
   # \Sampler performs client-side trace sampling.
   class Sampler
-    def sample(_span)
-      raise NotImplementedError, 'samplers have to implement the sample() method'
+    def sample?(_span)
+      raise NotImplementedError, 'Samplers must implement the #sample? method'
+    end
+
+    def sample!(_span)
+      raise NotImplementedError, 'Samplers must implement the #sample! method'
     end
   end
 
   # \AllSampler samples all the traces.
   class AllSampler < Sampler
-    def sample(span)
+    def sample?(span)
+      true
+    end
+
+    def sample!(span)
       span.sampled = true
     end
   end
@@ -20,7 +28,7 @@ module Datadog
   # \RateSampler is based on a sample rate.
   class RateSampler < Sampler
     KNUTH_FACTOR = 1111111111111111111
-    SAMPLE_RATE_METRIC_KEY = '_sample_rate'.freeze()
+    SAMPLE_RATE_METRIC_KEY = '_sample_rate'.freeze
 
     attr_reader :sample_rate
 
@@ -45,9 +53,14 @@ module Datadog
       @sampling_id_threshold = sample_rate * Span::MAX_ID
     end
 
-    def sample(span)
-      span.set_metric(SAMPLE_RATE_METRIC_KEY, @sample_rate)
-      span.sampled = ((span.trace_id * KNUTH_FACTOR) % Datadog::Span::MAX_ID) <= @sampling_id_threshold
+    def sample?(span)
+      ((span.trace_id * KNUTH_FACTOR) % Datadog::Span::MAX_ID) <= @sampling_id_threshold
+    end
+
+    def sample!(span)
+      (span.sampled = sample?(span)).tap do |sampled|
+        span.set_metric(SAMPLE_RATE_METRIC_KEY, @sample_rate) if sampled
+      end
     end
   end
 
@@ -62,11 +75,27 @@ module Datadog
       @sampler = { DEFAULT_KEY => @fallback }
     end
 
-    def sample(span)
+    def sample?(span)
       key = key_for(span)
 
       @mutex.synchronize do
-        @sampler.fetch(key, @fallback).sample(span)
+        @sampler.fetch(key, @fallback).sample?(span)
+      end
+    end
+
+    def sample!(span)
+      key = key_for(span)
+
+      @mutex.synchronize do
+        @sampler.fetch(key, @fallback).sample!(span)
+      end
+    end
+
+    def sample_rate(span)
+      key = key_for(span)
+
+      @mutex.synchronize do
+        @sampler.fetch(key, @fallback).sample_rate
       end
     end
 
@@ -92,38 +121,75 @@ module Datadog
   class PrioritySampler
     extend Forwardable
 
+    SAMPLE_RATE_METRIC_KEY = '_sample_rate'.freeze
+
     def initialize(opts = {})
-      @base_sampler = opts[:base_sampler] || RateSampler.new
-      @post_sampler = opts[:post_sampler] || RateByServiceSampler.new
+      @pre_sampler = opts[:base_sampler] || AllSampler.new
+      @priority_sampler = opts[:post_sampler] || RateByServiceSampler.new
     end
 
-    def sample(span)
-      return perform_sampling(span) unless span.context
-      return sampled_by_upstream(span) if span.context.sampling_priority
+    def sample?(span)
+      @pre_sampler.sample?(span)
+    end
 
-      perform_sampling(span).tap do |sampled|
-        span.context.sampling_priority = if sampled
-                                           Datadog::Ext::Priority::AUTO_KEEP
-                                         else
-                                           Datadog::Ext::Priority::AUTO_REJECT
-                                         end
+    def sample!(span)
+      # If pre-sampling is configured, do it first. (By default, this will sample at 100%.)
+      # NOTE: Pre-sampling at rates < 100% may result in partial traces; not recommended.
+      span.sampled = pre_sample?(span) ? @pre_sampler.sample!(span) : true
+
+      if span.sampled
+        # If priority sampling has already been applied upstream, use that, otherwise...
+        unless priority_assigned_upstream?(span)
+          # Roll the dice and determine whether how we set the priority.
+          # NOTE: We'll want to leave `span.sampled = true` here; all spans for priority sampling must
+          #       be sent to the agent. Otherwise metrics for traces will not be accurate, since the
+          #       agent will have an incomplete dataset.
+          priority = priority_sample(span) ? Datadog::Ext::Priority::AUTO_KEEP : Datadog::Ext::Priority::AUTO_REJECT
+          assign_priority!(span, priority)
+        end
+      else
+        # If discarded by pre-sampling, set "reject" priority, so other
+        # services for the same trace don't sample needlessly.
+        assign_priority!(span, Datadog::Ext::Priority::AUTO_REJECT)
       end
+
+      span.sampled
     end
 
-    def_delegators :@post_sampler, :update
+    def_delegators :@priority_sampler, :update
 
     private
 
-    def sampled_by_upstream(span)
-      span.sampled = priority_keep?(span.context.sampling_priority)
+    def pre_sample?(span)
+      case @pre_sampler
+      when RateSampler
+        @pre_sampler.sample_rate < 1.0
+      when RateByServiceSampler
+        @pre_sampler.sample_rate(span) < 1.0
+      else
+        true
+      end
+    end
+
+    def priority_assigned_upstream?(span)
+      span.context && !span.context.sampling_priority.nil?
     end
 
-    def priority_keep?(sampling_priority)
-      sampling_priority == Datadog::Ext::Priority::USER_KEEP || sampling_priority == Datadog::Ext::Priority::AUTO_KEEP
+    def priority_sample(span)
+      @priority_sampler.sample?(span)
     end
 
-    def perform_sampling(span)
-      @base_sampler.sample(span) && @post_sampler.sample(span)
+    def assign_priority!(span, priority)
+      if span.context
+        span.context.sampling_priority = priority
+      else
+        # Set the priority directly on the span instead, since otherwise
+        # it won't receive the appropriate tag.
+        span.set_metric(
+          Ext::DistributedTracing::SAMPLING_PRIORITY_KEY,
+          priority
+        )
+      end
     end
   end
 end

data/lib/ddtrace/tracer.rb

@@ -229,7 +229,7 @@ module Datadog
       span = Span.new(self, name, opts)
       if parent.nil?
         # root span
-        @sampler.sample(span)
+        @sampler.sample!(span)
         span.set_tag('system.pid', Process.pid)
         if ctx && ctx.trace_id && ctx.span_id
           span.trace_id = ctx.trace_id

data/lib/ddtrace/version.rb

@@ -2,7 +2,7 @@ module Datadog
   module VERSION
     MAJOR = 0
     MINOR = 19
-    PATCH = 0
+    PATCH = 1
     PRE = nil
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddtrace
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.19.1
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-22 00:00:00.000000000 Z
+date: 2019-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -182,16 +182,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement