appoptics_apm 4.0.2

data/test/queues/delayed_job-client_test.rb

@@ -0,0 +1,95 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+require_relative "../jobs/delayed_job/remote_call_worker_job"
+require_relative "../jobs/delayed_job/db_worker_job"
+require_relative "../jobs/delayed_job/error_worker_job"
+require_relative '../models/widget'
+
+# Delete all pre-existing jobs before we start
+Delayed::Job.delete_all
+
+class DelayedJobClientTest < Minitest::Test
+  def setup
+    clear_all_traces
+    @collect_backtraces = AppOpticsAPM::Config[:delayed_jobclient][:collect_backtraces]
+    @log_args = AppOpticsAPM::Config[:delayed_jobclient][:log_args]
+  end
+
+  def teardown
+    AppOpticsAPM::Config[:delayed_jobclient][:collect_backtraces] = @collect_backtraces
+    AppOpticsAPM::Config[:delayed_jobclient][:log_args] = @log_args
+  end
+
+  def test_delay
+    w = Widget.new(:name => 'blah', :description => 'This is a wonderful widget.')
+    w.save
+
+    AppOpticsAPM::API.start_trace('dj_delay') do
+      w.delay.do_work(1, 2, 3)
+    end
+
+    sleep 15
+
+    traces = get_all_traces
+    assert valid_edges?(traces), "Invalid edge in traces"
+
+    assert_equal 'dj_delay',              traces[0]['Layer']
+    assert_equal 'entry',                 traces[0]['Label']
+    assert_equal 'delayed_job-client',    traces[1]['Layer']
+    assert_equal 'entry',                 traces[1]['Label']
+    assert_equal 'pushq',                 traces[1]['Spec']
+    assert_equal 'DelayedJob',            traces[1]['Flavor']
+    assert_equal 'Widget#do_work',        traces[1]['JobName']
+    assert_equal 'delayed_job-client',    traces[2]['Layer']
+    assert_equal 'exit',                  traces[2]['Label']
+    assert_equal 'dj_delay',              traces[3]['Layer']
+    assert_equal 'exit',                  traces[3]['Label']
+
+  end
+
+  def test_collect_backtraces_default_value
+    assert_equal AppOpticsAPM::Config[:delayed_jobclient][:collect_backtraces], false, "default backtrace collection"
+  end
+
+  def test_log_args_default_value
+    assert_equal AppOpticsAPM::Config[:delayed_jobclient][:log_args], true, "log_args default "
+  end
+
+  def test_obey_collect_backtraces_when_false
+    AppOpticsAPM::Config[:delayed_jobclient][:collect_backtraces] = false
+
+    w = Widget.new(:name => 'blah', :description => 'This is a wonderful widget.')
+    w.save
+
+    AppOpticsAPM::API.start_trace('dj_delay') do
+      w.delay.do_work(1, 2, 3)
+    end
+
+    traces = get_all_traces
+    assert valid_edges?(traces), "Invalid edge in traces"
+
+    assert_equal 'delayed_job-client',    traces[1]['Layer']
+    assert_equal 'entry',                 traces[1]['Label']
+    assert_equal false,                   traces[1].key?('Backtrace')
+  end
+
+  def test_obey_collect_backtraces_when_true
+    AppOpticsAPM::Config[:delayed_jobclient][:collect_backtraces] = true
+
+    w = Widget.new(:name => 'blah', :description => 'This is a wonderful widget.')
+    w.save
+
+    AppOpticsAPM::API.start_trace('dj_delay') do
+      w.delay.do_work(1, 2, 3)
+    end
+
+    traces = get_all_traces
+    assert valid_edges?(traces), "Invalid edge in traces"
+
+    assert_equal 'delayed_job-client',    traces[1]['Layer']
+    assert_equal 'entry',                 traces[1]['Label']
+    assert_equal true,                   traces[1].key?('Backtrace')
+  end
+end

data/test/queues/delayed_job-worker_test.rb

