ddtrace 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: c2f79e19f4edb6aa8db41960e7ba86d8b17444e5
-  data.tar.gz: 062ddeaa46fe115d62ce88d08a3f9bc37ea9fb5f
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmJhODJmN2VmNjMxNzY5OTg5NGE1NjEwOTgwZTE0MGU5ZTE1ZjJlYQ==
+  data.tar.gz: !binary |-
+    ZTg5OWNhMjdjMDlhNDVlNDMwN2MzODYzNDgyMGM5MTc1MmMwNzFhZg==
 SHA512:
-  metadata.gz: 4bdfa1c9538ce4aac79a3b301474ca1f54d17dbf1c3853c42951c96c758bfc1a9870d4279d589e76894d95138dbcf5e908b1bd871e885d9a77fb7a00a42e8ec6
-  data.tar.gz: 60414076362dc4b4f53928d92b8196b8213f816a9088672011e7c6c4517770d1f01ceb8e52c16cf74ddd1d5c7dd4f38564bc904e435f257b8973def7721811f1
+  metadata.gz: !binary |-
+    ZThkYmY4ZDQ2MjJiNGJkNTg5YTFjYTJhNmRmMWM1NTFiZGFjZGYzOGJhOTM1
+    ZWU3ODc1MDExNDliNTgzMGM3YzZiOTE4ZTE0YTlkNWJmNjkzMzJlOGRhNzQz
+    MzE2MTRhMDNkNzA3NmNmMmJmZWIzYmEwN2U3NzU1NmVhNjMzYWQ=
+  data.tar.gz: !binary |-
+    MWM3N2I4N2IxNDU5NDZhZTU2YWZmNGU2YmMyYjU2ZmZkNTk4YzgxMGVmZGIz
+    YzM0ZDczYWVhZGMyMjhlNzQ1ZTJjMTBiNjRiNjc4YmIwMTE4ODgyYzE1MDEy
+    NTFhYzFhZGFlNzdmN2M5Y2VhNWQ1ZmJjZDRiNDFjM2QxOWM2YWE=

data/.rubocop.yml

@@ -55,3 +55,7 @@ Lint/UnusedMethodArgument:
 Style/SymbolArray:
   Enabled: false
 
+# Simple conditionals are perfectly fine, and more readable for multiline
+# expressions.
+Style/GuardClause:
+  Enabled: false

data/Appraisals

@@ -96,6 +96,7 @@ if RUBY_VERSION >= '2.2.2'
     gem 'hiredis'
     gem 'rack-test'
     gem 'sinatra'
+    gem 'sqlite3'
     gem 'activerecord'
     gem 'sidekiq'
   end
@@ -107,6 +108,7 @@ else
     gem 'rack-test', '0.6.2'
     gem 'rack', '1.4.7'
     gem 'sinatra', '1.4.5'
+    gem 'sqlite3'
     gem 'activerecord', '3.2.22.5'
     gem 'sidekiq', '4.0.0'
   end

data/docs/GettingStarted.md

@@ -65,7 +65,7 @@ of the Datadog tracer, you can override the following defaults:
       debug: false,
       trace_agent_hostname: 'localhost',
       trace_agent_port: 8126,
-      env: Rails.env,
+      env: nil,
       tags: {}
     }
 
@@ -88,7 +88,7 @@ Available settings are:
 * ``debug``: set to true to enable debug logging.
 * ``trace_agent_hostname``: set the hostname of the trace agent.
 * ``trace_agent_port``: set the port the trace agent is listening on.
-* ``env``: set the environment. Defaults to the Rails environment
+* ``env``: set the environment. Rails users may set it to ``Rails.env`` to use their application settings.
 * ``tags``: set global tags that should be applied to all spans. Defaults to an empty hash
 
 ### Sinatra

data/gemfiles/contrib.gemfile

@@ -7,7 +7,9 @@ gem "redis"
 gem "hiredis"
 gem "rack-test"
 gem "sinatra"
+gem 'sqlite3'
 gem "activerecord"
 gem "sidekiq"
+gem "activerecord"
 
 gemspec :path => "../"

data/lib/ddtrace/contrib/active_record/patcher.rb

