appoptics_apm 4.0.2

data/test/servers/rails5x_api_8150.rb

@@ -0,0 +1,78 @@
+##
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+#  This is a Rails API stack that launches on a background
+#  thread and listens on port 8150.
+#
+if ENV['DBTYPE'] == 'mysql2'
+  AppOpticsAPM::Test.set_mysql2_env
+elsif ENV['DBTYPE'] == 'postgresql'
+  AppOpticsAPM::Test.set_postgresql_env
+else
+  AppOpticsAPM.logger.warn "Unidentified DBTYPE: #{ENV['DBTYPE']}" unless ENV['DBTYPE'] == "postgresql"
+  AppOpticsAPM.logger.debug "Defaulting to postgres DB for background Rails server."
+  AppOpticsAPM::Test.set_postgresql_env
+end
+
+require "rails"
+require "active_model/railtie"
+require "active_job/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "action_cable/engine"
+require "rails/test_unit/railtie"
+
+require 'rack/handler/puma'
+require File.expand_path(File.dirname(__FILE__) + '/../models/widget')
+
+AppOpticsAPM.logger.info "[appoptics_apm/info] Starting background utility rails app on localhost:8150."
+
+ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
+
+unless ActiveRecord::Base.connection.table_exists? 'widgets'
+  ActiveRecord::Migration.run(CreateWidgets)
+end
+
+module Rails50APIStack
+  class Application < Rails::Application
+    config.api_only = true
+
+    routes.append do
+      get "/monkey/hello" => "monkey#hello"
+      get "/monkey/error" => "monkey#error"
+    end
+
+    config.cache_classes = true
+    config.eager_load = false
+    config.active_support.deprecation = :stderr
+    config.middleware.delete Rack::Lock
+    config.middleware.delete ActionDispatch::Flash
+    config.secret_token = "48837489qkuweoiuoqwehisuakshdjksadhaisdy78o34y138974xyqp9rmye8yrpiokeuioqwzyoiuxftoyqiuxrhm3iou1hrzmjk"
+    config.secret_key_base = "2049671-96803948"
+  end
+end
+
+#################################################
+#  Controllers
+#################################################
+
+class MonkeyController < ActionController::API
+  def hello
+    render :plain => {:Response => "Hello API!"}.to_json, content_type: 'application/json'
+  end
+
+  def error
+    raise "Rails API fake error from controller"
+  end
+end
+
+Rails50APIStack::Application.initialize!
+
+Thread.new do
+  Rack::Handler::Puma.run(Rails50APIStack::Application.to_app, {:Host => '127.0.0.1', :Port => 8150})
+end
+
+sleep(2)

data/test/servers/sidekiq.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+# We configure and launch Sidekiq in a background
+# thread here.
+#
+require 'sidekiq/cli'
+
+AppOpticsAPM.logger.info "[appoptics_apm/servers] Starting up background Sidekiq."
+
+options = []
+arguments = ""
+options << ["-r", Dir.pwd + "/test/servers/sidekiq_initializer.rb"]
+options << ["-q", "critical,20", "-q", "default"]
+options << ["-c", "10"]
+options << ["-P", "/tmp/sidekiq_#{Process.pid}.pid"]
+
+options.flatten.each do |x|
+  arguments += " #{x}"
+end
+
+AppOpticsAPM.logger.debug "[appoptics_apm/servers] sidekiq #{arguments}"
+
+Thread.new do
+  system("OBOE_GEM_TEST=true sidekiq #{arguments}")
+end
+
+# Allow Sidekiq to boot up
+sleep 10

data/test/servers/sidekiq.yml

@@ -0,0 +1,7 @@
+---
+:concurrency: 2
+:pidfile: tmp/pids/sidekiq.pid
+:queues:
+  - default
+  - [critical, 2]
+  - [low, 1]

data/test/servers/sidekiq_initializer.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+# This file is used to initialize the background Sidekiq
+# process launched in our test suite.
+#
+ENV['BUNDLE_GEMFILE'] = Dir.pwd + "/gemfiles/libraries.gemfile"
+
+require 'rubygems'
+require 'bundler/setup'
+require_relative '../jobs/sidekiq/db_worker_job'
+require_relative '../jobs/sidekiq/remote_call_worker_job'
+require_relative '../jobs/sidekiq/error_worker_job'
+
+ENV["RACK_ENV"] = "test"
+ENV["APPOPTICS_GEM_TEST"] = "true"
+ENV["APPOPTICS_GEM_VERBOSE"] = "true"
+
+Bundler.require(:default, :test)
+
+# Configure AppOpticsAPM
+AppOpticsAPM::Config[:tracing_mode] = "always"
+AppOpticsAPM::Config[:sample_rate] = 1000000
+AppOpticsAPM.logger.level = Logger::DEBUG
+