@@ -0,0 +1,91 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+require_relative '../jobs/delayed_job/remote_call_worker_job'
+require_relative '../jobs/delayed_job/db_worker_job'
+require_relative '../jobs/delayed_job/error_worker_job'
+require_relative '../models/widget'
+
+class DelayedJobWorkerTest < Minitest::Test
+  def setup
+    # Delete all pre-existing jobs before we start
+    Delayed::Job.delete_all
+
+    clear_all_traces
+    @collect_backtraces = AppOpticsAPM::Config[:delayed_jobworker][:collect_backtraces]
+    @log_args = AppOpticsAPM::Config[:delayed_jobworker][:log_args]
+  end
+
+  def teardown
+    AppOpticsAPM::Config[:delayed_jobworker][:collect_backtraces] = @collect_backtraces
+    AppOpticsAPM::Config[:delayed_jobworker][:log_args] = @log_args
+  end
+
+  def test_reports_version_init
+    init_kvs = ::AppOpticsAPM::Util.build_init_report
+    assert init_kvs.key?('Ruby.delayed_job.Version')
+    assert_equal Gem.loaded_specs['delayed_job'].version.to_s, init_kvs['Ruby.delayed_job.Version']
+  end
+
+  def test_job_run
+    w = Widget.new(:name => 'blah', :description => 'This is a wonderful wonderful widget.')
+    w.save
+
+    w.delay.do_work(1, 2, 3)
+
+    sleep 15
+
+    traces = get_all_traces
+    assert_equal 2, traces.count, "Trace count"
+    assert valid_edges?(traces), "Invalid edge in traces"
+
+    assert_equal 'delayed_job-worker',    traces[0]['Layer']
+    assert_equal 'entry',                 traces[0]['Label']
+    assert_equal 'job',                   traces[0]['Spec']
+    assert_equal 'DelayedJob',            traces[0]['Flavor']
+    assert_equal 'Widget#do_work',        traces[0]['JobName']
+    assert_equal 0,                       traces[0]['priority']
+    assert_equal 0,                       traces[0]['attempts']
+    assert       traces[0].key?('WorkerName'), "Worker Name"
+    assert       traces[0].key?('SampleRate')
+    assert       traces[0].key?('SampleSource')
+    assert_equal false,                   traces[0].key?('Backtrace')
+
+    assert_equal 'delayed_job-worker',    traces[1]['Layer']
+    assert_equal 'exit',                  traces[1]['Label']
+  end
+
+  def test_jobs_with_errors
+    w = Widget.new(:name => 'blah', :description => 'This is a wonderful wonderful widget.')
+    w.save
+
+    w.delay.do_error(1, 2, 3)
+
+    sleep 15
+
+    traces = get_all_traces
+    assert_equal 3, traces.count, "Trace count"
+    assert valid_edges?(traces), "Invalid edge in traces"
+
+    assert_equal 'delayed_job-worker',          traces[0]['Layer']
+    assert_equal 'entry',                       traces[0]['Label']
+
+    assert_equal 'error',                       traces[1]['Label']
+    assert_equal 'FakeTestError',               traces[1]['ErrorMsg']
+    assert       traces[1].key?('Backtrace')
+    assert       traces[1].key?('ErrorClass')
+
+    assert_equal 'delayed_job-worker',          traces[2]['Layer']
+    assert_equal 'exit',                        traces[2]['Label']
+
+  end
+
+  def test_collect_backtraces_default_value
+    assert_equal AppOpticsAPM::Config[:delayed_jobworker][:collect_backtraces], false, "default backtrace collection"
+  end
+
+  def test_log_args_default_value
+    assert_equal AppOpticsAPM::Config[:delayed_jobworker][:log_args], true, "log_args default "
+  end
+end

data/test/reporter/reporter_test.rb

