instana 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83702cf490019361b99d4c0096e4e12297a915e4
-  data.tar.gz: a7d1b3d505cc1466d1bf5bf784641bf07228f91c
+  metadata.gz: d305a85a9022580df0cb7f1a997ae3249761eeca
+  data.tar.gz: 4ced318153f068d2d78ad2b24b3f417bf4e38552
 SHA512:
-  metadata.gz: a3950247007e4aa9b70d08257e7b9fbb5ccf99e211f454415edd1a9140840745b11e81e045b3596c22383c3d3405a0d4594a2858419b44bed49d3114af7c0c11
-  data.tar.gz: cf9910fa2bfa9bfd5e80b24f64539fadb9d235b523f7f9bf4f6d81ba0daf10627b117d62d6c2502af8ee45e0b4d9064c2cd53af22335c9ceb9d2b0e9359259e5
+  metadata.gz: ceb52cced4e372faf89bd2fd8b0d98a05287da16518bb6532d39c2fa61877ad8d8d4e699d8c0ea5de6bf0c35b218c474ff0bfeab342deb79f316c7ebb9edc3ec
+  data.tar.gz: cd0c7cf3c526a3ae1e346db0ebf6b39fc9ff70b75dffc1f606b9fd8d213e783138e5711f7b482e414ee1f44c352463b5792859ae2c66a0376acccfc92b1fd631

data/.codeclimate.yml

@@ -15,6 +15,8 @@ engines:
     checks:
       Rubocop/Metrics/CyclomaticComplexity:
         enabled: false
+      Rubocop/Lint/RescueException:
+        enabled: false
 ratings:
   paths:
   - "**.inc"

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 .ruby-version
+gemfiles/*.lock

data/.travis.yml

@@ -3,10 +3,10 @@ language: ruby
 cache:
   bundler: true
   directories:
-  - vendor/bundle
+    - vendor/bundle
 
 rvm:
-  - 2.3.2
+  - 2.3.3
   - 2.2.6
   - 2.1.9
   - ruby-2.0.0-p648
@@ -17,11 +17,33 @@ before_install:
   - gem update bundler
   - gem --version
 
+before_script:
+  - psql -c 'create database travis_ci_test;' -U postgres
+
 script: "bundle exec rake test"
 
 services:
   - memcached
 
+gemfile:
+  - Gemfile
+  - gemfiles/libraries.gemfile
+  - gemfiles/rails50.gemfile
+  - gemfiles/rails42.gemfile
+  - gemfiles/rails32.gemfile
+
+matrix:
+  exclude:
+    # Rails 5.0+ requires Ruby 2.2.2 or higher
+    - rvm: 2.1.9
+      gemfile: gemfiles/rails50.gemfile
+    - rvm: ruby-2.0.0-p648
+      gemfile: gemfiles/rails50.gemfile
+    - rvm: ruby-2.0.0-p648
+      gemfile: gemfiles/rails42.gemfile
+    - rvm: ruby-2.0.0-p648
+      gemfile: gemfiles/rails32.gemfile
+
 notifications:
   slack:
     rooms:

data/Gemfile

@@ -5,30 +5,14 @@ group :development, :test do
   gem 'minitest', '5.9.1'
   gem 'minitest-reporters'
   gem 'minitest-debugger', :require => false
-  gem 'rack-test'
   gem 'webmock'
-
-  # Frameworks
-  gem "sinatra", '1.4.7'
-  gem "cuba"
-  gem "roda"
-
-  # HTTP Clients
-  gem 'rest-client'
-
-  # Webservers
-  gem "puma"
-
-  # HTTP Clients
-  gem 'excon'
-
-  # Memcache
-  gem 'dalli'
+  gem 'puma'
 
   # Rack v2 dropped support for Ruby 2.2 and higher.
   if RUBY_VERSION < '2.2'
     gem 'rack', '< 2.0'
   end
+  gem 'rack-test'
 end
 
 group :development do
@@ -43,9 +27,5 @@ group :development do
   end
 end
 
-gem 'get_process_mem'
-gem 'sys-proctable'
-gem 'timers'
-
 # instana.gemspec
 gemspec

data/README.md

@@ -50,7 +50,7 @@ Although the gem has no configuration required for out of the box metrics and tr
 
 ## Tracing
 
-See [Tracing.md](https://github.com/instana/ruby-sensor/blob/master/Tracing.md)
+This Ruby gem provides a simple API for tracing and also supports [OpenTracing](http://opentracing.io/).  See [Tracing.md](https://github.com/instana/ruby-sensor/blob/master/Tracing.md) for details.
 
 ## Documentation
 

data/Rakefile

@@ -9,6 +9,21 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList['test/**/*_test.rb']
+
+  case File.basename(ENV['BUNDLE_GEMFILE']).split('.').first
+  when /rails50/
+    t.test_files = FileList['test/frameworks/rails/activerecord5_test.rb'] + FileList['test/frameworks/rails/actioncontroller_test.rb']
+  when /rails42/
+    t.test_files = FileList['test/frameworks/rails/activerecord4_test.rb'] + FileList['test/frameworks/rails/actioncontroller_test.rb']
+  when /rails32/
+    t.test_files = FileList['test/frameworks/rails/activerecord3_test.rb'] + FileList['test/frameworks/rails/actioncontroller_test.rb']
+  when /libraries/
+    t.test_files = FileList['test/instrumentation/*_test.rb']
+  else
+    t.test_files = FileList['test/agent/*_test.rb'] +
+                   FileList['test/tracing/*_test.rb'] +
+                   FileList['test/profiling/*_test.rb']
+  end
 end
 
 task :environment do