data/test/support/auto_tracing_test.rb

@@ -0,0 +1,50 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+
+class AutoTraceTest  < Minitest::Test
+  def setup
+    @tm = AppOpticsAPM::Config[:tracing_mode]
+  end
+
+  def teardown
+    AppOpticsAPM::Config[:tracing_mode] = @tm
+  end
+
+  def test_trace_when_default_tm_dj
+    AppOpticsAPM::API.start_trace('delayed_job-worker') do
+      AppOpticsAPM.tracing?.must_equal true
+    end
+  end
+
+  def test_trace_when_default_tm_sidekiq
+    AppOpticsAPM::API.start_trace('sidekiq-worker') do
+      AppOpticsAPM.tracing?.must_equal true
+    end
+  end
+
+  def test_trace_when_default_tm_resque
+    AppOpticsAPM::API.start_trace('resque-worker') do
+      AppOpticsAPM.tracing?.must_equal true
+    end
+  end
+
+  def test_trace_when_default_tm_rabbitmq
+    AppOpticsAPM::API.start_trace('rabbitmq-consumer') do
+      AppOpticsAPM.tracing?.must_equal true
+    end
+  end
+
+  def test_dont_trace_when_never
+    AppOpticsAPM::Config[:tracing_mode] = :never
+
+    AppOpticsAPM::API.start_trace('delayed_job-worker') do
+      AppOpticsAPM.tracing?.must_equal false
+    end
+
+    AppOpticsAPM::API.start_trace('asdf') do
+      AppOpticsAPM.tracing?.must_equal false
+    end
+  end
+end

data/test/support/backcompat_test.rb