@@ -0,0 +1,14 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest_helper'
+
+class APPOPTICSReporterTest < Minitest::Test
+  def reporter_has_start_method
+    assert_equal true, AppOpticsAPM::Reporter.respond_to?(:start), "has restart method"
+  end
+
+  def reporter_has_restart_method
+    assert_equal true, AppOpticsAPM::Reporter.respond_to?(:restart), "has start method"
+  end
+end

data/test/servers/delayed_job.rb

@@ -0,0 +1,107 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+# This is a Rails app that launches a DelayedJob worker
+# in a background thread.
+#
+require "rails/all"
+require "delayed_job"
+require "action_controller/railtie"
+require 'rack/handler/puma'
+require File.expand_path(File.dirname(__FILE__) + '/../models/widget')
+
+AppOpticsAPM.logger.level = Logger::DEBUG
+AppOpticsAPM.logger.info "[appoptics_apm/info] Starting background utility rails app on localhost:8140."
+
+AppOpticsAPM::Test.set_postgresql_env
+
+ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
+
+unless ActiveRecord::Base.connection.table_exists? :delayed_jobs
+  AppOpticsAPM.logger.info "[appoptics_apm/servers] Creating DelayedJob DB table."
+
+  dj_dir = Gem::Specification.find_by_name('delayed_job_active_record').gem_dir
+  template = File.open(File.join(dj_dir, "lib/generators/delayed_job/templates/migration.rb"))
+
+  migration_context = Class.new do
+    def get_binding
+      binding
+    end
+
+    private
+
+    def migration_version
+      if ActiveRecord::VERSION::MAJOR >= 5
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+    end
+  end
+  migration_ruby = ERB.new(template.read).result(migration_context.new.get_binding)
+  eval migration_ruby
+
+  ActiveRecord::Migration.run(CreateDelayedJobs)
+end
+
+unless ActiveRecord::Base.connection.table_exists? 'widgets'
+  ActiveRecord::Migration.run(CreateWidgets)
+end
+
+class Rails40MetalStack < Rails::Application
+  routes.append do
+    get "/hello/world" => "hello#world"
+    get "/hello/metal" => "ferro#world"
+  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.middleware.delete "ActionDispatch::BestStandardsSupport"
+  config.secret_token = "49837489qkuweoiuoqwehisuakshdjksadhaisdy78o34y138974xyqp9rmye8yrpiokeuioqwzyoiuxftoyqiuxrhm3iou1hrzmjk"
+  config.secret_key_base = "2048671-96803948"
+end
+
+#################################################
+#  Controllers
+#################################################
+
+class HelloController < ActionController::Base
+  def world
+    render :text => "Hello world!"
+  end
+end
+
+class FerroController < ActionController::Metal
+  include AbstractController::Rendering
+
+  def world
+    render :text => "Hello world!"
+  end
+end
+
+Delayed::Job.delete_all
+
+@worker_options = {
+  :min_priority => ENV['MIN_PRIORITY'],
+  :max_priority => ENV['MAX_PRIORITY'],
+  :queues => (ENV['QUEUES'] || ENV['QUEUE'] || '').split(','),
+  :quiet => ENV['QUIET']
+}
+
+@worker_options[:sleep_delay] = ENV['SLEEP_DELAY'].to_i if ENV['SLEEP_DELAY']
+@worker_options[:read_ahead] = ENV['READ_AHEAD'].to_i if ENV['READ_AHEAD']
+
+AppOpticsAPM.logger.info "[appoptics_apm/servers] Starting up background DelayedJob."
+
+#Delayed::Worker.delay_jobs = false
+Delayed::Worker.max_attempts = 1
+Delayed::Worker.sleep_delay = 10
+
+Thread.new do
+  Delayed::Worker.new(@worker_options).start
+end
+
+# Allow it to boot
+AppOpticsAPM.logger.info "[appoptics_apm/servers] Waiting 5 seconds for DJ to boot..."
+sleep 5

