appoptics_apm 4.8.4 → 4.11.1

data/Rakefile

@@ -1,234 +0,0 @@
-#!/usr/bin/env rake
-
-require 'rubygems'
-require 'fileutils'
-require 'open-uri'
-require 'bundler/setup'
-require 'rake/testtask'
-require 'appoptics_apm/test'
-
-Rake::TestTask.new do |t|
-  t.verbose = false
-  t.warning = false
-  t.ruby_opts = []
-  t.libs << 'test'
-
-  # Since we support so many libraries and frameworks, tests
-  # runs are segmented into gemfiles that have different
-  # sets and versions of gems (libraries and frameworks).
-  #
-  # Here we detect the Gemfile the tests are being run against
-  # and load the appropriate tests.
-  #
-  case AppOpticsAPM::Test.gemfile
-  when /delayed_job/
-    require 'delayed/tasks'
-    t.test_files = FileList['test/queues/delayed_job*_test.rb']
-  when /rails/
-    # Pre-load rails to get the major version number
-    require 'rails'
-
-    if Rails::VERSION::MAJOR == 5
-      t.test_files = FileList["test/frameworks/rails#{Rails::VERSION::MAJOR}x_test.rb"] +
-                     FileList["test/frameworks/rails#{Rails::VERSION::MAJOR}x_api_test.rb"]
-    elsif Rails::VERSION::MAJOR == 6
-      t.test_files = FileList["test/frameworks/rails5x_test.rb"] +
-                     FileList["test/frameworks/rails5x_api_test.rb"]
-    else
-      t.test_files = FileList["test/frameworks/rails#{Rails::VERSION::MAJOR}x_test.rb"]
-    end
-
-  when /frameworks/
-    t.test_files = FileList['test/frameworks/sinatra*_test.rb'] +
-                   FileList['test/frameworks/padrino*_test.rb'] +
-                   FileList['test/frameworks/grape*_test.rb']
-  when /libraries/
-    t.test_files = FileList['test/support/*_test.rb'] +
-                   FileList['test/reporter/*_test.rb'] +
-                   FileList['test/instrumentation/*_test.rb'] +
-                   FileList['test/profiling/*_test.rb'] -
-                   ['test/instrumentation/twitter-cassandra_test.rb']
-  when /instrumentation_mocked/
-    # WebMock is interfering with other tests, so these have to run separately
-    t.test_files = FileList['test/mocked/*_test.rb']
-  when /noop/
-    t.test_files = FileList['test/noop/*_test.rb']
-  when /unit/
-    t.test_files = FileList['test/unit/*_test.rb'] +
-                   FileList['test/unit/*/*_test.rb']
-  end
-
-  if defined?(JRUBY_VERSION)
-    t.ruby_opts << ['-J-javaagent:/usr/local/tracelytics/tracelyticsagent.jar']
-  end
-end
-
-desc "Run all test suites defined by travis"
-task "docker_tests" do
-  Dir.chdir('test/run_tests')
-  exec('docker-compose run --rm ruby_appoptics /code/ruby-appoptics/test/run_tests/ruby_setup.sh test --remove-orphans')
-end
-
-desc "Start docker container for testing and debugging"
-task "docker" do
-  Dir.chdir('test/run_tests')
-  exec('docker-compose run --rm ruby_appoptics /code/ruby-appoptics/test/run_tests/ruby_setup.sh bash --remove-orphans')
-end
-
-desc "Stop all containers that were started for testing and debugging"
-task "docker_down" do
-  Dir.chdir('test/run_tests')
-  exec('docker-compose down')
-end
-
-desc "Fetch extension dependency files"
-task :fetch_ext_deps do
-  swig_version = %x{swig -version} rescue ''
-  swig_version = swig_version.scan(/swig version [34]/i)
-  if swig_version.empty?
-    $stderr.puts '== ERROR ================================================================='
-    $stderr.puts "Could not find required swig version >= 3.0.8, found #{swig_version.inspect}"
-    $stderr.puts 'Please install swig ">= 3.0.8" and try again.'
-    $stderr.puts '=========================================================================='
-    raise
-  end
-
-  # The c-lib version is different from the gem version
-  oboe_version = ENV['OBOE_VERSION'] || 'latest'
-  oboe_s3_dir = "https://s3-us-west-2.amazonaws.com/rc-files-t2/c-lib/#{oboe_version}"
-  ext_src_dir = File.expand_path('ext/oboe_metal/src')
-
-  # VERSION is used by extconf.rb to download the correct liboboe when installing the gem
-  remote_file = File.join(oboe_s3_dir, 'VERSION')
-  local_file = File.join(ext_src_dir, 'VERSION')
-  puts "fetching #{remote_file} to #{local_file}"
-  open(remote_file, 'rb') do |rf|
-    content = rf.read
-    File.open(local_file, 'wb') { |f| f.puts content }
-    puts "!!!!!!! C-Lib VERSION: #{content.strip} !!!!!!!!"
-  end
-
-  # oboe and bson header files
-  FileUtils.mkdir_p(File.join(ext_src_dir, 'bson'))
-  %w(oboe.h oboe.hpp oboe_debug.h oboe.i bson/bson.h bson/platform_hacks.h).each do |filename|
-  # %w(oboe.h oboe_debug.h bson/bson.h bson/platform_hacks.h).each do |filename|
-    remote_file = File.join(oboe_s3_dir, 'include', filename)
-    local_file = File.join(ext_src_dir, filename)
-
-    puts "fetching #{remote_file} to #{local_file}"
-    open(remote_file, 'rb') do |rf|
-      content = rf.read
-      File.open(local_file, 'wb') { |f| f.puts content }
-    end
-  end
-
-  FileUtils.cd(ext_src_dir) do
-    system('swig -c++ -ruby -module oboe_metal oboe.i')
-    FileUtils.rm('oboe.i')
-  end
-end
-
-task :fetch => :fetch_ext_deps
-
-desc "Build the gem's c extension"
-task :compile do
-  if !defined?(JRUBY_VERSION)
-    puts "== Building the c extension against Ruby #{RUBY_VERSION}"
-
-    pwd      = Dir.pwd
-    ext_dir  = File.expand_path('ext/oboe_metal')
-    final_so = File.expand_path('lib/oboe_metal.so')
-    so_file  = File.expand_path('ext/oboe_metal/oboe_metal.so')
-
-    Dir.chdir ext_dir
-    ENV['APPOPTICS_FROM_S3'] = 'true'
-    cmd = [Gem.ruby, 'extconf.rb']
-    sh cmd.join(' ')
-    sh '/usr/bin/env make'
-
-    File.delete(final_so) if File.exist?(final_so)
-
-    if File.exist?(so_file)
-      FileUtils.mv(so_file, final_so)
-      Dir.chdir(pwd)
-      puts "== Extension built and moved to #{final_so}"
-    else
-      Dir.chdir(pwd)
-      puts '!! Extension failed to build (see above). Have the required binary and header files been fetched?'
-      puts '!! Try the tasks in this order: clean > fetch_ext_deps > compile.'
-    end
-  else
-    puts '== Nothing to do under JRuby.'
-  end
-end
-
-desc 'Clean up extension build files'
-task :clean do
-  if !defined?(JRUBY_VERSION)
-    pwd     = Dir.pwd
-    ext_dir = File.expand_path('ext/oboe_metal')
-    symlinks = [
-      File.expand_path('lib/oboe_metal.so'),
-      File.expand_path('ext/oboe_metal/lib/liboboe.so'),
-      File.expand_path('ext/oboe_metal/lib/liboboe-1.0.so.0')
-    ]
-
-    symlinks.each do |symlink|
-      FileUtils.rm_f symlink
-    end
-    Dir.chdir ext_dir
-    sh '/usr/bin/env make clean' if File.exist? 'Makefile'
-
-    Dir.chdir pwd
-  else
-    puts '== Nothing to do under JRuby.'
-  end
-end
-
-desc 'Remove all built files and extensions'
-task :distclean do
-  if !defined?(JRUBY_VERSION)
-    pwd     = Dir.pwd
-    ext_dir = File.expand_path('ext/oboe_metal')
-    mkmf_log = File.expand_path('ext/oboe_metal/mkmf.log')
-    symlinks = [
-      File.expand_path('lib/oboe_metal.so'),
-      File.expand_path('ext/oboe_metal/lib/liboboe.so'),
-      File.expand_path('ext/oboe_metal/lib/liboboe-1.0.so.0')
-    ]
-
-    if File.exist? mkmf_log
-      symlinks.each do |symlink|
-        FileUtils.rm_f symlink
-      end
-      Dir.chdir ext_dir
-      sh '/usr/bin/env make distclean' if File.exist? 'Makefile'
-
-      Dir.chdir pwd
-    else
-      puts 'Nothing to distclean. (nothing built yet?)'
-    end
-  else
-    puts '== Nothing to do under JRuby.'
-  end
-end
-
-desc "Rebuild the gem's c extension"
-task :recompile => [:distclean, :compile]
-
-task :environment do
-  ENV['APPOPTICS_GEM_VERBOSE'] = 'true'
-
-  Bundler.require(:default, :development)
-  AppOpticsAPM::Config[:tracing_mode] = :enabled
-  AppOpticsAPM::Test.load_extras
-
-  if AppOpticsAPM::Test.gemfile?(:delayed_job)
-    require 'delayed/tasks'
-  end
-end
-
-# Used when testing Resque locally
-task 'resque:setup' => :environment do
-  require 'resque/tasks'
-end