@@ -0,0 +1,276 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+
+describe "BackwardCompatibility" do
+
+  it 'should still export to Oboe::Ruby' do
+    defined?(::Oboe::Ruby).must_equal "constant"
+  end
+
+  it 'should still respond to Oboe::Config' do
+    @verbose = Oboe::Config[:verbose]
+    @dalli_enabled = Oboe::Config[:dalli][:enabled]
+    @tm = Oboe::Config[:tracing_mode]
+    @sr = Oboe::Config[:sample_rate]
+
+    Oboe::Config[:verbose] = true
+    Oboe::Config[:verbose].must_equal true
+    Oboe::Config.verbose.must_equal true
+    AppOpticsAPM::Config[:verbose].must_equal true
+    AppOpticsAPM::Config.verbose.must_equal true
+
+    Oboe::Config[:dalli][:enabled] = false
+    Oboe::Config[:dalli][:enabled].must_equal false
+    AppOpticsAPM::Config[:dalli][:enabled].must_equal false
+
+    Oboe::Config[:sample_rate] = 8e5
+    Oboe::Config.sample_rate.must_equal 8e5
+    AppOpticsAPM::Config.sample_rate.must_equal 8e5
+
+    Oboe::Config[:tracing_mode] = 'always'
+    Oboe::Config.tracing_mode.must_equal :always
+    AppOpticsAPM::Config.tracing_mode.must_equal :always
+
+    Oboe::Config[:sample_rate] = @sr
+    Oboe::Config[:tracing_mode] = @tm
+    Oboe::Config[:dalli][:enabled] = @dalli_enabled
+    Oboe::Config[:verbose] = @verbose
+  end
+
+  it 'should still support Oboe::API.log calls' do
+    clear_all_traces
+
+    Oboe::API.log_start('rack', nil, {})
+    Oboe::API.log_end('rack')
+
+    traces = get_all_traces
+    traces.count.must_equal 2
+  end
+
+  it 'should still support Oboe::API.trace calls' do
+    clear_all_traces
+
+    Oboe::API.start_trace('api_test', '', {}) do
+      sleep 1
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 2
+
+    validate_outer_layers(traces, 'api_test')
+  end
+
+  it 'should still support Oboe::API.profile'do
+    clear_all_traces
+
+    Oboe::API.start_trace('outer_profile_test') do
+      Oboe::API.profile('profile_test', {}, false) do
+        sleep 1
+      end
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+  end
+
+  # Pasted in from test/profiling/method_test.rb
+  # Modified to use OboeMethodProfiling
+  describe "OboeMethodProfiling" do
+    before do
+      clear_all_traces
+      # Conditionally Undefine TestWorker
+      # http://stackoverflow.com/questions/11503558/how-to-undefine-class-in-ruby
+      Object.send(:remove_const, :TestWorker) if defined?(TestWorker)
+    end
+
+    it 'should be loaded, defined and ready' do
+      defined?(::OboeMethodProfiling).wont_match nil
+    end
+
+    it 'should trace Class methods' do
+      class TestWorker
+        def self.do_work
+          sleep 1
+        end
+
+        class << self
+          include OboeMethodProfiling
+          profile_method :do_work, 'do_work'
+        end
+      end
+
+      ::Oboe::API.start_trace('method_profiling', '', {}) do
+        # Call the profiled class method
+        TestWorker.do_work
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+
+      validate_outer_layers(traces, 'method_profiling')
+
+      kvs = {}
+      kvs["Label"] = 'profile_entry'
+      kvs["Language"] = "ruby"
+      kvs["ProfileName"] = "do_work"
+      kvs["FunctionName"] = "do_work"
+      kvs["Class"] = "TestWorker"
+
+      validate_event_keys(traces[1], kvs)
+
+      traces[1].has_key?("Layer").must_equal false
+      traces[1].has_key?("File").must_equal true
+      traces[1].has_key?("LineNumber").must_equal true
+
+      kvs.clear
+      kvs["Label"] = "profile_exit"
+      kvs["Language"] = "ruby"
+      kvs["ProfileName"] = "do_work"
+
+      validate_event_keys(traces[2], kvs)
+      traces[2].has_key?("Layer").must_equal false
+    end
+
+    it 'should trace Instance methods' do
+      class TestWorker
+        def do_work
+          sleep 1
+        end
+
+        include OboeMethodProfiling
+        profile_method :do_work, 'do_work'
+      end
+
+      ::Oboe::API.start_trace('method_profiling', '', {}) do
+        # Call the profiled class method
+        tw = TestWorker.new
+        tw.do_work
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+
+      validate_outer_layers(traces, 'method_profiling')
+
+      kvs = {}
+      kvs["Label"] = 'profile_entry'
+      kvs["Language"] = "ruby"
+      kvs["ProfileName"] = "do_work"
+      kvs["FunctionName"] = "do_work"
+      kvs["Class"] = "TestWorker"
+
+      validate_event_keys(traces[1], kvs)
+
+      traces[1].has_key?("Layer").must_equal false
+      traces[1].has_key?("File").must_equal true
+      traces[1].has_key?("LineNumber").must_equal true
+
+      kvs.clear
+      kvs["Label"] = "profile_exit"
+      kvs["Language"] = "ruby"
+      kvs["ProfileName"] = "do_work"
+
+      validate_event_keys(traces[2], kvs)
+      traces[2].has_key?("Layer").must_equal false
+    end
+
+    it 'should trace Module class methods' do
+      module TestWorker
+        def self.do_work
+          sleep 1
+        end
+
+        class << self
+          include OboeMethodProfiling
+          profile_method :do_work, 'do_work'
+        end
+      end
+
+      ::Oboe::API.start_trace('method_profiling', '', {}) do
+        # Call the profiled class method
+        TestWorker.do_work
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+      validate_outer_layers(traces, 'method_profiling')
+
+      kvs = {}
+      kvs["Label"] = 'profile_entry'
+      kvs["Language"] = "ruby"
+      kvs["ProfileName"] = "do_work"
+      kvs["FunctionName"] = "do_work"
+      kvs["Module"] = "TestWorker"
+
+      validate_event_keys(traces[1], kvs)
+
+      traces[1].has_key?("Layer").must_equal false
+      traces[1].has_key?("File").must_equal true
+      traces[1].has_key?("LineNumber").must_equal true
+
+      kvs.clear
+      kvs["Label"] = "profile_exit"
+      kvs["Language"] = "ruby"
+      kvs["ProfileName"] = "do_work"
+
+      validate_event_keys(traces[2], kvs)
+      traces[2].has_key?("Layer").must_equal false
+    end
+
+    it 'should not store arguments and return value by default' do
+      class TestWorker
+        def self.do_work(_s, _i, _a, _h)
+          sleep 1
+          return "the zebra is loose"
+        end
+
+        class << self
+          include OboeMethodProfiling
+          # Default call method
+          profile_method :do_work, 'do_work'
+        end
+      end
+
+      ::Oboe::API.start_trace('method_profiling', '', {}) do
+        # Call the profiled class method
+        TestWorker.do_work('String Argument', 203984, ["1", "2", 3], { :color => :black })
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+
+      traces[1].has_key?("Args").must_equal false
+      traces[2].has_key?("ReturnValue").must_equal false
+    end
+
+    it 'should store arguments and return value when asked' do
+      class TestWorker
+        def self.do_work(_s, _i, _a, _h)
+          sleep 1
+          return "the zebra is loose"
+        end
+
+        class << self
+          include OboeMethodProfiling
+          profile_method :do_work, 'do_work', true, true
+        end
+      end
+
+      ::Oboe::API.start_trace('method_profiling', '', {}) do
+        # Call the profiled class method
+        TestWorker.do_work('String Argument', 203984, ["1", "2", 3], { :color => :black })
+      end
+
+      traces = get_all_traces
+      traces.count.must_equal 4
+
+      traces[1].has_key?("Args").must_equal true
+      traces[1]["Args"].must_equal "\"String Argument\"\n203984\n[\"1\", \"2\", 3]\n{:color=>:black}\n"
+
+      traces[2].has_key?("ReturnValue").must_equal true
+      traces[2]["ReturnValue"].must_equal "\"the zebra is loose\"\n"
+    end
+  end
+end

