ddtrace 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82af04eeea1caa84867aaa757ad13417edc2023e
-  data.tar.gz: 2f08f3addafedcdb596eaa5745085373172b3c53
+  metadata.gz: 72729f2159c8955311ce44e2f616f76dad528f3e
+  data.tar.gz: b29b89057f37fdc35e2e3c94155a4929997fb437
 SHA512:
-  metadata.gz: f8a4f8c8a1c8e105adf40b1d47cc7504ca8b247eb7763f560ed6a86718e5213a1cd44c07f82ff2a73625d586490e5e81df49d6d1f143cc27681ad7b541fa8028
-  data.tar.gz: e9bb6304e1e375050d9203601881b50b9422aa53c64ba8938c5b75d052946e12ae1384be6dd5364c94df01839fffc4e2986f37d5880d52ca720b742add8dd0ad
+  metadata.gz: 27b419978a59a4e55d637f0a9d03a288c9e0d7869bf2c02a6265ba75bc3579ea051fa62ff6c1d48b0f69420b99e9b4387c51833849361a505c99b71d008b8f01
+  data.tar.gz: 679a3d8bcc5a4f46e59565da6f5f61c23501a4905c7adaae522b507059ea2c1b7ec9601e69772f4ea3e93db196185df04a635393b2eb1fab465bcc542a748afd

data/.yardopts

@@ -0,0 +1 @@
+--readme docs/index.rdoc

data/README.md

@@ -12,13 +12,17 @@ You can find the latest documentation in the Datadog's [private repository][docs
 
 ### Install
 
+Install the Ruby client with the ``gem`` command:
+
+    gem install ddtrace
+
 If you're using ``Bundler``, just update your ``Gemfile`` as follows:
 
 ```ruby
     source 'https://rubygems.org'
 
     # tracing gem
-    gem 'ddtrace', :source => 'http://gems.datadoghq.com/trace/'
+    gem 'ddtrace'
 ```
 
 ### Quickstart (manual instrumentation)

data/Rakefile

@@ -1,8 +1,9 @@
 require 'bundler/gem_tasks'
+require 'ddtrace/version'
 require 'rubocop/rake_task'
 require 'rake/testtask'
-require 'rdoc/task'
 require 'appraisal'
+require 'yard'
 
 namespace :test do
   task all: [:main, :rails, :railsredis, :elasticsearch, :http, :redis, :sinatra, :monkey]
@@ -51,12 +52,8 @@ RuboCop::RakeTask.new(:rubocop) do |t|
   t.patterns = ['lib/**/*.rb', 'test/**/*.rb', 'Gemfile', 'Rakefile']
 end
 
-RDoc::Task.new(:rdoc) do |doc|
-  doc.main   = 'docs/GettingStarted'
-  doc.title  = 'Datadog Ruby Tracer'
-  # TODO[manu]: include all lib/ folder, but only when all classes' docs are ready
-  doc.rdoc_files = FileList.new(%w(lib/ddtrace/tracer.rb lib/ddtrace/span.rb docs/**/*))
-  doc.rdoc_dir = 'html'
+YARD::Rake::YardocTask.new(:docs) do |t|
+  t.options += ['--title', "ddtrace #{Datadog::VERSION::STRING} documentation"]
 end
 
 # Deploy tasks
@@ -98,9 +95,38 @@ task :'release:gem' do
 end
 
 desc 'release the docs website'
-task :'release:docs' => :rdoc do
+task :'release:docs' => :docs do
   raise 'Missing environment variable S3_DIR' if !S3_DIR || S3_DIR.empty?