data/Tracing.md

@@ -1,9 +1,36 @@
 # Tracing
 
 Tracing with Instana is automatic but if you want even more visibility into custom code or some in-house
-component, you can use the following API to report additional trace data to Instana.
+component, you can use Instana's tracing API or [OpenTracing](http://opentracing.io/).
 
-# The API
+# OpenTracing
+
+Existing applications that utilize the OpenTracing API or those who wish to add support should have no problem
+as the Instana Ruby gem fully supports the OpenTracing specification.
+
+To start, simply set the Instana tracer as the global tracer for OpenTracing:
+
+```Ruby
+require 'opentracing'
+OpenTracing.global_tracer = ::Instana.tracer
+```
+
+Then OpenTracing code can be run normally:
+
+```Ruby
+begin
+  span = OpenTracing.start_span('job')
+  # The code to be instrumented
+  @id = User.find_by_name('john.smith')
+  span.set_tag(:job_id, @id)
+rescue => e
+  span.set_tag(:error, e.message)
+ensure
+  span.finish
+end
+```
+
+# The Instana Ruby API
 
 The Instana Ruby gem provides a simple to use API to trace any arbitrary part of your application.
 

data/gemfiles/libraries.gemfile

@@ -0,0 +1,50 @@
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'rake'
+  gem 'minitest', '5.9.1'
+  gem 'minitest-reporters'
+  gem 'minitest-debugger', :require => false
+  gem 'rack-test'
+  gem 'webmock'
+  gem 'puma'
+end
+
+group :development do
+  gem 'ruby-debug',   :platforms => [:mri_18, :jruby]
+  gem 'debugger',     :platform  =>  :mri_19
+  gem 'byebug',       :platforms => [:mri_20, :mri_21, :mri_22, :mri_23]
+  if RUBY_VERSION > '1.8.7'
+    gem 'pry'
+    gem 'pry-byebug', :platforms => [:mri_20, :mri_21, :mri_22, :mri_23]
+  else
+    gem 'pry', '0.9.12.4'
+  end
+end
+
+# Frameworks
+gem "sinatra", '1.4.7'
+gem "cuba"
+gem "roda"
+
+# HTTP Clients
+gem 'rest-client'
+
+# Webservers
+gem "puma"
+
+# HTTP Clients
+gem 'excon'
+
+# Memcache
+gem 'dalli'
+
+# Rack v2 dropped support for Ruby 2.2 and higher.
+if RUBY_VERSION < '2.2'
+  gem 'rack', '< 2.0'
+end
+
+# Include the Instana Ruby gem's base set of gems
+gemspec :path => File.expand_path(File.dirname(__FILE__) + '/../')
+
+# vim:syntax=ruby

