ddtrace 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a9186d275327ce22e549c851bfa05a3d35f2331
+  data.tar.gz: 80ddf28da3679f110f6c2b570ca2d7356ada9ce2
+SHA512:
+  metadata.gz: e754f087c383bb50d2c4738fceee184b8766d5c880a2980005b0fee2ae36f301c843a0b88d873bc5e571f951e14c49a9de9b3598f708467b34b99e923b023202
+  data.tar.gz: 679c519b49988a592bb4c9ac434384fc2bea7d5ba7dc710596e097fa814a1064d6de1565748c966f7d715f3f3d319070ba0c5b330510555c6111a70024df5e86

data/.env

@@ -0,0 +1,11 @@
+TEST_POSTGRES_PORT=55432
+TEST_POSTGRES_USER=postgres
+TEST_POSTGRES_PASSWORD=postgres
+TEST_POSTGRES_DB=postgres
+TEST_MYSQL_PORT=53306
+TEST_MYSQL_ROOT_PASSWORD=root
+TEST_MYSQL_PASSWORD=mysql
+TEST_MYSQL_USER=mysql
+TEST_ELASTICSEARCH_REST_PORT=49200
+TEST_ELASTICSEARCH_NATIVE_PORT=49300
+TEST_REDIS_PORT=46379

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/log/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+/html/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# lock files
+Gemfile.lock
+gemfiles/*.lock

data/.rubocop.yml

@@ -0,0 +1,43 @@
+AllCops:
+  TargetRubyVersion: 2.1
+
+# 80 characters is a nice goal, but not worth currently changing in existing
+# code for the sake of changing it to conform to a length set in 1928 (IBM).
+Metrics/LineLength:
+  Max: 124
+
+# These exceptions are good goals to attain, and probably will over time,
+# so periodic disabling and re-running to inspect values is suggested.
+
+Metrics/AbcSize:
+  Max: 50
+
+# TODO: As refactors continue, this should drop. However, the goal of
+# 10 lines in a method may be a little lofty.
+Metrics/MethodLength:
+  Max: 36
+
+# TODO: this is not compliant with the Ruby community style guide. We
+# should enable again this rule but it will change the public API because
+# we're using set_ methods. We should work on that because also Rails
+# honors this rule.
+Style/AccessorMethodName:
+  Enabled: false
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Max: 42
+
+Metrics/ParameterLists:
+  Enabled: false

data/Appraisals

@@ -0,0 +1,65 @@
+appraise "rails3-postgres" do
+  gem "test-unit"
+  gem "rails", "3.2.22.5"
+  gem "pg", platform: :ruby
+  gem 'activerecord-jdbcpostgresql-adapter', platform: :jruby
+end
+
+appraise "rails4-postgres" do
+  gem "rails", "4.2.7.1"
+  gem "pg", platform: :ruby
+  gem 'activerecord-jdbcpostgresql-adapter', platform: :jruby
+end
+
+appraise "rails3-mysql2" do
+  gem "test-unit"
+  gem "rails", "3.2.22.5"
+  gem "mysql2", "0.3.21", platform: :ruby
+  gem "activerecord-mysql-adapter", platform: :ruby
+  gem 'activerecord-jdbcmysql-adapter', platform: :jruby
+end
+
+appraise "rails4-mysql2" do
+  gem "rails", "4.2.7.1"
+  gem "mysql2", platform: :ruby
+  gem 'activerecord-jdbcmysql-adapter', platform: :jruby
+end
+
+appraise "rails3-postgres-redis" do
+  gem "test-unit"
+  gem "rails", "3.2.22.5"
+  gem "pg", platform: :ruby
+  gem 'activerecord-jdbcpostgresql-adapter', platform: :jruby
+  gem "redis-rails"
+end
+
+appraise "rails4-postgres-redis" do
+  gem "rails", "4.2.7.1"
+  gem "pg", platform: :ruby
+  gem 'activerecord-jdbcpostgresql-adapter', platform: :jruby
+  gem "redis-rails"
+end
+
+if RUBY_VERSION >= "2.2.2" && RUBY_PLATFORM != "java"
+  appraise "rails5-postgres" do
+    gem "rails", "5.0.0.1"
+    gem "pg", platform: :ruby
+  end
+
+  appraise "rails5-mysql2" do
+    gem "rails", "5.0.0.1"
+    gem "mysql2", platform: :ruby
+  end
+
+  appraise "rails5-postgres-redis" do
+    gem "rails", "5.0.0.1"
+    gem "pg", platform: :ruby
+    gem "redis-rails"
+  end
+end
+
+appraise "contrib" do
+  gem "elasticsearch-transport"
+  gem "redis"
+  gem "hiredis"
+end

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2016, Datadog <info@datadoghq.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of Datadog nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,119 @@
+# dd-trace-rb
+
+[![CircleCI](https://circleci.com/gh/DataDog/dd-trace-rb/tree/master.svg?style=svg&circle-token=b0bd5ef866ec7f7b018f48731bb495f2d1372cc1)](https://circleci.com/gh/DataDog/dd-trace-rb/tree/master)
+
+## Documentation
+
+You can find the latest documentation in the Datadog's [private repository][docs]
+
+[docs]: http://gems.datadoghq.com/trace/docs/
+
+## Getting started
+
+### Install
+
+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/'
+```
+
+### Quickstart (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:
+
+```ruby
+    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
+```
+
+### Monkey patching
+
+By default, our monkey-patching is not active, you need to
+explicitly activate it by calling `Datadog::Monkey.patch_all` 
+or `Datadog::Monkey.patch_module`
+
+This ultimately allows you to enable or disable tracing on a per-library basis.
+
+The example below shows the Redis case, but any other non-rails library
+should work the same way:
+
+```ruby
+
+    require 'redis'
+    require 'ddtrace'
+
+    Datadog::Monkey.patch_all # you need to explicitly patch it
+
+    # now do your Redis stuff, eg:
+    redis = Redis.new
+    redis.set 'foo', 'bar' # traced!
+```
+
+## Development
+
+### Testing
+
+Configure your environment through:
+
+    $ bundle install
+    $ appraisal install
+
+You can launch all tests using the following rake command:
+
+    $ rake test                                     # tracer tests
+    $ appraisal rails<version>-<database>rake rails # tests Rails matrix
+    $ appraisal contrib rake contrib                # tests other contrib libraries (Redis, ...)
+    $ appraisal contrib rake monkey                 # tests monkey patching
+
+Available appraisals are:
+
+* ``rails{3,4,5}-postgres``: Rails with PostgreSQL
+* ``rails{3,4,5}-mysql2``: Rails with MySQL
+* ``contrib``: Other contrib libraries (Redis, ...)
+
+jRuby includes only Rails 3.x and 4.x because the current implementation of jdbc drivers, don't support
+ActiveRecord 5.x.
+
+The test suite requires many backing services (PostgreSQL, MySQL, Redis, ...) and we're using
+``docker`` and ``docker-compose`` to start these services in the CI.
+To launch properly the test matrix, please [install docker][2] and [docker-compose][3] using
+the instructions provided by your platform. Then launch them through:
+
+    $ docker-compose up -d
+
+We also enforce the Ruby [community-driven style guide][1] through Rubocop. Simply launch:
+
+    $ rake rubocop
+
+[1]: https://github.com/bbatsov/ruby-style-guide
+[2]: https://www.docker.com/products/docker
+[3]: https://www.docker.com/products/docker-compose

data/Rakefile

@@ -0,0 +1,103 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'appraisal'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << %w(test lib)
+  t.test_files = FileList['test/**/*_test.rb'].reject do |path|
+    path.include?('contrib') ||
+      path.include?('benchmark') ||
+      path.include?('redis') ||
+      path.include?('monkey_test.rb')
+  end
+end
+
+Rake::TestTask.new(:rails) do |t|
+  t.libs << %w(test lib)
+  t.test_files = FileList['test/contrib/rails/**/*_test.rb'].reject do |path|
+    path.include?('redis')
+  end
+end
+
+Rake::TestTask.new(:railsredis) do |t|
+  t.libs << %w(test lib)
+  t.test_files = FileList['test/contrib/rails/**/*redis*_test.rb']
+end
+
+Rake::TestTask.new(:contrib) do |t|
+  t.libs << %w(test lib)
+  t.test_files = FileList['test/contrib/**/*_test.rb'].reject do |path|
+    path.include?('rails') ||
+      path.include?('monkey_test.rb')
+  end
+end
+
+Rake::TestTask.new(:monkey) do |t|
+  t.libs << %w(test lib)
+  t.test_files = FileList['test/monkey_test.rb']
+end
+
+Rake::TestTask.new(:benchmark) do |t|
+  t.libs << %w(test lib)
+  t.test_files = FileList['test/benchmark_test.rb']
+end
+
+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'
+end
+
+# Deploy tasks
+S3_BUCKET = 'gems.datadoghq.com'.freeze
+S3_DIR = ENV['S3_DIR']
+
+desc 'create a new indexed repository'
+task :'release:gem' do
+  raise 'Missing environment variable S3_DIR' if !S3_DIR || S3_DIR.empty?
+  # load existing deployed gems
+  sh "aws s3 cp --exclude 'docs/*' --recursive s3://#{S3_BUCKET}/#{S3_DIR}/ ./rubygems/"
+
+  # create folders
+  sh 'mkdir -p ./gems'
+  sh 'mkdir -p ./rubygems/gems/'
+  sh 'mkdir -p ./rubygems/quick/'
+
+  # copy previous builds
+  sh 'cp ./rubygems/gems/* ./gems/'
+
+  # build the gem
+  Rake::Task['build'].execute
+
+  # copy the output in the indexed folder
+  sh 'cp pkg/*.gem ./gems/'
+
+  # generate the gems index
+  sh 'gem generate_index'
+
+  # namespace everything under ./rubygems/
+  sh 'cp -r ./gems/* ./rubygems/gems/'
+  sh 'cp -r specs.* ./rubygems/'
+  sh 'cp -r latest_specs.* ./rubygems/'
+  sh 'cp -r prerelease_specs.* ./rubygems/'
+  sh 'cp -r ./quick/* ./rubygems/quick/'
+
+  # deploy a static gem registry
+  sh "aws s3 cp --recursive ./rubygems/ s3://#{S3_BUCKET}/#{S3_DIR}/"
+end
+
+desc 'release the docs website'
+task :'release:docs' => :rdoc 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/"
+end
+
+task default: :test