data/test/support/config_test.rb

@@ -0,0 +1,149 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+
+describe "AppOpticsAPM::Config" do
+  after do
+    # Set back to always trace mode
+    AppOpticsAPM::Config[:tracing_mode] = "always"
+    AppOpticsAPM::Config[:sample_rate] = 1000000
+  end
+
+  it 'should have the correct default values' do
+    # Reset AppOpticsAPM::Config to defaults
+    AppOpticsAPM::Config.initialize
+
+    # FIXME: We set the APPOPTICS_GEM_VERBOSE env for the
+    # ____   test suite so this assertion is not going to fly
+    #
+    # AppOpticsAPM::Config[:verbose].must_equal false
+
+    # TODO: Is there anything we should test here?
+  end
+
+  it 'should have the correct instrumentation defaults' do
+    # Reset AppOpticsAPM::Config to defaults
+    AppOpticsAPM::Config.initialize
+
+    instrumentation = AppOpticsAPM::Config.instrumentation
+
+    # Verify the number of individual instrumentations
+    instrumentation.count.must_equal 30
+
+    AppOpticsAPM::Config[:action_controller][:enabled].must_equal true
+    AppOpticsAPM::Config[:action_controller_api][:enabled].must_equal true
+    AppOpticsAPM::Config[:action_view][:enabled].must_equal true
+    AppOpticsAPM::Config[:active_record][:enabled].must_equal true
+    AppOpticsAPM::Config[:bunnyclient][:enabled].must_equal true
+    AppOpticsAPM::Config[:bunnyconsumer][:enabled].must_equal true
+    AppOpticsAPM::Config[:cassandra][:enabled].must_equal true
+    AppOpticsAPM::Config[:curb][:enabled].must_equal true
+    AppOpticsAPM::Config[:dalli][:enabled].must_equal true
+    AppOpticsAPM::Config[:delayed_jobclient][:enabled].must_equal true
+    AppOpticsAPM::Config[:delayed_jobworker][:enabled].must_equal true
+    AppOpticsAPM::Config[:em_http_request][:enabled].must_equal false
+    AppOpticsAPM::Config[:excon][:enabled].must_equal true
+    AppOpticsAPM::Config[:faraday][:enabled].must_equal true
+    AppOpticsAPM::Config[:grape][:enabled].must_equal true
+    AppOpticsAPM::Config[:httpclient][:enabled].must_equal true
+    AppOpticsAPM::Config[:nethttp][:enabled].must_equal true
+    AppOpticsAPM::Config[:memcached][:enabled].must_equal true
+    AppOpticsAPM::Config[:memcache][:enabled].must_equal true
+    AppOpticsAPM::Config[:mongo][:enabled].must_equal true
+    AppOpticsAPM::Config[:moped][:enabled].must_equal true
+    AppOpticsAPM::Config[:rack][:enabled].must_equal true
+    AppOpticsAPM::Config[:redis][:enabled].must_equal true
+    AppOpticsAPM::Config[:resqueclient][:enabled].must_equal true
+    AppOpticsAPM::Config[:resqueworker][:enabled].must_equal true
+    AppOpticsAPM::Config[:rest_client][:enabled].must_equal true
+    AppOpticsAPM::Config[:sequel][:enabled].must_equal true
+    AppOpticsAPM::Config[:sidekiqclient][:enabled].must_equal true
+    AppOpticsAPM::Config[:sidekiqworker][:enabled].must_equal true
+    AppOpticsAPM::Config[:typhoeus][:enabled].must_equal true
+
+    AppOpticsAPM::Config[:action_controller][:log_args].must_equal true
+    AppOpticsAPM::Config[:action_controller_api][:log_args].must_equal true
+    AppOpticsAPM::Config[:action_view][:log_args].must_equal true
+    AppOpticsAPM::Config[:active_record][:log_args].must_equal true
+    AppOpticsAPM::Config[:bunnyclient][:log_args].must_equal true
+    AppOpticsAPM::Config[:bunnyconsumer][:log_args].must_equal true
+    AppOpticsAPM::Config[:cassandra][:log_args].must_equal true
+    AppOpticsAPM::Config[:curb][:log_args].must_equal true
+    AppOpticsAPM::Config[:dalli][:log_args].must_equal true
+    AppOpticsAPM::Config[:delayed_jobclient][:log_args].must_equal true
+    AppOpticsAPM::Config[:delayed_jobworker][:log_args].must_equal true
+    AppOpticsAPM::Config[:em_http_request][:log_args].must_equal true
+    AppOpticsAPM::Config[:excon][:log_args].must_equal true
+    AppOpticsAPM::Config[:faraday][:log_args].must_equal true
+    AppOpticsAPM::Config[:grape][:log_args].must_equal true
+    AppOpticsAPM::Config[:httpclient][:log_args].must_equal true
+    AppOpticsAPM::Config[:nethttp][:log_args].must_equal true
+    AppOpticsAPM::Config[:memcached][:log_args].must_equal true
+    AppOpticsAPM::Config[:memcache][:log_args].must_equal true
+    AppOpticsAPM::Config[:mongo][:log_args].must_equal true
+    AppOpticsAPM::Config[:moped][:log_args].must_equal true
+    AppOpticsAPM::Config[:rack][:log_args].must_equal true
+    AppOpticsAPM::Config[:redis][:log_args].must_equal true
+    AppOpticsAPM::Config[:resqueclient][:log_args].must_equal true
+    AppOpticsAPM::Config[:resqueworker][:log_args].must_equal true
+    AppOpticsAPM::Config[:rest_client][:log_args].must_equal true
+    AppOpticsAPM::Config[:sequel][:log_args].must_equal true
+    AppOpticsAPM::Config[:sidekiqclient][:log_args].must_equal true
+    AppOpticsAPM::Config[:sidekiqworker][:log_args].must_equal true
+    AppOpticsAPM::Config[:typhoeus][:log_args].must_equal true
+
+    AppOpticsAPM::Config[:blacklist].is_a?(Array).must_equal true
+
+    AppOpticsAPM::Config[:dnt_regexp].must_equal '\.(jpg|jpeg|gif|png|ico|css|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|js|flv|swf|otf|eot|ttf|woff|woff2|svg|less)(\?.+){0,1}$'
+    AppOpticsAPM::Config[:dnt_opts].must_equal Regexp::IGNORECASE
+
+    AppOpticsAPM::Config[:sanitize_sql].must_equal true
+  end
+
+  def test_should_obey_globals
+    # Reset AppOpticsAPM::Config to defaults
+    AppOpticsAPM::Config.initialize
+
+    http_clients = AppOpticsAPM::Config.http_clients
+
+    # Restore these at the end
+    @url_query_params  = AppOpticsAPM::Config[:include_url_query_params]
+    @remote_url_params = AppOpticsAPM::Config[:include_remote_url_params]
+
+    # After setting global options, the per instrumentation
+    # equivalents should follow suit.
+
+    #
+    # :include_remote_url_params
+    #
+
+    # Check defaults
+    AppOpticsAPM::Config[:include_remote_url_params].must_equal true
+    http_clients.each do |i|
+      AppOpticsAPM::Config[i][:log_args].must_equal true
+    end
+
+    # Check obedience
+    AppOpticsAPM::Config[:include_remote_url_params] = false
+    http_clients.each do |i|
+      AppOpticsAPM::Config[i][:log_args].must_equal false
+    end
+
+    #
+    # :include_url_query_params
+    #
+
+    # Check default
+    AppOpticsAPM::Config[:include_url_query_params].must_equal true
+    AppOpticsAPM::Config[:rack][:log_args].must_equal true
+
+    # Check obedience
+    AppOpticsAPM::Config[:include_url_query_params] = false
+    AppOpticsAPM::Config[:rack][:log_args].must_equal false
+
+    # Restore the previous values
+    AppOpticsAPM::Config[:include_url_query_params] = @url_query_params
+    AppOpticsAPM::Config[:include_remote_url_params] = @remote_url_params
+  end
+end