data/gemfiles/rails32.gemfile

@@ -0,0 +1,45 @@
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'rake'
+  gem 'minitest', '5.9.1'
+  gem 'minitest-reporters'
+  gem 'minitest-debugger', :require => false
+  gem 'rack-test'
+  gem 'webmock'
+  gem 'puma'
+end
+
+group :development do
+  gem 'ruby-debug',   :platforms => [:mri_18, :jruby]
+  gem 'debugger',     :platform  =>  :mri_19
+  gem 'byebug',       :platforms => [:mri_20, :mri_21, :mri_22, :mri_23]
+  if RUBY_VERSION > '1.8.7'
+    gem 'pry'
+    gem 'pry-byebug', :platforms => [:mri_20, :mri_21, :mri_22, :mri_23]
+  else
+    gem 'pry', '0.9.12.4'
+  end
+end
+
+gem 'rails', '3.2.22.5'
+gem 'pg'
+gem 'mysql2', '~> 0.3.10'
+gem 'mysql'
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.1'
+  gem 'therubyracer', :platforms => :ruby
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+
+# Include the Instana Ruby gem's base set of gems
+gemspec :path => File.expand_path(File.dirname(__FILE__) + '/../')
+
+# vim:syntax=ruby
+

data/gemfiles/rails42.gemfile

@@ -0,0 +1,44 @@
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'rake'
+  gem 'minitest', '5.9.1'
+  gem 'minitest-reporters'
+  gem 'minitest-debugger', :require => false
+  gem 'rack-test'
+  gem 'webmock'
+  gem 'puma'
+end
+
+group :development do
+  gem 'ruby-debug',   :platforms => [:mri_18, :jruby]
+  gem 'debugger',     :platform  =>  :mri_19
+  gem 'byebug',       :platforms => [:mri_20, :mri_21, :mri_22, :mri_23]
+  if RUBY_VERSION > '1.8.7'
+    gem 'pry'
+    gem 'pry-byebug', :platforms => [:mri_20, :mri_21, :mri_22, :mri_23]
+  else
+    gem 'pry', '0.9.12.4'
+  end
+end
+
+gem 'rails', '4.2.7.1'
+gem 'sqlite3'
+gem 'sass-rails', '~> 5.0'
+gem 'uglifier', '>= 1.3.0'
+gem 'coffee-rails', '~> 4.1.0'
+gem 'therubyracer', platforms: :ruby
+
+gem 'jquery-rails'
+gem 'turbolinks'
+gem 'jbuilder', '~> 2.0'
+gem 'sdoc', '~> 0.4.0', group: :doc
+gem "pg"
+gem "mysql2"
+gem "mysql"
+
+# Include the Instana Ruby gem's base set of gems
+gemspec :path => File.expand_path(File.dirname(__FILE__) + '/../')
+
+# vim:syntax=ruby
+

data/gemfiles/rails50.gemfile

@@ -0,0 +1,44 @@
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'rake'
+  gem 'minitest', '5.9.1'
+  gem 'minitest-reporters'
+  gem 'minitest-debugger', :require => false
+  gem 'rack-test'
+  gem 'webmock'
+  gem 'puma'
+end
+
+group :development do
+  gem 'ruby-debug',   :platforms => [:mri_18, :jruby]
+  gem 'debugger',     :platform  =>  :mri_19
+  gem 'byebug',       :platforms => [:mri_20, :mri_21, :mri_22, :mri_23]
+  if RUBY_VERSION > '1.8.7'
+    gem 'pry'
+    gem 'pry-byebug', :platforms => [:mri_20, :mri_21, :mri_22, :mri_23]
+  else
+    gem 'pry', '0.9.12.4'
+  end
+end
+
+gem 'rails', '~> 5.0.0', '>= 5.0.0.1'
+gem 'sass-rails', '~> 5.0'
+gem 'uglifier', '>= 1.3.0'
+gem 'coffee-rails', '~> 4.2'
+gem 'therubyracer', platforms: :ruby
+
+gem 'jquery-rails'
+gem 'turbolinks', '~> 5'
+gem 'jbuilder', '~> 2.5'
+
+gem 'pg'
+gem 'mysql2'
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+
+# Include the Instana Ruby gem's base set of gems
+gemspec :path => File.expand_path(File.dirname(__FILE__) + '/../')
+
+# vim:syntax=ruby

