ddtrace 0.3.1 → 0.4.0

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

@@ -0,0 +1,181 @@
+
+require 'sinatra/base'
+
+require 'ddtrace/ext/app_types'
+require 'ddtrace/ext/errors'
+require 'ddtrace/ext/http'
+
+sinatra_vs = Gem::Version.new(Sinatra::VERSION)
+sinatra_min_vs = Gem::Version.new('1.4.0')
+if sinatra_vs < sinatra_min_vs
+  raise "sinatra version #{sinatra_vs} is not supported yet " \
+        + "(supporting versions >=#{sinatra_min_vs})"
+end
+
+Datadog::Tracer.log.info("activating instrumentation for sinatra #{sinatra_vs}")
+
+module Datadog
+  module Contrib
+    module Sinatra
+      # TracerCfg is used to manipulate the configuration of the Sinatra
+      # tracing extension.
+      class TracerCfg
+        DEFAULT_CFG = {
+          enabled: true,
+          default_service: 'sinatra',
+          tracer: Datadog.tracer,
+          debug: false,
+          trace_agent_hostname: Datadog::Writer::HOSTNAME,
+          trace_agent_port: Datadog::Writer::PORT
+        }.freeze()
+
+        attr_accessor :cfg
+
+        def initialize
+          @cfg = DEFAULT_CFG.dup()
+        end
+
+        def configure(**args)
+          args.each do |name, value|
+            self[name] = value
+          end
+
+          apply()
+        end
+
+        def apply
+          Datadog::Tracer.debug_logging = @cfg[:debug]
+
+          tracer = @cfg[:tracer]
+
+          tracer.enabled = @cfg[:enabled]
+          tracer.configure(hostname: @cfg[:trace_agent_hostname],
+                           port: @cfg[:trace_agent_port])
+
+          tracer.set_service_info(@cfg[:default_service], 'sinatra',
+                                  Datadog::Ext::AppTypes::WEB)
+        end
+
+        def [](key)
+          raise ArgumentError, "unknown setting '#{key}'" unless @cfg.key? key
+          @cfg[key]
+        end
+
+        def []=(key, value)
+          raise ArgumentError, "unknown setting '#{key}'" unless @cfg.key? key
+          @cfg[key] = value
+        end
+
+        def enabled?
+          @cfg[:enabled] && @cfg[:tracer]
+        end
+      end
+
+      # Datadog::Contrib::Sinatra::Tracer is a Sinatra extension which traces
+      # requests.
+      module Tracer
+        def route(verb, action, *)
+          # Keep track of the route name when the app is instantiated for an
+          # incoming request.
+          condition do
+            @datadog_route = action
+          end
+
+          super
+        end
+
+        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/MethodLength
+        # rubocop:disable Metrics/PerceivedComplexity
+        def self.registered(app)
+          ::Sinatra::Base.module_eval do
+            def render(engine, data, *)
+              cfg = settings.datadog_tracer
+
+              output = ''
+              if cfg.enabled?
+                tracer = cfg[:tracer]
+                tracer.trace('sinatra.render_template') do |span|
+                  # If data is a string, it is a literal template and we don't
+                  # want to record it.
+                  span.set_tag('sinatra.template_name', data) if data.is_a? Symbol
+                  output = super
+                end
+              else
+                output = super
+              end
+
+              output
+            end
+          end
+
+          app.set :datadog_tracer, TracerCfg.new()
+
+          app.configure do
+            app.settings.datadog_tracer.apply()
+          end
+
+          app.before do
+            cfg = settings.datadog_tracer
+            return unless cfg.enabled?
+
+            if instance_variable_defined? :@datadog_request_span
+              if @datadog_request_span
+                Datadog::Tracer.log.error('request span active in :before hook')
+                @datadog_request_span.finish()
+                @datadog_request_span = nil
+              end
+            end
+
+            tracer = cfg[:tracer]
+
+            span = tracer.trace('sinatra.request',
+                                service: cfg.cfg[:default_service],
+                                span_type: Datadog::Ext::HTTP::TYPE)
+            span.set_tag(Datadog::Ext::HTTP::URL, request.path)
+            span.set_tag(Datadog::Ext::HTTP::METHOD, request.request_method)
+
+            @datadog_request_span = span
+          end
+
+          app.after do
+            cfg = settings.datadog_tracer
+            return unless cfg.enabled?
+
+            span = @datadog_request_span
+            begin
+              unless span
+                Datadog::Tracer.log.error('missing request span in :after hook')
+                return
+              end
+
+              span.resource = "#{request.request_method} #{@datadog_route}"
+              span.set_tag('sinatra.route.path', @datadog_route)
+              span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, response.status)
+
+              if response.server_error?
+                span.status = 1
+
+                err = env['sinatra.error']
+                if err
+                  span.set_tag(Datadog::Ext::Errors::TYPE, err.class)
+                  span.set_tag(Datadog::Ext::Errors::MSG, err.message)
+                end
+              end
+
+              span.finish()
+            ensure
+              @datadog_request_span = nil
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+# rubocop:disable Style/Documentation
+module Sinatra
+  register Datadog::Contrib::Sinatra::Tracer
+end

