ddtrace 0.21.0 → 0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ddab3a41c741e4d490ee6d078c40a953a9095b18
-  data.tar.gz: 6853021a4383b29e7ae678a809a5697ea5619456
+  metadata.gz: a09aedaed6a1aa22354f3c9c3696c6a3b9885f43
+  data.tar.gz: 35fdddc2a09fb5f57a9e21a67ccab6d26297583e
 SHA512:
-  metadata.gz: aaacd674bf8f46df992234b9a8b72a5d8d53b0d73eaf2a89ad5f0c92a94d8632381402389ca1ee3c3353c6618a94c39db9597a40e3b48ec006122f5023d7b158
-  data.tar.gz: 95785d1b6ec7472301aa0c5d386edbcadc9ff60c4bf65effedbd130b91bfb1149b1e736d982282b3565d78c9253d0deda998b612cec2ced66c7f373bd691ba72
+  metadata.gz: 5851f49e14aa8e4b0be89723b84ee97f912583aac7ec5f66b7a7ef5c3f2962c43ca0a239e6ad44aa781df47339575eacd0d8f11d67d97e84bc0e639103fb3872
+  data.tar.gz: beb715b01e94b8e62ecac54dd46ba433beaeb19e905abe6d0b143550fe997a68c60eb88e9a40eae2f7a3269baf892fc980d668fbe5c4acfbf30c71ee09b52f9b

data/CHANGELOG.md

@@ -4,6 +4,16 @@
 
 ## [Unreleased (beta)]
 