@@ -0,0 +1,88 @@
+module Datadog
+  module Contrib
+    module ActiveRecord
+      # Patcher enables patching of 'active_record' module.
+      # This is used in monkey.rb to manually apply patches
+      module Patcher
+        @patched = false
+
+        module_function
+
+        # patched? tells whether patch has been successfully applied
+        def patched?
+          @patched
+        end
+
+        def patch
+          if !@patched && defined?(::ActiveRecord)
+            begin
+              require 'ddtrace/contrib/rails/utils'
+              require 'ddtrace/ext/sql'
+
+              patch_active_record()
+
+              @patched = true
+            rescue => e
+              Datadog::Tracer.log.error("Unable to apply Active Record integration: #{e}")
+            end
+          end
+
+          @patched
+        end
+
+        def patch_active_record
+          # subscribe when the active record query has been processed
+          ::ActiveSupport::Notifications.subscribe('sql.active_record') do |*args|
+            sql(*args)
+          end
+        end
+
+        def self.datadog_trace
+          # TODO: Consider using patcher for Rails as well.
+          # @tracer ||= defined?(::Rails) && ::Rails.configuration.datadog_trace
+          @datadog_trace ||= defined?(::Sinatra) && ::Sinatra::Application.settings.datadog_tracer.cfg
+        end
+
+        def self.adapter_name
+          @adapter_name ||= Datadog::Contrib::Rails::Utils.normalize_vendor(
+            ::ActiveRecord::Base.connection_config[:adapter]
+          )
+        end
+
+        def self.tracer
+          @tracer ||= datadog_trace.fetch(:tracer)
+        end
+
+        def self.database_service
+          @database_service ||= datadog_trace.fetch(:default_database_service, adapter_name())
+          if @database_service
+            tracer().set_service_info(@database_service, 'sinatra',
+                                      Datadog::Ext::AppTypes::DB)
+          end
+          @database_service
+        end
+
+        def self.sql(_name, start, finish, _id, payload)
+          span_type = Datadog::Ext::SQL::TYPE
+
+          span = tracer.trace(
+            "#{adapter_name}.query",
+            resource: payload.fetch(:sql),
+            service: database_service,
+            span_type: span_type
+          )
+
+          # the span should have the query ONLY in the Resource attribute,
+          # so that the ``sql.query`` tag will be set in the agent with an
+          # obfuscated version
+          span.span_type = Datadog::Ext::SQL::TYPE
+          span.set_tag('active_record.db.vendor', adapter_name)
+          span.start_time = start
+          span.finish_at(finish)
+        rescue StandardError => e
+          Datadog::Tracer.log.error(e.message)
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/rails/framework.rb

@@ -27,11 +27,12 @@ module Datadog
           debug: false,
           trace_agent_hostname: Datadog::Writer::HOSTNAME,
           trace_agent_port: Datadog::Writer::PORT,
-          env: ::Rails.env,
+          env: nil,
           tags: {}
         }.freeze
 
         # configure Datadog settings
+        # rubocop:disable Metrics/MethodLength
         def self.configure(config)
           # tracer defaults
           # merge default configurations with users settings
@@ -50,6 +51,7 @@ module Datadog
 
           # set default tracer tags
           datadog_config[:tracer].set_tags(datadog_config[:tags])
+
           datadog_config[:tracer].set_tags('env' => datadog_config[:env]) if datadog_config[:env]
 
           # set default service details
@@ -65,6 +67,10 @@ module Datadog
             Datadog::Ext::AppTypes::CACHE
           )
 
+          # By default, default service would be guessed from the script
+          # being executed, but here we know better, get it from Rails config.
+          datadog_config[:tracer].default_service = datadog_config[:default_service]
+
           if defined?(::ActiveRecord)
             begin
               # set default database service details and store it in the configuration

data/lib/ddtrace/contrib/sinatra/tracer.rb

@@ -67,7 +67,7 @@ module Datadog
         end
 
         def enabled?
-          @cfg[:enabled] && @cfg[:tracer]
+          @cfg[:enabled] && !@cfg[:tracer].nil?
         end
       end
 

data/lib/ddtrace/monkey.rb

@@ -3,6 +3,7 @@ require 'thread'
 # We import all patchers for every module we support, but this is fine
 # because patchers do not include any 3rd party module nor even our
 # patching code, which is required on demand, when patching.