data/test/servers/rackapp_8101.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+# This is a Rack application that is booted in a background
+# thread and listens on port 8101.
+#
+require 'rack/handler/puma'
+require 'appoptics_apm/inst/rack'
+
+AppOpticsAPM.logger.info "[appoptics_apm/info] Starting background utility rack app on localhost:8101."
+
+Thread.new do
+  app = Rack::Builder.new {
+    use AppOpticsAPM::Rack
+    map "/" do
+      run Proc.new { [200, {"Content-Type" => "text/html"}, ['Hello AppOpticsAPM!']] }
+    end
+
+    map "/redirectme" do
+      run Proc.new { [301, {"Location" => "/", "Content-Type" => "text/html"}, ['']] }
+    end
+  }
+
+  Rack::Handler::Puma.run(app, {:Host => '127.0.0.1', :Port => 8101})
+end
+
+# Allow Thin to boot.
+sleep(2)
+

data/test/servers/rails3x_8140.rb

@@ -0,0 +1,96 @@
+##
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+#  This is a Rails stack that launches on a background
+#  thread and listens on port 8140.
+#
+require "rails/all"
+require "action_controller/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:8140."
+
+if ENV['DBTYPE'] == 'mysql2'
+  AppOpticsAPM::Test.set_mysql2_env
+elsif ENV['DBTYPE'] == 'mysql'
+  AppOpticsAPM::Test.set_mysql_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
+
+ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
+
+unless ActiveRecord::Base.connection.table_exists? 'widgets'
+  CreateWidgets.migrate(:up)
+end
+
+class Rails32MetalStack < Rails::Application
+  routes.append do
+    get "/hello/world" => "hello#world"
+    get "/hello/:id/show" => "hello#show"
+    get "/hello/metal" => "ferro#world"
+    get "/hello/db"    => "hello#db"
+    get "/hello/servererror" => "hello#servererror"
+  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.middleware.delete "ActionDispatch::BestStandardsSupport"
+  config.secret_token = "498374i49qkuweoiuoqwehisuakshdhksadhaisdy78o34y138974xyqu9rmye8yrpiokeuioqwzyo8uxftoyqiuxrhm3iou1hrzmjk"
+  config.secret_key_base = "2048671-96803948"
+end
+
+#################################################
+#  Controllers
+#################################################
+
+class HelloController < ActionController::Base
+  def world
+    render :text => "Hello world!"
+  end
+
+  def show
+    render :text => "Hello Number #{params[:id]}"
+  end
+
+  def db
+    # Create a widget
+    w1 = Widget.new(:name => 'blah', :description => 'This is an amazing widget.')
+    w1.save
+
+    # query for that widget
+    w2 = Widget.where(:name => 'blah').first
+    w2.delete
+
+    render :text => "Hello database!"
+  end
+
+  def servererror
+    render :plain => "broken", :status => 500
+  end
+end
+
+class FerroController < ActionController::Metal
+  include AbstractController::Rendering
+
+  def world
+    self.response_body = "Hello world!"
+  end
+end
+
+AppOpticsAPM::API.profile_method(FerroController, :world)
+
+Rails32MetalStack.initialize!
+
+Thread.new do
+  Rack::Handler::Puma.run(Rails32MetalStack.to_app, {:Host => '127.0.0.1', :Port => 8140})
+end
+
+sleep(2)

data/test/servers/rails4x_8140.rb

