ddtrace 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c166ccd4553aa6b0a63817846b4aca66a7d74f92
-  data.tar.gz: bd1cdacc971045e137b14a5714d0659747e442f2
+  metadata.gz: c2f79e19f4edb6aa8db41960e7ba86d8b17444e5
+  data.tar.gz: 062ddeaa46fe115d62ce88d08a3f9bc37ea9fb5f
 SHA512:
-  metadata.gz: 94e7ee6857c01885d16ada253e8d6cab86704c321e8fa114e6a7fbfb716e940d5aaad62261f9486b44ecb2cdc01bd7992e0dd8d6473c23758c82d8a909344d5e
-  data.tar.gz: 338c3d27571dc226d6c8dede32fb497b90a6a67d7985542fb74b1f0c0dd2d40e9e914eb50e64bd85dfb2c559fe97cdcca7cbccf12c0d36a8ceab444e4009b614
+  metadata.gz: 4bdfa1c9538ce4aac79a3b301474ca1f54d17dbf1c3853c42951c96c758bfc1a9870d4279d589e76894d95138dbcf5e908b1bd871e885d9a77fb7a00a42e8ec6
+  data.tar.gz: 60414076362dc4b4f53928d92b8196b8213f816a9088672011e7c6c4517770d1f01ceb8e52c16cf74ddd1d5c7dd4f38564bc904e435f257b8973def7721811f1

data/Rakefile

@@ -11,7 +11,7 @@ namespace :test do
              :elasticsearch, :http, :redis, :sidekiq, :sinatra, :monkey]
 
   Rake::TestTask.new(:main) do |t|
-    t.libs << %w(test lib)
+    t.libs << %w[test lib]
     t.test_files = FileList['test/**/*_test.rb'].reject do |path|
       path.include?('contrib') ||
         path.include?('benchmark') ||
@@ -21,7 +21,7 @@ namespace :test do
   end
 
   Rake::TestTask.new(:rails) do |t|
-    t.libs << %w(test lib)
+    t.libs << %w[test lib]
     t.test_files = FileList['test/contrib/rails/**/*_test.rb'].reject do |path|
       path.include?('redis') ||
         path.include?('sidekiq') ||
@@ -30,35 +30,35 @@ namespace :test do
   end
 
   Rake::TestTask.new(:railsredis) do |t|
-    t.libs << %w(test lib)
+    t.libs << %w[test lib]
     t.test_files = FileList['test/contrib/rails/**/*redis*_test.rb']
   end
 
   Rake::TestTask.new(:railssidekiq) do |t|
-    t.libs << %w(test lib)
+    t.libs << %w[test lib]
     t.test_files = FileList['test/contrib/rails/**/*sidekiq*_test.rb']
   end
 
   Rake::TestTask.new(:railsactivejob) do |t|
-    t.libs << %w(test lib)
+    t.libs << %w[test lib]
     t.test_files = FileList['test/contrib/rails/**/*active_job*_test.rb']
   end
 
   [:elasticsearch, :http, :redis, :sinatra, :sidekiq].each do |contrib|
     Rake::TestTask.new(contrib) do |t|
-      t.libs << %w(test lib)
+      t.libs << %w[test lib]
       t.test_files = FileList["test/contrib/#{contrib}/*_test.rb"]
     end
   end
 
   Rake::TestTask.new(:monkey) do |t|
-    t.libs << %w(test lib)
+    t.libs << %w[test lib]
     t.test_files = FileList['test/monkey_test.rb']
   end
 end
 
 Rake::TestTask.new(:benchmark) do |t|
-  t.libs << %w(test lib)
+  t.libs << %w[test lib]
   t.test_files = FileList['test/benchmark_test.rb']
 end
 

data/docs/GettingStarted.md

@@ -64,7 +64,9 @@ of the Datadog tracer, you can override the following defaults:
       tracer: Datadog.tracer,
       debug: false,
       trace_agent_hostname: 'localhost',
-      trace_agent_port: 8126
+      trace_agent_port: 8126,
+      env: Rails.env,
+      tags: {}
     }
 
 Available settings are:
@@ -86,6 +88,8 @@ 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
+* ``tags``: set global tags that should be applied to all spans. Defaults to an empty hash
 
 ### Sinatra
 

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

@@ -26,7 +26,9 @@ module Datadog
           tracer: Datadog.tracer,
           debug: false,
           trace_agent_hostname: Datadog::Writer::HOSTNAME,
-          trace_agent_port: Datadog::Writer::PORT
+          trace_agent_port: Datadog::Writer::PORT,
+          env: ::Rails.env,
+          tags: {}
         }.freeze
 
         # configure Datadog settings
@@ -46,12 +48,17 @@ module Datadog
             port: datadog_config[:trace_agent_port]
           )
 
+          # 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
           datadog_config[:tracer].set_service_info(
             datadog_config[:default_service],
             'rails',
             Datadog::Ext::AppTypes::WEB
           )