+require 'ddtrace/contrib/active_record/patcher'
 require 'ddtrace/contrib/elasticsearch/patcher'
 require 'ddtrace/contrib/http/patcher'
 require 'ddtrace/contrib/redis/patcher'
@@ -11,7 +12,7 @@ module Datadog
   # Monkey is used for monkey-patching 3rd party libs.
   module Monkey
     @patched = []
-    @autopatch_modules = { elasticsearch: true, http: true, redis: true }
+    @autopatch_modules = { elasticsearch: true, http: true, redis: true, active_record: false }
     # Patchers should expose 2 methods:
     # - patch, which applies our patch if needed. Should be idempotent,
     #   can be call twice but should just do nothing the second time.
@@ -19,7 +20,8 @@ module Datadog
     #   patched (patching might have failed if requirements were not here)
     @patchers = { elasticsearch: Datadog::Contrib::Elasticsearch::Patcher,
                   http: Datadog::Contrib::HTTP::Patcher,
-                  redis: Datadog::Contrib::Redis::Patcher }
+                  redis: Datadog::Contrib::Redis::Patcher,
+                  active_record: Datadog::Contrib::ActiveRecord::Patcher }
     @mutex = Mutex.new
 
     module_function

data/lib/ddtrace/tracer.rb

@@ -1,6 +1,7 @@
 require 'pp'
 require 'thread'
 require 'logger'
+require 'pathname'
 
 require 'ddtrace/span'
 require 'ddtrace/buffer'
@@ -17,6 +18,7 @@ module Datadog
   class Tracer
     attr_reader :writer, :sampler, :services, :tags
     attr_accessor :enabled
+    attr_writer :default_service
 
     # Global, memoized, lazy initialized instance of a logger that is used within the the Datadog
     # namespace. This logger outputs to +STDOUT+ by default, and is considered thread-safe.
@@ -107,6 +109,20 @@ module Datadog
       Datadog::Tracer.log.debug("set_service_info: service: #{service} app: #{app} type: #{app_type}")
     end
 
+    # A default value for service. One should really override this one
+    # for non-root spans which have a parent. However, root spans without
+    # a service would be invalid and rejected.
+    def default_service
+      return @default_service if @default_service
+      begin
+        @default_service = File.basename($PROGRAM_NAME, '.*')
+      rescue => e
+        Datadog::Tracer.log.error("unable to guess default service: #{e}")
+        @default_service = 'ruby'.freeze
+      end
+      @default_service
+    end
+
     # Set the given key / value tag pair at the tracer level. These tags will be
     # appended to each span created by the tracer. Keys and values must be strings.
     # A valid example is:
@@ -181,6 +197,8 @@ module Datadog
     # Record the given finished span in the +spans+ list. When a +span+ is recorded, it will be sent
     # to the Datadog trace agent as soon as the trace is finished.
     def record(span)
+      span.service ||= default_service
+
       spans = []
       @mutex.synchronize do
         @spans << span

data/lib/ddtrace/version.rb

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

metadata

@@ -1,113 +1,103 @@
 --- !ruby/object:Gem::Specification
 name: ddtrace
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-05 00:00:00.000000000 Z
+date: 2017-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.47'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.47'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.10'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
-description: |
-  ddtrace is Datadog’s tracing client for Ruby. It is used to trace requests
+description: ! '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.
+
+'
 email:
 - dev@datadoghq.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".env"
-- ".gitignore"
-- ".rubocop.yml"
-- ".yardopts"
+- .env
+- .gitignore
+- .rubocop.yml
+- .yardopts
 - Appraisals
 - Gemfile
 - LICENSE
@@ -133,6 +123,7 @@ files:
 - gemfiles/rails5_postgres_sidekiq.gemfile
 - lib/ddtrace.rb
 - lib/ddtrace/buffer.rb
+- lib/ddtrace/contrib/active_record/patcher.rb
 - lib/ddtrace/contrib/elasticsearch/patcher.rb
 - lib/ddtrace/contrib/elasticsearch/quantize.rb
 - lib/ddtrace/contrib/http/patcher.rb
@@ -178,17 +169,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Datadog tracing code for your Ruby applications