data/build_gem.sh

@@ -1,15 +0,0 @@
-#!/usr/bin/env bash
-# builds the appoptics_apm gem for MRI.
-
-# we currently only build for MRI, no JRuby
-echo -e "\n=== building for MRI ===\n"
-rm -f Gemfile.lock
-bundle install
-bundle exec rake distclean
-bundle exec rake fetch_ext_deps
-gem build appoptics_apm.gemspec
-
-echo -e "\n=== built gems ===\n"
-ls -la appoptics_apm*.gem
-
-echo -e "\n=== publish to rubygems via: gem push <gem> ===\n"

data/build_gem_upload_to_packagecloud.sh

@@ -1,15 +0,0 @@
-#!/bin/bash
-
-# build the gem,
-# oboe/c-lib version can be given as optional parameter
-if [ "$1" != "" ]; then
-  OBOE_VERSION=$1 ./build_gem.sh
-else
-  ./build_gem.sh
-fi
-
-gem install package_cloud --no-document
-
-# prerequisite: package_cloud token needs to be in ~/.packagecloud
-gem=`ls -dt1 appoptics_apm-[^pre]*.gem | head -1`
-package_cloud push solarwinds/appoptics-apm-ruby $gem

data/lib/appoptics_apm/api/profiling.rb

@@ -1,203 +0,0 @@
-#--
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
-#++
-
-module AppOpticsAPM
-  module API
-    ##
-    # Module to create profiling traces for blocks of code or methods
-    module Profiling
-      ##
-      # Public: Profile a given block of code. Detect any exceptions thrown by
-      # the block and report errors.
-      #
-      # ==== Arguments
-      #
-      # * +profile_name+ - A name used to identify the block being profiled.
-      # * +report_kvs+ - A hash containing key/value pairs that will be reported along
-      #   with the event of this profile (optional).
-      # * +with_backtrace+ - Boolean to indicate whether a backtrace should
-      #   be collected with this trace event.
-      #
-      # ==== Example
-      #
-      #   def computation(n)
-      #     AppOpticsAPM::API.profile('fib', { :n => n }) do
-      #       fib(n)
-      #     end
-      #   end
-      #
-      # Returns the result of the block.
-      #
-
-      def profile(profile_name, report_kvs = {}, with_backtrace = false)
-        return yield unless AppOpticsAPM.tracing?
-
-        begin
-          report_kvs[:Language] ||= :ruby
-          report_kvs[:ProfileName] ||= profile_name
-          report_kvs[:Backtrace] = AppOpticsAPM::API.backtrace if with_backtrace
-
-          AppOpticsAPM::API.log(nil, :profile_entry, report_kvs)
-
-          begin
-            yield
-          rescue => e
-            log_exception(nil, e)
-            raise
-          ensure
-            exit_kvs = {}
-            exit_kvs[:Language] = :ruby
-            exit_kvs[:ProfileName] = report_kvs[:ProfileName]
-
-            AppOpticsAPM::API.log(nil, :profile_exit, exit_kvs)
-          end
-        end
-      end
-
-      ##
-      # Public: Add profiling to a method on a class or module.  That method can be of any (accessible)
-      # type (instance, singleton, private, protected etc.).
-      #
-      # ==== Arguments
-      #
-      # * +klass+  - the class or module that has the method to profile
-      # * +method+ - the method to profile.  Can be singleton, instance, private etc...
-      # * +opts+   - a hash specifying the one or more of the following options:
-      #   * +:arguments+  - report the arguments passed to <tt>method</tt> on each profile (default: false)
-      #   * +:result+     - report the return value of <tt>method</tt> on each profile (default: false)
-      #   * +:backtrace+  - report the return value of <tt>method</tt> on each profile (default: false)
-      #   * +:name+       - alternate name for the profile reported in the dashboard (default: method name)
-      # * +extra_kvs+ - a hash containing any additional key/value pairs you would like reported with the profile
-      #
-      # ==== Example
-      #
-      #   opts = {}
-      #   opts[:backtrace] = true
-      #   opts[:arguments] = false
-      #   opts[:name] = :array_sort
-      #
-      #   AppOpticsAPM::API.profile_method(Array, :sort, opts)
-      #
-      def profile_method(klass, method, opts = {}, extra_kvs = {})
-        # If we're on an unsupported platform (ahem Mac), just act
-        # like we did something to nicely play the no-op part.
-        return true unless AppOpticsAPM.loaded
-
-        if !klass.is_a?(Module)
-          AppOpticsAPM.logger.warn "[appoptics_apm/error] profile_method: Not sure what to do with #{klass}.  Send a class or module."
-          return false
-        end
-
-        if method.is_a?(String)
-          method = method.to_sym
-        elsif !method.is_a?(Symbol)
-          AppOpticsAPM.logger.warn "[appoptics_apm/error] profile_method: Not sure what to do with #{method}.  Send a string or symbol for method."
-          return false
-        end
-
-        instance_method = klass.instance_methods.include?(method) || klass.private_instance_methods.include?(method)
-        class_method = klass.singleton_methods.include?(method)
-
-        # Make sure the request klass::method exists
-        if !instance_method && !class_method
-          AppOpticsAPM.logger.warn "[appoptics_apm/error] profile_method: Can't instrument #{klass}.#{method} as it doesn't seem to exist."
-          AppOpticsAPM.logger.warn "[appoptics_apm/error] #{__FILE__}:#{__LINE__}"
-          return false
-        end
-
-        # Strip '!' or '?' from method if present
-        safe_method_name = method.to_s.chop if method.to_s =~ /\?$|\!$/
-        safe_method_name ||= method
-
-        without_appoptics = "#{safe_method_name}_without_appoptics"
-        with_appoptics    = "#{safe_method_name}_with_appoptics"
-
-        # Check if already profiled
-        if klass.instance_methods.include?(with_appoptics.to_sym) ||
-           klass.singleton_methods.include?(with_appoptics.to_sym)
-          AppOpticsAPM.logger.warn "[appoptics_apm/error] profile_method: #{klass}::#{method} already profiled."
-          AppOpticsAPM.logger.warn "[appoptics_apm/error] profile_method: #{__FILE__}:#{__LINE__}"
-          return false
-        end
-
-        source_location = []
-        if instance_method
-          AppOpticsAPM::Util.send_include(klass, AppOpticsAPM::MethodProfiling)
-          source_location = klass.instance_method(method).source_location
-        elsif class_method
-          AppOpticsAPM::Util.send_extend(klass, AppOpticsAPM::MethodProfiling)
-          source_location = klass.method(method).source_location
-        end
-
-        report_kvs = collect_profile_kvs(klass, method, opts, extra_kvs, source_location)
-        report_kvs[:MethodName] = safe_method_name
-
-        if instance_method
-          klass.class_eval do
-            define_method(with_appoptics) do |*args, &block|
-              profile_wrapper(without_appoptics, report_kvs, opts, *args, &block)
-            end
-
-            alias_method without_appoptics, method.to_s
-            alias_method method.to_s, with_appoptics
-          end
-        elsif class_method
-          klass.define_singleton_method(with_appoptics) do |*args, &block|
-            profile_wrapper(without_appoptics, report_kvs, opts, *args, &block)
-          end
-
-          klass.singleton_class.class_eval do
-            alias_method without_appoptics, method.to_s
-            alias_method method.to_s, with_appoptics
-          end
-        end
-        true
-      end
-
-      private
-
-      ##
-      # Private: Helper method to aggregate KVs to report
-      #
-      # klass  - the class or module that has the method to profile
-      # method - the method to profile.  Can be singleton, instance, private etc...
-      # opts   - a hash specifying the one or more of the following options:
-      #   * :arguments  - report the arguments passed to <tt>method</tt> on each profile (default: false)
-      #   * :result     - report the return value of <tt>method</tt> on each profile (default: false)
-      #   * :backtrace  - report the return value of <tt>method</tt> on each profile (default: false)
-      #   * :name       - alternate name for the profile reported in the dashboard (default: method name)
-      # extra_kvs - a hash containing any additional KVs you would like reported with the profile
-      # source_location - array returned from klass.method(:name).source_location
-      #
-      def collect_profile_kvs(klass, method, opts, extra_kvs, source_location)
-        report_kvs = {}
-        report_kvs[:Language] ||= :ruby
-        report_kvs[:ProfileName] ||= opts[:name] ? opts[:name] : method
-
-        klass.is_a?(Class) ? report_kvs[:Class] = klass.to_s : report_kvs[:Module] = klass.to_s
-
-        # If this is a Rails Controller, report the KVs
-        if defined?(::AbstractController::Base) && klass.ancestors.include?(::AbstractController::Base)
-          report_kvs[:Controller] = klass.to_s
-          report_kvs[:Action] = method.to_s
-        end
-
-        # We won't have access to this info for native methods (those not defined in Ruby).
-        if source_location.is_a?(Array) && source_location.length == 2
-          report_kvs[:File] = source_location[0]
-          report_kvs[:LineNumber] = source_location[1]
-        end
-
-        # Merge in any extra_kvs requested
-        report_kvs.merge!(extra_kvs)
-      end
-
-
-      # need to set the context to public, otherwise the following `extends` will be private in api.rb
-      public
-
-    end
-  end
-end