data/lib/ddtrace/monkey.rb

@@ -4,19 +4,21 @@ require 'thread'
 # because patchers do not include any 3rd party module nor even our
 # patching code, which is required on demand, when patching.
 require 'ddtrace/contrib/elasticsearch/patcher'
+require 'ddtrace/contrib/http/patcher'
 require 'ddtrace/contrib/redis/patcher'
 
 module Datadog
   # Monkey is used for monkey-patching 3rd party libs.
   module Monkey
     @patched = []
-    @autopatch_modules = { elasticsearch: true, redis: true }
+    @autopatch_modules = { elasticsearch: true, http: true, redis: true }
     # 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.
     # - patched?, which returns true if the module has been succesfully
     #   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 }
     @mutex = Mutex.new
 
@@ -56,5 +58,17 @@ module Datadog
       end
       patched
     end
+
+    def without_warnings
+      # This is typically used when monkey patching functions such as
+      # intialize, which Ruby advices you not to. Use cautiously.
+      v = $VERBOSE
+      $VERBOSE = nil
+      begin
+        yield
+      ensure
+        $VERBOSE = v
+      end
+    end
   end
 end

data/lib/ddtrace/pin.rb

@@ -36,7 +36,7 @@ module Datadog
       unless obj.respond_to? :datadog_pin=
         obj.instance_exec do
           def datadog_pin=(pin)
-            Datadog::Tracer.log.debug('Set pin #{pin.service} on #{obj.class}.')
+            Datadog::Tracer.log.debug("Set pin #{pin.service} on #{self.class}.")
             @datadog_pin = pin
           end
         end
@@ -45,7 +45,7 @@ module Datadog
       unless obj.respond_to? :datadog_pin
         obj.instance_exec do
           def datadog_pin
-            Datadog::Tracer.log.debug('Get pin from #{obj.class}.')
+            Datadog::Tracer.log.debug("Get pin from #{self.class}.")
             @datadog_pin
           end
         end

data/lib/ddtrace/span.rb

@@ -67,9 +67,9 @@ module Datadog
     def set_error(e)
       return if e.nil?
       @status = 1
-      @meta[Datadog::Ext::Errors::MSG] = e.message
+      @meta[Datadog::Ext::Errors::MSG] = e.message if e.respond_to?(:message) && e.message
       @meta[Datadog::Ext::Errors::TYPE] = e.class.to_s
-      @meta[Datadog::Ext::Errors::STACK] = e.backtrace.join("\n")
+      @meta[Datadog::Ext::Errors::STACK] = e.backtrace.join("\n") if e.respond_to?(:backtrace) && e.backtrace
     end
 
     # Mark the span finished at the current time and submit it.

data/lib/ddtrace/transport.rb

@@ -9,6 +9,7 @@ module Datadog
   # so that the Transport is thread-safe.
   class HTTPTransport
     attr_accessor :hostname, :port
+    attr_reader :traces_endpoint, :services_endpoint
 
     # seconds before the transport timeout
     TIMEOUT = 1

data/lib/ddtrace/version.rb

@@ -1,8 +1,8 @@
 module Datadog
   module VERSION
     MAJOR = 0