+## [0.21.1] - 2019-03-26
+
+Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.21.1
+
+Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.21.0...v0.21.1
+
+### Changed
+
+- Support `TAG_ENABLED` for custom instrumentation with analytics. (#728)
+
 ## [0.21.0] - 2019-03-20
 
 Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.21.0
@@ -731,8 +741,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.21.0...master
-[Unreleased (beta)]: https://github.com/DataDog/dd-trace-rb/compare/v0.21.0...0.22-dev
+[Unreleased (stable)]: https://github.com/DataDog/dd-trace-rb/compare/v0.21.1...master
+[Unreleased (beta)]: https://github.com/DataDog/dd-trace-rb/compare/v0.21.1...0.22-dev
+[0.21.0]: https://github.com/DataDog/dd-trace-rb/compare/v0.21.0...v0.21.1
 [0.21.0]: https://github.com/DataDog/dd-trace-rb/compare/v0.20.0...v0.21.0
 [0.20.0]: https://github.com/DataDog/dd-trace-rb/compare/v0.19.1...v0.20.0
 [0.19.1]: https://github.com/DataDog/dd-trace-rb/compare/v0.19.0...v0.19.1

data/lib/ddtrace/analytics.rb

@@ -0,0 +1,58 @@
+require 'ddtrace/ext/analytics'
+
+module Datadog
+  # Defines analytics behavior
+  module Analytics
+    class << self
+      def set_sample_rate(span, sample_rate)
+        return if span.nil? || !sample_rate.is_a?(Numeric)
+        span.set_metric(Datadog::Ext::Analytics::TAG_SAMPLE_RATE, sample_rate)
+      end
+    end
+
+    # Extension for Datadog::Span
+    module Span
+      def self.included(base)
+        if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
+          base.class_eval do
+            # Instance methods
+            include InstanceMethodsCompatibility
+            include InstanceMethods
+          end
+        else
+          base.send(:prepend, InstanceMethods)
+        end
+      end
+
+      # Compatibility shim for Rubies not supporting `.prepend`
+      module InstanceMethodsCompatibility
+        def self.included(base)
+          base.class_eval do
+            alias_method :set_tag_without_analytics, :set_tag
+            remove_method :set_tag
+          end
+        end
+
+        def set_tag(*args, &block)
+          set_tag_without_analytics(*args, &block)
+        end
+      end
+
+      # Instance methods
+      module InstanceMethods
+        def set_tag(key, value)
+          case key
+          when Ext::Analytics::TAG_ENABLED
+            # If true, set rate to 1.0, otherwise set 0.0.
+            value = value == true ? Ext::Analytics::DEFAULT_SAMPLE_RATE : 0.0
+            Analytics.set_sample_rate(self, value)
+          when Ext::Analytics::TAG_SAMPLE_RATE
+            Analytics.set_sample_rate(self, value)
+          else
+            super if defined?(super)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/analytics.rb

@@ -1,8 +1,8 @@
-require 'ddtrace/ext/analytics'
+require 'ddtrace/analytics'
 
 module Datadog
   module Contrib
-    # Defines sampling behavior for integrations
+    # Defines analytics behavior for integrations
     module Analytics
       module_function
 
@@ -13,8 +13,7 @@ module Datadog
       end
 
       def set_sample_rate(span, sample_rate)
-        return if span.nil? || sample_rate.nil?
-        span.set_metric(Datadog::Ext::Analytics::TAG_SAMPLE_RATE, sample_rate)
+        Datadog::Analytics.set_sample_rate(span, sample_rate)
       end
     end
   end

data/lib/ddtrace/contrib/extensions.rb

@@ -7,7 +7,7 @@ module Datadog
     module Extensions
       def self.extended(base)
         Datadog.send(:extend, Helpers)
-        Datadog::Configuration::Settings.send(:include, Configuration)
+        Datadog::Configuration::Settings.send(:include, Configuration::Settings)
       end
 
       # Helper methods for Datadog module.
@@ -17,44 +17,41 @@ module Datadog
         end
       end
 
-      # Extensions for Datadog::Configuration::Settings
       module Configuration
-        InvalidIntegrationError = Class.new(StandardError)
-
-        def self.included(base)
-          # Add the additional options to the global configuration settings
-          base.instance_eval do
-            option :registry, default: Registry.new
+        # Extensions for Datadog::Configuration::Settings
+        module Settings
+          InvalidIntegrationError = Class.new(StandardError)
+
+          def self.included(base)
+            # Add the additional options to the global configuration settings
+            base.instance_eval do
+              option :registry, default: Registry.new
+            end
           end
-        end
 
-        def initialize(options = {})
-          super
-          set_option(:registry, options[:registry]) if options.key?(:registry)
-        end
+          def [](integration_name, configuration_name = :default)
+            integration = fetch_integration(integration_name)
+            integration.configuration(configuration_name) unless integration.nil?
+          end
 
-        def [](integration_name, configuration_name = :default)
-          integration = fetch_integration(integration_name)
-          integration.configuration(configuration_name) unless integration.nil?
-        end
+          def use(integration_name, options = {}, &block)
+            integration = fetch_integration(integration_name)
 
-        def use(integration_name, options = {}, &block)
-          integration = fetch_integration(integration_name)
+            unless integration.nil?
+              configuration_name = options[:describes] || :default
+              filtered_options = options.reject { |k, _v| k == :describes }
+              integration.configure(configuration_name, filtered_options, &block)
+            end
 
-          unless integration.nil?
-            configuration_name = options[:describes] || :default
-            filtered_options = options.reject { |k, _v| k == :describes }
-            integration.configure(configuration_name, filtered_options, &block)
+            integration.patch if integration.respond_to?(:patch)
           end
 
-          integration.patch if integration.respond_to?(:patch)
-        end
-
-        private
+          private
 
-        def fetch_integration(name)
-          get_option(:registry)[name] ||
-            raise(InvalidIntegrationError, "'#{name}' is not a valid integration.")
+          def fetch_integration(name)
+            get_option(:registry)[name] ||
+              raise(InvalidIntegrationError, "'#{name}' is not a valid integration.")
+          end
         end
       end
     end

data/lib/ddtrace/ext/analytics.rb

@@ -2,8 +2,9 @@ module Datadog
   module Ext
     # Defines constants for trace analytics
     module Analytics
+      DEFAULT_SAMPLE_RATE = 1.0
       ENV_TRACE_ANALYTICS_ENABLED = 'DD_TRACE_ANALYTICS_ENABLED'.freeze
-      # Tag for sample rate; used by agent to determine whether analytics event is emitted.
+      TAG_ENABLED = 'analytics.enabled'.freeze
       TAG_SAMPLE_RATE = '_dd1.sr.eausr'.freeze
     end
   end

data/lib/ddtrace/span.rb

@@ -3,6 +3,7 @@ require 'thread'
 
 require 'ddtrace/utils'
 require 'ddtrace/ext/errors'
+require 'ddtrace/analytics'
 
 module Datadog
   # Represents a logical unit of work in the system. Each trace consists of one or more spans.
@@ -252,3 +253,6 @@ module Datadog
     end
   end
 end
+
+# Include extensions after Span (for Ruby 1.9 compatibility)
+Datadog::Span.send(:include, Datadog::Analytics::Span)

data/lib/ddtrace/version.rb

@@ -2,7 +2,7 @@ module Datadog
   module VERSION
     MAJOR = 0
     MINOR = 21
-    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.21.0
+  version: 0.21.1
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-20 00:00:00.000000000 Z
+date: 2019-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -297,6 +297,7 @@ files:
 - docker-compose.yml
 - docs/GettingStarted.md
 - lib/ddtrace.rb
+- lib/ddtrace/analytics.rb
 - lib/ddtrace/augmentation.rb
 - lib/ddtrace/augmentation/method_wrapper.rb
 - lib/ddtrace/augmentation/method_wrapping.rb