-  sh "aws s3 cp --recursive html/ s3://#{S3_BUCKET}/#{S3_DIR}/docs/"
+  sh "aws s3 cp --recursive doc/ s3://#{S3_BUCKET}/#{S3_DIR}/docs/"
+end
+
+desc 'CI dependent task; it runs all parallel tests'
+task :ci do
+  # CircleCI uses this environment to store the node index (starting from 0)
+  # check: https://circleci.com/docs/parallel-manual-setup/#env-splitting
+  case ENV['CIRCLE_NODE_INDEX'].to_i
+  when 0
+    sh 'rvm $MRI_VERSIONS --verbose do rake test:main'
+    sh 'rvm $LAST_STABLE --verbose do rake benchmark'
+  when 1
+    sh 'rvm $MRI_VERSIONS --verbose do appraisal contrib rake test:monkey'
+    sh 'rvm $MRI_VERSIONS --verbose do appraisal contrib rake test:elasticsearch'
+    sh 'rvm $MRI_VERSIONS --verbose do appraisal contrib rake test:http'
+    sh 'rvm $MRI_VERSIONS --verbose do appraisal contrib rake test:redis'
+    sh 'rvm $MRI_VERSIONS --verbose do appraisal contrib rake test:sinatra'
+  when 2
+    sh 'rvm $RAILS_VERSIONS --verbose do appraisal rails3-postgres rake test:rails'
+    sh 'rvm $RAILS_VERSIONS --verbose do appraisal rails3-mysql2 rake test:rails'
+    sh 'rvm $RAILS_VERSIONS --verbose do appraisal rails4-postgres rake test:rails'
+    sh 'rvm $RAILS_VERSIONS --verbose do appraisal rails4-mysql2 rake test:rails'
+    sh 'rvm $RAILS5_VERSIONS --verbose do appraisal rails5-postgres rake test:rails'
+    sh 'rvm $RAILS5_VERSIONS --verbose do appraisal rails5-mysql2 rake test:rails'
+    sh 'rvm $RAILS_VERSIONS --verbose do appraisal rails3-postgres-redis rake test:railsredis'
+    sh 'rvm $RAILS_VERSIONS --verbose do appraisal rails4-postgres-redis rake test:railsredis'
+    sh 'rvm $RAILS5_VERSIONS --verbose do appraisal rails5-postgres-redis rake test:railsredis'
+  else
+    puts 'Too many workers than parallel tasks'
+  end
 end
 
 task default: :test

data/circle.yml

@@ -2,6 +2,7 @@ machine:
   services:
     - docker
   environment:
+    # FIXME: Disabled $JRUBY_VERSIONS tests because of a Java incompatibility
     LAST_STABLE: 2.4.0
     EARLY_STABLE: 2.1.10
     MRI_VERSIONS: 2.4.0,2.3.3,2.2.6,2.1.10
@@ -19,16 +20,16 @@ dependencies:
     # only docker-engine==1.9
     - pip install docker-compose==1.7.1
     - docker-compose up -d | cat
-    # configure Ruby interpreters
+    # installing dev dependencies
+    - gem update --system
     - gem install builder
+    - gem update bundler
     - bundle install
+    # configure Ruby interpreters
     - rvm get head
     - rvm install $MRI_VERSIONS
-    # prepare and run the trace agent
-    # TODO[manu]: remove this part when everything will be open source
-    - git clone git@github.com:DataDog/datadog-trace-agent.git $AGENT_BUILD_PATH
-    - cd $AGENT_BUILD_PATH && docker build -t datadog/trace-agent .
-    - docker run -d -e DD_API_KEY=invalid_key_but_this_is_fine -e DD_BIND_HOST=0.0.0.0 -p 127.0.0.1:7777:7777 datadog/trace-agent
+    # run the agent
+    - docker run -d -e DD_API_KEY=invalid_key_but_this_is_fine -e DD_BIND_HOST=0.0.0.0 -e DD_APM_ENABLED=true -p 127.0.0.1:8126:8126 -p 127.0.0.1:7777:7777 datadog/docker-dd-agent
   override:
     - rvm $MRI_VERSIONS --verbose do gem update --system
     - rvm $MRI_VERSIONS --verbose do gem install bundler
@@ -38,24 +39,9 @@ dependencies:
 test:
   override:
     - rvm $EARLY_STABLE --verbose do rake rubocop
-# Disabled $JRUBY_VERSIONS tests because of a Java incompatibility
-# TODO: integration tests should run with the master branch of the agent
-    - rvm $MRI_VERSIONS --verbose do rake test:main
-    - rvm $MRI_VERSIONS --verbose do appraisal contrib rake test:monkey
-    - rvm $MRI_VERSIONS --verbose do appraisal contrib rake test:elasticsearch
-    - rvm $MRI_VERSIONS --verbose do appraisal contrib rake test:http
-    - rvm $MRI_VERSIONS --verbose do appraisal contrib rake test:redis
-    - rvm $MRI_VERSIONS --verbose do appraisal contrib rake test:sinatra
-    - rvm $RAILS_VERSIONS --verbose do appraisal rails3-postgres rake test:rails
-    - rvm $RAILS_VERSIONS --verbose do appraisal rails3-mysql2 rake test:rails
-    - rvm $RAILS_VERSIONS --verbose do appraisal rails4-postgres rake test:rails
-    - rvm $RAILS_VERSIONS --verbose do appraisal rails4-mysql2 rake test:rails
-    - rvm $RAILS5_VERSIONS --verbose do appraisal rails5-postgres rake test:rails
-    - rvm $RAILS5_VERSIONS --verbose do appraisal rails5-mysql2 rake test:rails
-    - rvm $RAILS_VERSIONS --verbose do appraisal rails3-postgres-redis rake test:railsredis
-    - rvm $RAILS_VERSIONS --verbose do appraisal rails4-postgres-redis rake test:railsredis
-    - rvm $RAILS5_VERSIONS --verbose do appraisal rails5-postgres-redis rake test:railsredis
-    - rvm $LAST_STABLE --verbose do rake benchmark
+    # TODO: integration tests should run with the master branch of the agent
+    - rake ci:
+        parallel: true
 
 deployment:
   develop:

data/ddtrace.gemspec

@@ -37,4 +37,5 @@ EOS
   spec.add_development_dependency "rubocop", "~> 0.47"
   spec.add_development_dependency "minitest", "~> 5.10"
   spec.add_development_dependency "appraisal", "~> 2.1"
+  spec.add_development_dependency "yard", "~> 0.9"
 end

data/docs/{GettingStarted → index.rdoc}

@@ -3,72 +3,30 @@
 _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.
 
-== Installation
+== Install the gem
 
-Install the tracer with the +gem+ command, but point to Datadog's gems repository:
-
-    $ gem install ddtrace
-
-On the other hand, if you're using +Bundler+, just update your +Gemfile+ as follows:
+Install the tracing client, adding the following gem in your +Gemfile+:
 
     source 'https://rubygems.org'
 
     # tracing gem
     gem 'ddtrace'
 
-If you're using the Ruby on Rails framework, you need to configure the auto-instrumentation with an {extra step}[#label-Auto+Instrumentation].
+If you're not using +Bundler+ to manage your dependencies, you can install +ddtrace+ with:
 
-== Quickstart (Auto Instrumentation)
+    gem install ddtrace
 
-If you are on a {supported integration}[#label-Integrations], you should be able to generate traffic and view
-metrics listed in your service list.
+We strongly suggest pinning the version of the library you deploy.
 
-== Quickstart (Manual Instrumentation)
+== Quickstart
 
-If you aren't using a supported framework instrumentation, you may want to to manually instrument your code.
-Adding tracing to your code is very simple. As an example, let’s imagine we have a web server and we want
-to trace requests to the home page:
+The easiest way to get started with the tracing client is to instrument your web application. +ddtrace+ gem
+provides auto instrumentation for the following web frameworks:
 
-    require 'ddtrace'
-    require 'sinatra'
-    require 'activerecord'
+* {Ruby on Rails}[#label-Ruby+on+Rails]
+* {Sinatra}[#label-Sinatra]
 
-    # a generic tracer that you can use across your application
-    tracer = Datadog.tracer
-
-    get '/' do
-      tracer.trace('web.request') do |span|
-        # set some span metadata
-        span.service = 'my-web-site'
-        span.resource = '/'
-        span.set_tag('http.method', request.request_method)
-
-        # trace the activerecord call
-        tracer.trace('posts.fetch') do
-          @posts = Posts.order(created_at: :desc).limit(10)
-        end
-
-        # trace the template rendering
-        tracer.trace('template.render') do
-          erb :index
-        end
-      end
-    end
-
-== Glossary
-
-[Service] The name of a set of processes that do the same job. Some examples are +datadog-web-app+ or +datadog-metrics-db+.
-
-[Resource] A particular query to a service. For a web application, some examples might be a URL stem like +/user/home+ or a
-           handler function like +web.user.home+. For a SQL database, a resource would be the SQL of the query itself like
-           <tt>select * from users where id = ?</tt>.
-           You can track thousands (not millions or billions) of unique resources per services, so prefer resources like
-           +/user/home+ rather than <tt>/user/home?id=123456789</tt>.
-
-[Span] A span tracks a unit of work in a service, like querying a database or rendering a template. Spans are associated
-       with a service and optionally a resource. Spans have names, start times, durations and optional tags.
-
-== Integrations
+== Web Frameworks
 
 === Ruby on \Rails
 
@@ -76,13 +34,7 @@ The \Rails integration will trace requests, database calls, templates rendering
 operations. The integration makes use of the Active Support Instrumentation, listening to the Notification API
 so that any operation instrumented by the API is traced.
 
-==== Auto Instrumentation
-
-Add the tracer gem to your +Gemfile+:
-
-    gem 'ddtrace'
-
-To enable the Rails auto-instrumentation, you must create an initializer file in your +config/+ folder:
+To enable the Rails auto instrumentation, create an initializer file in your +config/+ folder:
 
     # config/initializers/datadog-tracer.rb
 
@@ -94,29 +46,7 @@ To enable the Rails auto-instrumentation, you must create an initializer file in
 
 If you're using \Rails 3 or higher, your application will be listed as +my-rails-app+ in your service list.
 
-==== Custom Instrumentation
-
-If you need to instrument custom code within your controllers, you can simply:
-
-    class CustomController < ApplicationController
-      def index
-        # using auto instrumentation, these calls are already traced
-        @values = SomeModel.all
-        @counter = Rails.cache.fetch('custom_cache_key')
-
-        # use the global tracer to instrument your code
-        tracer = Datadog.tracer
-        tracer.trace('custom.service') do
-          data = Something::fetch_data()
-          @objects = Something::parse_data(data)
-        end
-      end
-    end
-
-With the auto instrumentation turned on, the result trace will include your span correctly nested under the
-+rails.request+ span.
-
-==== Tracer Configuration
+==== Configure the tracer with initializers
 
 All tracing settings are namespaced under the +Rails.configuration.datadog_tracer+ hash. To change the default behavior
 of the Datadog tracer, you can override the following defaults:
@@ -128,6 +58,7 @@ of the Datadog tracer, you can override the following defaults:
       auto_instrument: false,
       auto_instrument_redis: false,
       default_service: 'rails-app',
+      default_database_service: 'postgresql',
       default_cache_service: 'rails-cache',
       template_base_path: 'views/',
       tracer: Datadog.tracer,
@@ -136,7 +67,7 @@ of the Datadog tracer, you can override the following defaults:
       trace_agent_port: 7777
     }
 
-The available settings are:
+Available settings are:
 
 * +enabled+: defines if the +tracer+ is enabled or not. If set to +false+ the code could be still instrumented
   because of other settings, but no spans are sent to the local trace agent.
@@ -158,35 +89,32 @@ The available settings are:
 
 === Sinatra
 
-The Sinatra integration traces requests and template rendering. The
-integration is based on the +Datadog::Contrib::Sinatra::Tracer+ extension.
-
-==== Setup
+The Sinatra integration traces requests and template rendering. The integration is based on the
++Datadog::Contrib::Sinatra::Tracer+ extension.
 
-Add the tracer gem to your +Gemfile+:
-
-    gem 'ddtrace'
-
-Make sure you import +ddtrace+ and +ddtrace/contrib/sinatra/tracer+ after
+To start using the tracing client, make sure you import +ddtrace+ and +ddtrace/contrib/sinatra/tracer+ after
 either +sinatra+ or +sinatra/base+:
 
     require 'sinatra'
     require 'ddtrace'
     require 'ddtrace/contrib/sinatra/tracer'
 
+    get '/' do
+      'Hello world!'
+    end
+
 The tracing extension will be automatically activated.
 
-==== Configuration
+==== Configure the tracer
 
-To modify the default configuration, use the
-+settings.datadog_tracer.configure+ method. For example, to change the default
-service name and activate the debug mode:
+To modify the default configuration, use the +settings.datadog_tracer.configure+ method. For example,
+to change the default service name and activate the debug mode:
 
     configure do
       settings.datadog_tracer.configure default_service: 'my-app', debug: true
     end
 
-The available settings are:
+Available settings are:
 
 * +enabled+: define if the +tracer+ is enabled or not. If set to +false+, the code is still instrumented
   but no spans are sent to the local trace agent.
@@ -197,6 +125,8 @@ The available settings are:
 * +trace_agent_hostname+: set the hostname of the trace agent.
 * +trace_agent_port+: set the port the trace agent is listening on.
 
+== Other libraries
+
 === Redis
 
 The \Redis integration will trace simple calls as well as pipelines.
@@ -245,7 +175,39 @@ The \Net/HTTP integration will trace any HTTP call using the standard lib
 
     content = Net::HTTP.get(URI('http://127.0.0.1/index.html'))
 
-== Monkey Patching
+== Advanced usage
+
+=== Manual Instrumentation
+
+If you aren't using a supported framework instrumentation, you may want to to manually instrument your code.
+Adding tracing to your code is very simple. As an example, let’s imagine we have a web server and we want
+to trace requests to the home page:
+
+    require 'ddtrace'
+    require 'sinatra'
+    require 'activerecord'
+
+    # a generic tracer that you can use across your application
+    tracer = Datadog.tracer
+
+    get '/' do
+      tracer.trace('web.request') do |span|
+        # set some span metadata
+        span.service = 'my-web-site'
+        span.resource = '/'
+        span.set_tag('http.method', request.request_method)
+
+        # trace the activerecord call
+        tracer.trace('posts.fetch') do
+          @posts = Posts.order(created_at: :desc).limit(10)
+        end
+
+        # trace the template rendering
+        tracer.trace('template.render') do
+          erb :index
+        end
+      end
+    end
 
 === Patching methods
 
@@ -341,7 +303,7 @@ You can use this object to instrument your own code:
       end
     end
 
-== Debug Mode
+=== Debug Mode
 
 If you need to check locally what traces and spans are sent after each traced block, you can enable
 a global debug mode for all tracers so that every time a trace is ready to be sent, the content will be
@@ -367,7 +329,9 @@ for the first time:
 Remember that the debug mode may affect your application performance and so it must not be used
 in a production environment.
 
-== Supported Versions
+=== Supported Versions
+
+==== Ruby interpreters
 
 The \Datadog Trace Client has been tested with the following Ruby versions:
 
@@ -379,7 +343,7 @@ The \Datadog Trace Client has been tested with the following Ruby versions:
 
 Other versions aren't yet officially supported.
 
-=== Rails support
+==== Ruby on Rails versions
 
 The supported versions are:
 
@@ -392,6 +356,19 @@ The currently supported web server are:
 * Unicorn 4.8+ and 5.1+
 * Passenger 5.0+
 
-=== Sinatra support
+==== Sinatra versions
 
 Currently we are supporting Sinatra >= 1.4.0.
+
+=== Glossary
+
+[Service] The name of a set of processes that do the same job. Some examples are +datadog-web-app+ or +datadog-metrics-db+.
+
+[Resource] A particular query to a service. For a web application, some examples might be a URL stem like +/user/home+ or a
+           handler function like +web.user.home+. For a SQL database, a resource would be the SQL of the query itself like
+           <tt>select * from users where id = ?</tt>.
+           You can track thousands (not millions or billions) of unique resources per services, so prefer resources like
+           +/user/home+ rather than <tt>/user/home?id=123456789</tt>.
+
+[Span] A span tracks a unit of work in a service, like querying a database or rendering a template. Spans are associated
+       with a service and optionally a resource. Spans have names, start times, durations and optional tags.

data/gemfiles/contrib.gemfile

@@ -5,5 +5,7 @@ source "https://rubygems.org"
 gem "elasticsearch-transport"
 gem "redis"
 gem "hiredis"
+gem "rack-test"
+gem "sinatra"
 
 gemspec :path => "../"

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

@@ -74,7 +74,6 @@ module Datadog
                 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 = call_without_datadog(*args, &block)
@@ -95,7 +94,6 @@ module Datadog
                 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 = call_pipeline_without_datadog(*args, &block)

data/lib/ddtrace/ext/redis.rb

@@ -6,11 +6,6 @@ module Datadog
 
       # net extension
       DB = 'out.redis_db'.freeze
-
-      # standard tags
-      RAWCMD = 'redis.raw_command'.freeze
-      ARGS_LEN = 'redis.args_length'.freeze
-      PIPELINE_LEN = 'redis.pipeline_length'.freeze
     end
   end
 end

data/lib/ddtrace/tracer.rb

@@ -21,14 +21,14 @@ module Datadog
     def self.log
       unless defined? @logger
         @logger = Logger.new(STDOUT)
-        @logger.level = Logger::INFO
+        @logger.level = Logger::WARN
       end
       @logger
     end
 
     # Activate the debug mode providing more information related to tracer usage
     def self.debug_logging=(value)
-      log.level = value ? Logger::DEBUG : Logger::INFO
+      log.level = value ? Logger::DEBUG : Logger::WARN
     end
 
     # Return if the debug mode is activated or not

data/lib/ddtrace/version.rb

@@ -2,7 +2,7 @@ module Datadog
   module VERSION
     MAJOR = 0
     MINOR = 4
-    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.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-24 00:00:00.000000000 Z
+date: 2017-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !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
   as they flow across web servers, databases and microservices so that developers
@@ -93,6 +107,7 @@ files:
 - ".env"
 - ".gitignore"
 - ".rubocop.yml"
+- ".yardopts"
 - Appraisals
 - Gemfile
 - LICENSE
@@ -101,7 +116,7 @@ files:
 - circle.yml
 - ddtrace.gemspec
 - docker-compose.yml
-- docs/GettingStarted
+- docs/index.rdoc
 - gemfiles/contrib.gemfile
 - gemfiles/rails3_mysql2.gemfile
 - gemfiles/rails3_postgres.gemfile