-    MINOR = 3
-    PATCH = 1
+    MINOR = 4
+    PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddtrace
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-23 00:00:00.000000000 Z
+date: 2017-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -24,62 +24,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.43'
+        version: '0.47'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.43'
+        version: '0.47'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.10'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -131,6 +117,7 @@ files:
 - lib/ddtrace/contrib/elasticsearch/core.rb
 - lib/ddtrace/contrib/elasticsearch/patcher.rb
 - lib/ddtrace/contrib/elasticsearch/quantize.rb
+- lib/ddtrace/contrib/http/patcher.rb
 - lib/ddtrace/contrib/rails/action_controller.rb
 - lib/ddtrace/contrib/rails/action_view.rb
 - lib/ddtrace/contrib/rails/active_record.rb
@@ -138,10 +125,10 @@ files:
 - lib/ddtrace/contrib/rails/core_extensions.rb
 - lib/ddtrace/contrib/rails/framework.rb
 - lib/ddtrace/contrib/rails/utils.rb
-- lib/ddtrace/contrib/redis/core.rb
 - lib/ddtrace/contrib/redis/patcher.rb
 - lib/ddtrace/contrib/redis/quantize.rb
 - lib/ddtrace/contrib/redis/tags.rb
+- lib/ddtrace/contrib/sinatra/tracer.rb
 - lib/ddtrace/encoding.rb
 - lib/ddtrace/ext/app_types.rb
 - lib/ddtrace/ext/cache.rb
@@ -180,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.9
 signing_key: 
 specification_version: 4
 summary: Datadog tracing code for your Ruby applications

data/lib/ddtrace/contrib/redis/core.rb

@@ -1,72 +0,0 @@
-require 'ddtrace/ext/app_types'
-require 'ddtrace/contrib/redis/tags'
-require 'ddtrace/contrib/redis/quantize'
-
-module Datadog
-  module Contrib
-    module Redis
-      SERVICE = 'redis'.freeze
-
-      DRIVER = 'redis.driver'.freeze
-
-      # TracedRedis is a wrapper so that caller can pin on parent object without knowing about client member.
-      module TracedRedis
-        def datadog_pin=(pin)
-          # Forward the pin to client, which actually traces calls.
-          Datadog::Pin.onto(client, pin)
-        end
-
-        def datadog_pin
-          # Get the pin from client, which actually traces calls.
-          Datadog::Pin.get_from(client)
-        end
-      end
-
-      # Datadog APM Redis integration.
-      module TracedRedisClient
-        def initialize(*args)
-          pin = Datadog::Pin.new(SERVICE, app: 'redis', app_type: Datadog::Ext::AppTypes::DB)
-          pin.onto(self)
-          super(*args)
-        end
-
-        def call(*args, &block)
-          pin = Datadog::Pin.get_from(self)
-          return super(*args, &block) unless pin
-
-          response = nil
-          pin.tracer.trace('redis.command') do |span|
-            span.service = pin.service
-            span.span_type = Datadog::Ext::Redis::TYPE
-            span.resource = Datadog::Contrib::Redis::Quantize.format_command_args(*args)
-            span.set_tag(Datadog::Ext::Redis::RAWCMD, span.resource)
-            Datadog::Contrib::Redis::Tags.set_common_tags(self, span)
-
-            response = super(*args, &block)
-          end
-
-          response
-        end
-
-        def call_pipeline(*args, &block)
-          pin = Datadog::Pin.get_from(self)
-          return super(*args, &block) unless pin
-
-          response = nil
-          pin.tracer.trace('redis.command') do |span|
-            span.service = pin.service
-            span.span_type = Datadog::Ext::Redis::TYPE
-            commands = args[0].commands.map { |c| Datadog::Contrib::Redis::Quantize.format_command_args(c) }
-            span.resource = commands.join("\n")
-            span.set_tag(Datadog::Ext::Redis::RAWCMD, span.resource)
-            Datadog::Contrib::Redis::Tags.set_common_tags(self, span)
-
-            response = super(*args, &block)
-          end
-
-          response
-        end
-      end
-    end
-  end
-end