+
           datadog_config[:tracer].set_service_info(
             datadog_config[:default_cache_service],
             'rails',

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

@@ -50,6 +50,7 @@ module Datadog
         end
 
         # rubocop:disable Metrics/MethodLength
+        # rubocop:disable Metrics/BlockLength
         def patch_redis_client
           ::Redis::Client.class_eval do
             alias_method :initialize_without_datadog, :initialize
@@ -60,6 +61,9 @@ module Datadog
             def initialize(*args)
               pin = Datadog::Pin.new(SERVICE, app: 'redis', app_type: Datadog::Ext::AppTypes::DB)
               pin.onto(self)
+              if pin.tracer && pin.service
+                pin.tracer.set_service_info(pin.service, pin.app, pin.app_type)
+              end
               initialize_without_datadog(*args)
             end
 

data/lib/ddtrace/logger.rb

@@ -0,0 +1,34 @@
+require 'logger'
+
+module Datadog
+  LOG_PREFIX = 'ddtrace'.freeze
+
+  # A custom logger with minor enhancements:
+  # - progname defaults to ddtrace to clearly identify Datadog dd-trace-rb related messages
+  # - adds last caller stack-trace info to know where the message comes from
+  class Logger < ::Logger
+    def initialize(*args, &block)
+      super
+      self.progname = LOG_PREFIX
+    end
+
+    def add(severity, message = nil, progname = nil, &block)
+      return super unless debug?
+
+      # We are in debug mode, add stack trace to help debugging
+      where = ''
+      c = caller
+      where = "(#{c[1]}) " if c.length > 1
+
+      if block_given?
+        super(severity, message, progname) do
+          "#{where}#{yield}"
+        end
+      else
+        super(severity, message, "#{where}#{progname}")
+      end
+    end
+
+    alias log add
+  end
+end

data/lib/ddtrace/pin.rb

@@ -33,7 +33,6 @@ module Datadog
     end
 
     def onto(obj)
-      # rubocop:disable Lint/NestedMethodDefinition
       unless obj.respond_to? :datadog_pin=
         obj.instance_exec do
           def datadog_pin=(pin)
@@ -51,7 +50,6 @@ module Datadog
           end
         end
       end
-      # rubocop:enable Lint/NestedMethodDefinition
 
       obj.datadog_pin = self
     end

data/lib/ddtrace/tracer.rb

@@ -4,6 +4,7 @@ require 'logger'
 
 require 'ddtrace/span'
 require 'ddtrace/buffer'
+require 'ddtrace/logger'
 require 'ddtrace/writer'
 require 'ddtrace/sampler'
 
@@ -14,19 +15,34 @@ module Datadog
   # Even though the request may require multiple resources and machines to handle the request, all
   # of these function calls and sub-requests would be encapsulated within a single trace.
   class Tracer
-    attr_reader :writer, :sampler, :services
+    attr_reader :writer, :sampler, :services, :tags
     attr_accessor :enabled
 
     # 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.
     def self.log
       unless defined? @logger
-        @logger = Logger.new(STDOUT)
+        @logger = Datadog::Logger.new(STDOUT)
         @logger.level = Logger::WARN
       end
       @logger
     end
 
+    # Override the default logger with a custom one.
+    def self.log=(logger)
+      return unless logger
+      return unless logger.respond_to? :methods
+      return unless logger.respond_to? :error
+      if logger.respond_to? :methods
+        unimplemented = Logger.new(STDOUT).methods - logger.methods
+        unless unimplemented.empty?
+          logger.error("logger #{logger} does not implement #{unimplemented}")
+          return
+        end
+      end
+      @logger = logger
+    end
+
     # Activate the debug mode providing more information related to tracer usage
     def self.debug_logging=(value)
       log.level = value ? Logger::DEBUG : Logger::WARN
@@ -52,6 +68,7 @@ module Datadog
       @mutex = Mutex.new
       @spans = []
       @services = {}
+      @tags = {}
     end
 
     # Updates the current \Tracer instance, so that the tracer can be configured after the
@@ -90,6 +107,15 @@ module Datadog
       Datadog::Tracer.log.debug("set_service_info: service: #{service} app: #{app} type: #{app_type}")
     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:
+    #
+    #   tracer.set_tags('env' => 'prod', 'component' => 'core')
+    def set_tags(tags)
+      @tags.update(tags)
+    end
+
     # Return a +span+ that will trace an operation called +name+. You could trace your code
     # using a <tt>do-block</tt> like:
     #
@@ -126,6 +152,8 @@ module Datadog
       span.set_parent(parent)
       @buffer.set(span)
 
+      @tags.each { |k, v| span.set_tag(k, v) } unless @tags.empty?
+
       # sampling
       if parent.nil?
         @sampler.sample(span)

data/lib/ddtrace/version.rb

@@ -2,7 +2,7 @@ module Datadog
   module VERSION
     MAJOR = 0
     MINOR = 6
-    PATCH = 0
+    PATCH = 1
 
     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.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-28 00:00:00.000000000 Z
+date: 2017-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -156,6 +156,7 @@ files:
 - lib/ddtrace/ext/net.rb
 - lib/ddtrace/ext/redis.rb
 - lib/ddtrace/ext/sql.rb
+- lib/ddtrace/logger.rb
 - lib/ddtrace/monkey.rb
 - lib/ddtrace/pin.rb
 - lib/ddtrace/sampler.rb