@@ -0,0 +1,96 @@
+##
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+#  This is a Rails stack that launches on a background
+#  thread and listens on port 8140.
+#
+require "rails/all"
+require "action_controller/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:8140."
+
+if ENV['DBTYPE'] == 'mysql2'
+  AppOpticsAPM::Test.set_mysql2_env
+elsif ENV['DBTYPE'] == 'mysql'
+  AppOpticsAPM::Test.set_mysql_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
+
+ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
+
+unless ActiveRecord::Base.connection.table_exists? 'widgets'
+  ActiveRecord::Migration.run(CreateWidgets)
+end
+
+class Rails40MetalStack < Rails::Application
+  routes.append do
+    get "/hello/world" => "hello#world"
+    get "/hello/:id/show" => "hello#show"
+    get "/hello/metal" => "ferro#world"
+    get "/hello/db"    => "hello#db"
+    get "/hello/servererror" => "hello#servererror"
+  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.middleware.delete "ActionDispatch::BestStandardsSupport"
+  config.secret_token = "49830489qkuweoiuoqwehisuakshdjksadhaisdy78o34y138974xyqp9rmye8yypiokeuioqwzyoiuxftoyqiuxrhm3iou1hrzmjk"
+  config.secret_key_base = "2048671-96803948"
+end
+
+#################################################
+#  Controllers
+#################################################
+
+class HelloController < ActionController::Base
+  def world
+    render :text => "Hello world!"
+  end
+
+  def show
+    render :text => "Hello Number #{params[:id]}"
+  end
+
+  def db
+    # Create a widget
+    w1 = Widget.new(:name => 'blah', :description => 'This is an amazing widget.')
+    w1.save
+
+    # query for that widget
+    w2 = Widget.where(:name => 'blah').first
+    w2.delete
+
+    render :text => "Hello database!"
+  end
+
+  def servererror
+    render :plain => "broken", :status => 500
+  end
+end
+
+class FerroController < ActionController::Metal
+  include AbstractController::Rendering
+
+  def world
+    self.response_body = "Hello world!"
+  end
+end
+
+AppOpticsAPM::API.profile_method(FerroController, :world)
+
+Rails40MetalStack.initialize!
+
+Thread.new do
+  Rack::Handler::Puma.run(Rails40MetalStack.to_app, {:Host => '127.0.0.1', :Port => 8140, :Threads => "0:1"})
+end
+
+sleep(2)

data/test/servers/rails5x_8140.rb

@@ -0,0 +1,95 @@
+##
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+#  This is a Rails stack that launches on a background
+#  thread and listens on port 8140.
+#
+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/all"
+require "action_controller/railtie" # require more if needed
+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:8140."
+
+ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
+
+unless ActiveRecord::Base.connection.table_exists? 'widgets'
+  ActiveRecord::Migration.run(CreateWidgets)
+end
+
+class Rails50MetalStack < Rails::Application
+  routes.append do
+    get "/hello/world" => "hello#world"
+    get "/hello/:id/show" => "hello#show"
+    get "/hello/metal" => "ferro#world"
+    get "/hello/db"    => "hello#db"
+    get "/hello/servererror" => "hello#servererror"
+  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 = "49837489qkuweoiuoqwehisuakshdjksadhaisdy78o34y138974xyqp9rmye8yrpiokeuioqwzyoiuxftoyqiuxrhm3iou1hrzmjk"
+  config.secret_key_base = "2048671-96803948"
+end
+
+#################################################
+#  Controllers
+#################################################
+
+class HelloController < ActionController::Base
+  def world
+    render :plain => "Hello world!"
+  end
+
+  def show
+    render :plain => "Hello Number #{params[:id]}"
+  end
+
+  def db
+    # Create a widget
+    w1 = Widget.new(:name => 'blah', :description => 'This is an amazing widget.')
+    w1.save
+
+    # query for that widget
+    w2 = Widget.where(:name => 'blah').first
+    w2.delete
+
+    render :plain => "Hello database!"
+  end
+
+  def servererror
+    render :plain => "broken", :status => 500
+  end
+end
+
+class FerroController < ActionController::Metal
+  include AbstractController::Rendering
+
+  def world
+    render :plain => "Hello world!"
+  end
+end
+
+AppOpticsAPM::API.profile_method(FerroController, :world)
+
+Rails50MetalStack.initialize!
+
+Thread.new do
+  Rack::Handler::Puma.run(Rails50MetalStack.to_app, {:Host => '127.0.0.1', :Port => 8140})
+end
+
+sleep(2)