data/circle.yml

@@ -0,0 +1,68 @@
+machine:
+  services:
+    - docker
+  environment:
+    MRI_VERSIONS: 2.3.1,2.2.5,2.1.10
+    RAILS5_VERSIONS: 2.3.1,2.2.5
+    JRUBY_VERSIONS: jruby-9.1.5.0
+    JRUBY_OPTS: --dev
+    AGENT_BUILD_PATH: "/home/ubuntu/agent"
+    TEST_DATADOG_INTEGRATION: 1
+
+dependencies:
+  cache_directories:
+    # Cache Ruby binaries and gems
+    - "/opt/circleci/.rvm/"
+  pre:
+    # we should use an old docker-compose because CircleCI supports
+    # only docker-engine==1.9
+    - pip install docker-compose==1.7.1
+    - docker-compose up -d | cat
+    # configure Ruby interpreters
+    - gem install builder
+    - bundle install
+    - rvm get head
+    - rvm install $MRI_VERSIONS
+    - rvm install $JRUBY_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
+  override:
+    - rvm $MRI_VERSIONS,$JRUBY_VERSIONS --verbose do gem install bundler
+    - rvm $MRI_VERSIONS,$JRUBY_VERSIONS --verbose do bundle install
+    - rvm $MRI_VERSIONS,$JRUBY_VERSIONS --verbose do appraisal install
+
+test:
+  override:
+    - rvm 2.1.10 --verbose do rake rubocop
+    - rvm $MRI_VERSIONS,$JRUBY_VERSIONS --verbose do rake test
+    - rvm $MRI_VERSIONS,$JRUBY_VERSIONS --verbose do appraisal rails3-postgres rake rails
+    - rvm $MRI_VERSIONS,$JRUBY_VERSIONS --verbose do appraisal rails3-mysql2 rake rails
+    - rvm $MRI_VERSIONS,$JRUBY_VERSIONS --verbose do appraisal rails4-postgres rake rails
+    - rvm $MRI_VERSIONS,$JRUBY_VERSIONS --verbose do appraisal rails4-mysql2 rake rails
+    - rvm $RAILS5_VERSIONS --verbose do appraisal rails5-postgres rake rails
+    - rvm $RAILS5_VERSIONS --verbose do appraisal rails5-mysql2 rake rails
+    - rvm $MRI_VERSIONS,$JRUBY_VERSIONS --verbose do appraisal rails3-postgres-redis rake railsredis
+    - rvm $MRI_VERSIONS,$JRUBY_VERSIONS --verbose do appraisal rails4-postgres-redis rake railsredis
+    - rvm $RAILS5_VERSIONS --verbose do appraisal rails5-postgres-redis rake railsredis
+    - rvm $MRI_VERSIONS,$JRUBY_VERSIONS --verbose do appraisal contrib rake contrib
+    - rvm $MRI_VERSIONS,$JRUBY_VERSIONS --verbose do appraisal contrib rake monkey
+    - rvm 2.3.1 --verbose do rake benchmark
+    - rvm jruby-9.1.5.0 --verbose do rake benchmark
+
+deployment:
+  develop:
+    branch: /(master)|(develop)/
+    # CircleCI is configured to provide VERSION_SUFFIX=$CIRCLE_BUILD_NUM
+    commands:
+      - S3_DIR=trace-dev rake release:docs
+      - S3_DIR=trace-dev rake release:gem
+      - cp -r ./rubygems/* $CIRCLE_ARTIFACTS
+  public:
+    tag: /v[0-9]+(\.[0-9]+)*/
+    commands:
+      - S3_DIR=trace rake release:docs
+      - S3_DIR=trace VERSION_SUFFIX= rake release:gem
+      - cp -r ./rubygems/* $CIRCLE_ARTIFACTS