data/instana.gemspec

@@ -13,18 +13,11 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Provides Ruby sensor instrumentation for Instana.}
   spec.homepage      = "https://www.instana.com/"
 
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  # delete this section to allow pushing this gem to any host.
-  #if spec.respond_to?(:metadata)
-  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  #else
-  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  #end
-
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.test_files    = Dir.glob("{test}/**/*.rb")
 
   spec.required_ruby_version = '>= 2.0'
 
@@ -32,6 +25,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
 
+  # Development debugging
+  spec.add_development_dependency('byebug', '>= 8.0.0')
+  spec.add_development_dependency('pry', '>= 0.10.0')
+  spec.add_development_dependency('pry-byebug', '>= 3.0.0')
+
   spec.add_runtime_dependency('sys-proctable', '>= 1.1.3')
   spec.add_runtime_dependency('get_process_mem', '>= 0.2.1')
   spec.add_runtime_dependency('timers', '>= 4.1.0')

data/lib/instana/config.rb

@@ -20,11 +20,13 @@ module Instana
       @config[:eum_api_key] = nil
       @config[:eum_baggage] = {}
 
-      # HTTP Clients
-      @config[:dalli]         = { :enabled => true }
-      @config[:excon]         = { :enabled => true }
-      @config[:nethttp]       = { :enabled => true }
-      @config[:'rest-client'] = { :enabled => true }
+      # Instrumentation
+      @config[:action_controller]  = { :enabled => true }
+      @config[:active_record]      = { :enabled => true }
+      @config[:dalli]              = { :enabled => true }
+      @config[:excon]              = { :enabled => true }
+      @config[:nethttp]            = { :enabled => true }
+      @config[:'rest-client']      = { :enabled => true }
     end
 
     def [](key)

data/lib/instana/frameworks/instrumentation/abstract_mysql_adapter.rb

@@ -0,0 +1,55 @@
+module Instana
+  module Instrumentation
+    module AbstractMysqlAdapter
+      IGNORED_PAYLOADS = %w(SCHEMA EXPLAIN CACHE).freeze
+      EXPLAINED_SQLS = /\A\s*(with|select|update|delete|insert)\b/i
+
+      # This module supports instrumenting ActiveRecord with the mysql2 adapter.
+      #
+      def self.included(klass)
+        if ActiveRecord::VERSION::STRING >= '3.2'
+          Instana::Util.method_alias(klass, :execute)
+
+          @@sanitize_regexp = Regexp.new('(\'[\s\S][^\']*\'|\d*\.\d+|\d+|NULL)', Regexp::IGNORECASE)
+        end
+      end
+
+      # Collect up this DB connection info for reporting.
+      #
+      # @param sql [String]
+      # @return [Hash] Hash of collected KVs
+      #
+      def collect(sql)
+        payload = { :activerecord => {} }
+        payload[:activerecord][:sql] = sql.gsub(@@sanitize_regexp, '?')
+        payload[:activerecord][:adapter] = @config[:adapter]
+        payload[:activerecord][:host] = @config[:host]
+        payload[:activerecord][:db] = @config[:database]
+        payload[:activerecord][:username] = @config[:username]
+        payload
+      end
+
+      # In the spirit of ::ActiveRecord::ExplainSubscriber.ignore_payload?  There are
+      # only certain calls that we're interested in tracing.  e.g. No use to instrument
+      # framework caches.
+      #
+      # @param payload [String]
+      # @return [Boolean]
+      #
+      def ignore_payload?(name, sql)
+        IGNORED_PAYLOADS.include?(name) || sql !~ EXPLAINED_SQLS
+      end
+
+      def execute_with_instana(sql, name = nil)
+        if !::Instana.tracer.tracing? || ignore_payload?(name, sql)
+          return execute_without_instana(sql, name)
+        end
+
+        kv_payload = collect(sql)
+        ::Instana.tracer.trace(:activerecord, kv_payload) do
+          execute_without_instana(sql, name)
+        end
+      end
+    end
+  end
+end