solarwinds_apm 5.0.0

data/lib/solarwinds_apm/test.rb

@@ -0,0 +1,165 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module SolarWindsAPM
+  module Test
+    class << self
+      ##
+      # load_extras
+      #
+      # This method simply loads all the extras needed to run
+      # tests such as models, jobs etc...
+      #
+      def load_extras
+        # If we're using the libraries gemfile (with sidekiq and resque)
+        if SolarWindsAPM::Test.gemfile?(:libraries)
+          # Load all of the test workers
+          pattern = File.join(File.dirname(__FILE__), '../../test/jobs/**/', '*.rb')
+          Dir.glob(pattern) do |f|
+            SolarWindsAPM.logger.debug "[solarwinds_apm/test] Loading test job file: #{File.basename(f)}"
+            require f
+          end
+        end
+      end
+
+      ##
+      # gemfile?
+      #
+      # Method used to determine under which gemfile we're running.
+      # Pass <tt>name</tt> as the gemfile name only (without the
+      # .gemfile extension)
+      #
+      # returns true or fase depending on result
+      #
+      def gemfile?(name)
+        File.basename(ENV['BUNDLE_GEMFILE']) == (name.to_s + '.gemfile')
+      end
+
+      ##
+      # gemfile
+      #
+      # Used to determine under which gemfile we are running.  This
+      # method will return the name of the active gemfile
+      #
+      def gemfile
+        File.basename(ENV['BUNDLE_GEMFILE']).split('.').first
+      end
+
+      ##
+      # set_postgresql_env
+      #
+      # Used to set the postgresql specific DATABASE_URL env based
+      # on various conditions
+      def set_postgresql_env
+        if ENV.key?('TRAVIS_PSQL_PASS')
+          ENV['DATABASE_URL'] = "postgresql://postgres:#{ENV['TRAVIS_PSQL_PASS']}@127.0.0.1:5432/test_db"
+        elsif ENV.key?('POSTGRES_USER')
+          port = ENV.key?('POSTGRES_PORT') ? ENV['POSTGRES_PORT'] : 5432
+          ENV['DATABASE_URL'] = "postgresql://#{ENV['POSTGRES_PASSWORD']}:#{ENV['POSTGRES_USER']}@#{ENV['POSTGRES_HOST']}:#{port}/test_db"
+        else
+          ENV['DATABASE_URL'] = 'postgresql://postgres@127.0.0.1:5432/test_db'
+        end
+      end
+
+      ##
+      # To configure Rails to enable or disable prepared statements
+      # we need to do it using the database.yml file
+      # there is no method exposed (afaik) to set prepared_statements
+      # interactively
+      def set_postgresql_rails_config
+        # need to use string keys otherwise the output is not readable by Rails 5
+        config = {
+          'adapter'  => "postgresql",
+          'username' =>  ENV.key?('POSTGRES_USER') ? ENV['POSTGRES_USER'] : "postgres",
+          'password' =>  ENV.key?('POSTGRES_PASSWORD') ? ENV['POSTGRES_PASSWORD'] : "postgres",
+          'database' =>  "test_db",
+          'host'     =>  ENV.key?('POSTGRES_HOST') ? ENV['POSTGRES_HOST'] : '127.0.0.1',
+          'port'     =>  ENV.key?('POSTGRES_PORT') ? ENV['POSTGRES_PORT'] : 5432,
+          'statement_limit' =>  5
+        }
+
+        if ENV.key?('TEST_PREPARED_STATEMENT')
+          config['prepared_statements'] = ENV['TEST_PREPARED_STATEMENT'] == 'true' ? true : false
+        else
+          config['prepared_statements'] = false
+        end
+
+        env_config = {
+          'default' => config,
+          'development' => config,
+          'test' => config
+        }
+
+        FileUtils.mkdir_p('config')
+        File.open("config/database.yml","w") do |file|
+          file.write env_config.to_yaml
+        end
+        config
+      end
+      ##
+      # set_mysql_env
+      #
+      # Used to set the mysql specific DATABASE_URL env based
+      # on various conditions
+      def set_mysql_env
+        if ENV.key?('TRAVIS_MYSQL_PASS')
+          ENV['DATABASE_URL'] = "mysql://root:#{ENV['TRAVIS_MYSQL_PASS']}@127.0.0.1:3306/test_db"
+        elsif ENV.key?('DOCKER_MYSQL_PASS')
+          port = ENV.key?('MYSQL_PORT') ? ENV['MYSQL_PORT'] : 3306
+          ENV['DATABASE_URL'] = "mysql://root:#{ENV['DOCKER_MYSQL_PASS']}@#{ENV['MYSQL_HOST']}:#{port}/test_db"
+        else
+          ENV['DATABASE_URL'] = 'mysql://root@127.0.0.1:3306/test_db'
+        end
+      end
+
+      ##
+      # set_mysql2_env
+      #
+      # Used to set the mysql specific DATABASE_URL env based
+      # on various conditions
+      def set_mysql2_env
+        if ENV.key?('TRAVIS_MYSQL_PASS')
+          ENV['DATABASE_URL'] = "mysql2://root:#{ENV['TRAVIS_MYSQL_PASS']}@127.0.0.1:3306/test_db"
+        elsif ENV.key?('DOCKER_MYSQL_PASS')
+          ENV['DATABASE_URL'] = "mysql2://root:#{ENV['DOCKER_MYSQL_PASS']}@#{ENV['MYSQL_HOST']}:3306/test_db"
+        else
+          ENV['DATABASE_URL'] = 'mysql2://root@127.0.0.1:3306/test_db'
+        end
+      end
+
+      ##
+      # To configure Rails to enable or disable prepared statements
+      # we need to do it using the database.yml file
+      # there is no method exposed (afaik) to set prepared_statements
+      # interactively
+      def set_mysql2_rails_config
+        config = {
+          'adapter' => "mysql2",
+          'username' => "root",
+          'database' => "test_db",
+          'port' => 3306
+        }
+
+        config[:password] = ENV['DOCKER_MYSQL_PASS'] if ENV.key?('DOCKER_MYSQL_PASS')
+        config[:host] = ENV.key?('MYSQL_HOST') ? ENV['MYSQL_HOST'] : '127.0.0.1'
+
+        if ENV.key?('TEST_PREPARED_STATEMENT')
+          config['prepared_statements'] = ENV['TEST_PREPARED_STATEMENT'] == 'true' ? true : false
+        else
+          config['prepared_statements'] = false
+        end
+
+        env_config = {
+          'default' => config,
+          'test' => config
+        }
+
+        FileUtils.mkdir_p('config')
+        File.open("config/database.yml","w") do |file|
+          file.write env_config.to_yaml
+        end
+        config
+      end
+    end
+  end
+end

data/lib/solarwinds_apm/thread_local.rb

@@ -0,0 +1,26 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module SolarWindsAPM
+  ##
+  # Provides thread local storage for SolarWindsAPM.
+  #
+  # Example usage:
+  # module SolarWindsAPMBase
+  #   extend SolarWindsAPM::ThreadLocal
+  #   thread_local :layer_op
+  # end
+  module ThreadLocal
+    def thread_local(name)
+      key = "__#{self}_#{name}__".intern
+
+      define_method(name) do
+        Thread.current[key]
+      end
+
+      define_method(name.to_s + '=') do |value|
+        Thread.current[key] = value
+      end
+    end
+  end
+end

data/lib/solarwinds_apm/util.rb

@@ -0,0 +1,334 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module SolarWindsAPM
+  ##
+  # Provides utility methods for use while in the business
+  # of instrumenting code
+  module Util
+    class << self
+      def contextual_name(cls)
+        # Attempt to infer a contextual name if not indicated
+        #
+        # For example:
+        # ::ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter.to_s.split(/::/).last
+        # => "AbstractMysqlAdapter"
+        #
+        cls.to_s.split(/::/).last
+      rescue
+        cls
+      end
+
+      ##
+      # method_alias
+      #
+      # Centralized utility method to alias a method on an arbitrary
+      # class or module.
+      #
+      def method_alias(cls, method, name = nil)
+        name ||= contextual_name(cls)
+
+        if cls.method_defined?(method.to_sym) || cls.private_method_defined?(method.to_sym)
+
+          # Strip '!' or '?' from method if present
+          safe_method_name = method.to_s.chop if method.to_s =~ /\?$|\!$/
+          safe_method_name ||= method
+
+          without_sw_apm = "#{safe_method_name}_without_sw_apm"
+          with_sw_apm    = "#{safe_method_name}_with_sw_apm"
+
+          # Only alias if we haven't done so already
+          unless cls.method_defined?(without_sw_apm.to_sym) ||
+            cls.private_method_defined?(without_sw_apm.to_sym)
+
+            cls.class_eval do
+              alias_method without_sw_apm, method.to_s
+              alias_method method.to_s, with_sw_apm
+            end
+          end
+        else
+          SolarWindsAPM.logger.warn "[solarwinds_apm/loading] Couldn't properly instrument #{name}.#{method}.  Partial traces may occur."
+        end
+      end
+
+      ##
+      # class_method_alias
+      #
+      # Centralized utility method to alias a class method on an arbitrary
+      # class or module
+      #
+      def class_method_alias(cls, method, name = nil)
+        name ||= contextual_name(cls)
+
+        if cls.singleton_methods.include? method.to_sym
+
+          # Strip '!' or '?' from method if present
+          safe_method_name = method.to_s.chop if method.to_s =~ /\?$|\!$/
+          safe_method_name ||= method
+
+          without_sw_apm = "#{safe_method_name}_without_sw_apm"
+          with_sw_apm    = "#{safe_method_name}_with_sw_apm"
+
+          # Only alias if we haven't done so already
+          unless cls.singleton_methods.include? without_sw_apm.to_sym
+            cls.singleton_class.send(:alias_method, without_sw_apm, method.to_s)
+            cls.singleton_class.send(:alias_method, method.to_s, with_sw_apm)
+          end
+        else
+          SolarWindsAPM.logger.warn "[solarwinds_apm/loading] Couldn't properly instrument #{name}.  Partial traces may occur."
+        end
+      end
+
+      ##
+      # send_extend
+      #
+      # Centralized utility method to send an extend call for an
+      # arbitrary class
+      def send_extend(target_cls, cls)
+        target_cls.send(:extend, cls) if defined?(target_cls)
+      end
+
+      ##
+      # send_include
+      #
+      # Centralized utility method to send a include call for an
+      # arbitrary class
+      def send_include(target_cls, cls)
+        target_cls.send(:include, cls) if defined?(target_cls)
+      end
+
+      ##
+      # prettify
+      #
+      # Even to my surprise, 'prettify' is a real word:
+      # transitive v. To make pretty or prettier, especially in a superficial or insubstantial way.
+      #   from The American Heritage Dictionary of the English Language, 4th Edition
+      #
+      # This method makes things 'purty' for reporting.
+      def prettify(x)
+        if (x.to_s =~ /^#</) == 0
+          x.class.to_s
+        else
+          x.to_s
+        end
+      end
+
+      ##
+      # upcase
+      #
+      # Occasionally, we want to send some values in all caps.  This is true
+      # for things like HTTP scheme or method.  This takes anything and does
+      # it's best to safely convert it to a string (if needed) and convert it
+      # to all uppercase.
+      def upcase(o)
+        if o.is_a?(String) || o.respond_to?(:to_s)
+          o.to_s.upcase
+        else
+          SolarWindsAPM.logger.debug "[solarwinds_apm/debug] SolarWindsAPM::Util.upcase: could not convert #{o.class}"
+          'UNKNOWN'
+        end
+      end
+
+      ##
+      # to_query
+      #
+      # Used to convert a hash into a URL # query.
+      #
+      def to_query(h)
+        return '' unless h.is_a?(Hash)
+
+        result = []
+
+        h.each { |k, v| result.push(k.to_s + '=' + v.to_s) }
+        result.sort.join('&')
+      end
+
+      ##
+      # sanitize_sql
+      #
+      # Remove query literals from SQL. Used by all
+      # DB adapter instrumentation.
+      #
+      # The regular expression passed to String.gsub is configurable
+      # via SolarWindsAPM::Config[:sanitize_sql_regexp] and
+      # SolarWindsAPM::Config[:sanitize_sql_opts].
+      #
+      def sanitize_sql(sql)
+        return sql unless SolarWindsAPM::Config[:sanitize_sql]
+
+        @@regexp ||= Regexp.new(SolarWindsAPM::Config[:sanitize_sql_regexp], SolarWindsAPM::Config[:sanitize_sql_opts]).freeze
+        sql.gsub(/\\\'/,'').gsub(@@regexp, '?')
+      end
+
+      ##
+      # remove_traceparent
+      #
+      # Remove trace context injection
+      #
+      def remove_traceparent(sql)
+        sql.gsub(SolarWindsAPM::SDK::CurrentTraceInfo::TraceInfo::SQL_REGEX, '')
+      end
+
+      ##
+      # deep_dup
+      #
+      # deep duplicate of array or hash
+      #
+      def deep_dup(obj)
+        if obj.is_a? Array
+          new_obj = []
+          obj.each do |v|
+            new_obj << deep_dup(v)
+          end
+        elsif obj.is_a? Hash
+          new_obj = {}
+          obj.each_pair do |key, value|
+            new_obj[key] = deep_dup(value)
+          end
+        end
+      end
+
+      ##
+      # legacy_build_init_report
+      #
+      # Internal: Build a hash of KVs that reports on the status of the
+      # running environment.  This is used on stack boot in __Init reporting
+      # and for SolarWindsAPM.support_report.
+      #
+      # This legacy version of build_init_report is used for apps without Bundler.
+      #
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
+      #
+      # @deprecated Please use {#build_init_report} instead
+      def legacy_build_init_report
+        SolarWindsAPM.logger.warn '[solarwinds_apm/deprecated] Oboe::API will be deprecated in a future version.'
+        platform_info = {}
+
+        begin
+          # Report the framework in use
+          if defined?(::RailsLts::VERSION)
+            platform_info['Ruby.RailsLts.Version']  = "RailsLts-#{::RailsLts::VERSION}"
+          elsif defined?(::Rails.version)
+            platform_info['Ruby.Rails.Version']     = "Rails-#{::Rails.version}"
+          end
+          platform_info['Ruby.Grape.Version']       = "Grape-#{::Grape::VERSION}" if defined?(::Grape::VERSION)
+          platform_info['Ruby.Cramp.Version']       = "Cramp-#{::Cramp::VERSION}" if defined?(::Cramp::VERSION)
+
+          if defined?(::Padrino::VERSION)
+            platform_info['Ruby.Padrino.Version']   = "Padrino-#{::Padrino::VERSION}"
+          elsif defined?(::Sinatra::VERSION)
+            platform_info['Ruby.Sinatra.Version']   = "Sinatra-#{::Sinatra::VERSION}"
+          end
+
+          # Report the instrumented libraries
+          platform_info['Ruby.Curb.Version']       = "Curb-#{::Curl::VERSION}"             if defined?(::Curl::VERSION)
+          platform_info['Ruby.Dalli.Version']      = "Dalli-#{::Dalli::VERSION}"           if defined?(::Dalli::VERSION)
+          platform_info['Ruby.Excon.Version']      = "Excon-#{::Excon::VERSION}"           if defined?(::Excon::VERSION)
+          platform_info['Ruby.Faraday.Version']    = "Faraday-#{::Faraday::VERSION}"       if defined?(::Faraday::VERSION)
+          platform_info['Ruby.HTTPClient.Version'] = "HTTPClient-#{::HTTPClient::VERSION}" if defined?(::HTTPClient::VERSION)
+          platform_info['Ruby.Memcached.Version']  = "Memcached-#{::Memcached::VERSION}"   if defined?(::Memcached::VERSION)
+          platform_info['Ruby.Moped.Version']      = "Moped-#{::Moped::VERSION}"           if defined?(::Moped::VERSION)
+          platform_info['Ruby.Redis.Version']      = "Redis-#{::Redis::VERSION}"           if defined?(::Redis::VERSION)
+          platform_info['Ruby.Resque.Version']     = "Resque-#{::Resque::VERSION}"         if defined?(::Resque::VERSION)
+          platform_info['Ruby.RestClient.Version'] = "RestClient-#{::RestClient::VERSION}" if defined?(::RestClient::VERSION)
+          platform_info['Ruby.Sidekiq.Version']    = "Sidekiq-#{::Sidekiq::VERSION}"       if defined?(::Sidekiq::VERSION)
+          platform_info['Ruby.Typhoeus.Version']   = "Typhoeus-#{::Typhoeus::VERSION}"     if defined?(::Typhoeus::VERSION)
+
+          if Gem.loaded_specs.key?('delayed_job')
+            # Oddly, DelayedJob doesn't have an embedded version number so we get it from the loaded
+            # gem specs.
+            version = Gem.loaded_specs['delayed_job'].version.to_s
+            platform_info['Ruby.DelayedJob.Version']       = "DelayedJob-#{version}"
+          end
+
+          # Special case since the Mongo 1.x driver doesn't embed the version number in the gem directly
+          if ::Gem.loaded_specs.key?('mongo')
+            platform_info['Ruby.Mongo.Version']     = "Mongo-#{::Gem.loaded_specs['mongo'].version}"
+          end
+
+          # Report the DB adapter in use
+          platform_info['Ruby.Mysql.Version']   = Mysql::GemVersion::VERSION   if defined?(Mysql::GemVersion::VERSION)
+          platform_info['Ruby.PG.Version']      = PG::VERSION                  if defined?(PG::VERSION)
+          platform_info['Ruby.Mysql2.Version']  = Mysql2::VERSION              if defined?(Mysql2::VERSION)
+          platform_info['Ruby.Sequel.Version']  = ::Sequel::VERSION            if defined?(::Sequel::VERSION)
+        rescue StandardError, ScriptError => e
+          # Also rescue ScriptError (aka SyntaxError) in case one of the expected
+          # version defines don't exist
+
+          platform_info['Error'] = "Error in legacy_build_init_report: #{e.message}"
+
+          SolarWindsAPM.logger.warn "[solarwinds_apm/legacy] Error in legacy_build_init_report: #{e.message}"
+          SolarWindsAPM.logger.debug e.backtrace
+        end
+        platform_info
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
+
+      ##
+      #  build_init_report
+      #
+      # Internal: Build a hash of KVs that reports on the status of the
+      # running environment.  This is used on stack boot in __Init reporting
+      # and for SolarWindsAPM.support_report.
+      #
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
+      def build_init_report
+        platform_info = { '__Init' => 1 }
+
+        begin
+          platform_info['Force']                        = true
+          platform_info['Ruby.Platform.Version']        = RUBY_PLATFORM
+          platform_info['Ruby.Version']                 = RUBY_VERSION
+          platform_info['Ruby.SolarWindsAPM.Version']       = SolarWindsAPM::Version::STRING
+
+          # oboe not loaded yet, can't use oboe_api function to read oboe VERSION
+          clib_version_file = File.join(Gem::Specification.find_by_name('solarwinds_apm').gem_dir, 'ext', 'oboe_metal', 'src', 'VERSION')
+          platform_info['Ruby.SolarWindsAPMExtension.Version'] = File.read(clib_version_file).strip
+          platform_info['RubyHeroku.SolarWindsAPM.Version'] = SolarWindsAPMHeroku::Version::STRING if defined?(SolarWindsAPMHeroku)
+          platform_info['Ruby.TraceMode.Version']          = SolarWindsAPM::Config[:tracing_mode]
+
+          # Collect up the loaded gems
+          if defined?(Gem) && Gem.respond_to?(:loaded_specs)
+            Gem.loaded_specs.each_pair { |k, v|
+              platform_info["Ruby.#{k}.Version"] = v.version.to_s
+            }
+          else
+            platform_info.merge!(legacy_build_init_report)
+          end
+
+          # Report the server in use (if possible)
+          if defined?(::Unicorn::Const::UNICORN_VERSION)
+            platform_info['Ruby.AppContainer.Version'] = "Unicorn-#{::Unicorn::Const::UNICORN_VERSION}"
+          elsif defined?(::Puma::Const::PUMA_VERSION)
+            platform_info['Ruby.AppContainer.Version'] = "Puma-#{::Puma::Const::PUMA_VERSION} (#{::Puma::Const::CODE_NAME})"
+          elsif defined?(::PhusionPassenger::PACKAGE_NAME)
+            platform_info['Ruby.AppContainer.Version'] = "#{::PhusionPassenger::PACKAGE_NAME}-#{::PhusionPassenger::VERSION_STRING}"
+          elsif defined?(::Thin::VERSION::STRING)
+            platform_info['Ruby.AppContainer.Version'] = "Thin-#{::Thin::VERSION::STRING} (#{::Thin::VERSION::CODENAME})"
+          elsif defined?(::Mongrel::Const::MONGREL_VERSION)
+            platform_info['Ruby.AppContainer.Version'] = "Mongrel-#{::Mongrel::Const::MONGREL_VERSION}"
+          elsif defined?(::Mongrel2::VERSION)
+            platform_info['Ruby.AppContainer.Version'] = "Mongrel2-#{::Mongrel2::VERSION}"
+          elsif defined?(::Trinidad::VERSION)
+            platform_info['Ruby.AppContainer.Version'] = "Trinidad-#{::Trinidad::VERSION}"
+          elsif defined?(::WEBrick::VERSION)
+            platform_info['Ruby.AppContainer.Version'] = "WEBrick-#{::WEBrick::VERSION}"
+          else
+            platform_info['Ruby.AppContainer.Version'] = File.basename($PROGRAM_NAME)
+          end
+
+        rescue StandardError, ScriptError => e
+          # Also rescue ScriptError (aka SyntaxError) in case one of the expected
+          # version defines don't exist
+
+          platform_info['Error'] = "Error in build_report: #{e.message}"
+
+          SolarWindsAPM.logger.warn "[solarwinds_apm/warn] Error in build_init_report: #{e.message}"
+          SolarWindsAPM.logger.debug e.backtrace
+        end
+        platform_info
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
+    end
+  end
+end

data/lib/solarwinds_apm/version.rb

@@ -0,0 +1,17 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module SolarWindsAPM
+  ##
+  # The current version of the gem. Used mainly by
+  # solarwinds_apm.gemspec during gem build process
+  module Version
+    MAJOR  = 5 # breaking,
+    MINOR  = 0 # feature,
+    PATCH  = 0 # fix => BFF
+    PRE    = nil # for pre-releases into packagecloud,
+               # set to nil for production releases into rubygems
+
+    STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+  end
+end

data/lib/solarwinds_apm.rb

@@ -0,0 +1,72 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+begin
+  require 'openssl'
+  require 'solarwinds_apm/version'
+  require 'solarwinds_apm/thread_local'
+  require 'solarwinds_apm/logger'
+  require 'solarwinds_apm/util'
+  require 'solarwinds_apm/support_report'
+  require 'solarwinds_apm/base'
+  SolarWindsAPM.loaded = false
+
+  require 'solarwinds_apm/config'
+  SolarWindsAPM::Config.load_config_file
+
+  begin
+    if RUBY_PLATFORM =~ /linux/
+      require_relative './libsolarwinds_apm.so'
+      require 'solarwinds_apm/oboe_init_options'
+      require 'oboe_metal.rb'  # sets SolarWindsAPM.loaded = true if successful
+    else
+      SolarWindsAPM.logger.warn '==================================================================='
+      SolarWindsAPM.logger.warn "SolarWindsAPM warning: Platform #{RUBY_PLATFORM} not yet supported."
+      SolarWindsAPM.logger.warn 'see: https://documentation.solarwinds.com/en/success_center/observability/default.htm#cshid=config-ruby-agent'
+      SolarWindsAPM.logger.warn 'Tracing disabled.'
+      SolarWindsAPM.logger.warn 'Contact technicalsupport@solarwinds.com if this is unexpected.'
+      SolarWindsAPM.logger.warn '==================================================================='
+    end
+  rescue LoadError => e
+    unless ENV['RAILS_GROUP'] == 'assets' or ENV['SW_APM_NO_LIBRARIES_WARNING']
+      SolarWindsAPM.logger.error '=============================================================='
+      SolarWindsAPM.logger.error 'Missing SolarWindsAPM libraries.  Tracing disabled.'
+      SolarWindsAPM.logger.error "Error: #{e.message}"
+      SolarWindsAPM.logger.error 'See: https://documentation.solarwinds.com/en/success_center/observability/default.htm#cshid=config-ruby-agent'
+      SolarWindsAPM.logger.error '=============================================================='
+    end
+  end
+
+  # solarwinds_apm/loading can set SolarWindsAPM.loaded = false if the service key is not working
+  require 'solarwinds_apm/loading'
+
+  if SolarWindsAPM.loaded
+    require 'solarwinds_apm/instrumentation'
+    require 'solarwinds_apm/support'
+
+    # Frameworks
+    require 'solarwinds_apm/frameworks/rails'
+    require 'solarwinds_apm/frameworks/sinatra'
+    require 'solarwinds_apm/frameworks/padrino'
+    require 'solarwinds_apm/frameworks/grape'
+  else
+    SolarWindsAPM.logger.warn '=============================================================='
+    SolarWindsAPM.logger.warn 'SolarWindsAPM not loaded. Tracing disabled.'
+    SolarWindsAPM.logger.warn 'There may be a problem with the service key or other settings.'
+    SolarWindsAPM.logger.warn 'Please check previous log messages.'
+    SolarWindsAPM.logger.warn '=============================================================='
+    require 'solarwinds_apm/noop/context'
+    require 'solarwinds_apm/noop/metadata'
+    require 'solarwinds_apm/noop/profiling'
+    require 'solarwinds_apm/support/trace_string'
+  end
+
+  # Load Ruby module last.  If there is no framework detected,
+  # it will load all of the Ruby instrumentation
+  require 'solarwinds_apm/ruby'
+
+  require 'solarwinds_apm/test' if ENV['SW_APM_GEM_TEST']
+rescue => e
+  $stderr.puts "[solarwinds_apm/error] Problem loading: #{e.inspect}"
+  $stderr.puts e.backtrace
+end

data/solarwinds_apm.gemspec

@@ -0,0 +1,52 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "solarwinds_apm/version"
+
+Gem::Specification.new do |s|
+  s.name = %q{solarwinds_apm}
+  s.version = SolarWindsAPM::Version::STRING
+  s.date = Time.now.strftime('%Y-%m-%d')
+
+  s.license = "Apache-2.0"
+
+  s.authors = ["Maia Engeli", "Peter Giacomo Lombardo", "Spiros Eliopoulos"]
+  s.email = %q{technicalsupport@solarwinds.com}
+  s.homepage = %q{https://cloud.solarwinds.com/}
+  s.summary = %q{SolarWindsAPM performance instrumentation gem for Ruby}
+  s.description = <<-EOF
+Automatic tracing and metrics for Ruby applications. Get started at cloud.solarwinds.com
+  EOF
+
+  s.metadata = {
+      'changelog_uri'     => 'https://github.com/appoptics/appoptics-apm-ruby/releases',
+      'documentation_uri' => 'https://documentation.solarwinds.com/en/success_center/observability/default.htm#cshid=config-ruby-agent',
+      'homepage_uri'      => 'https://cloud.solarwinds.com/',
+      'source_code_uri'   => 'https://github.com/appoptics/appoptics-apm-ruby',
+  }
+
+  s.extra_rdoc_files = ['LICENSE']
+  s.files = `git ls-files`.split("\n").reject { |f| f.match(%r{^(test|gemfiles)/}) }
+  s.files += ['ext/oboe_metal/src/oboe.h',
+              'ext/oboe_metal/src/oboe_api.cpp',
+              'ext/oboe_metal/src/oboe_api.hpp',
+              'ext/oboe_metal/src/oboe_debug.h',
+              'ext/oboe_metal/src/oboe_swig_wrap.cc',
+              'ext/oboe_metal/src/bson/bson.h',
+              'ext/oboe_metal/src/bson/platform_hacks.h',
+              'ext/oboe_metal/src/VERSION',
+              'ext/oboe_metal/lib/liboboe-1.0-alpine-x86_64.so.0.0.0.sha256',
+              'ext/oboe_metal/lib/liboboe-1.0-x86_64.so.0.0.0.sha256'
+             ]
+  s.files -= ['build_gem.sh',
+              'build_gem_upload_to_packagecloud.sh',
+              'Rakefile']
+
+  s.extensions = ['ext/oboe_metal/extconf.rb']
+
+  # this still gives a warning, would have to be pinned to a minor version
+  # but that is not necessary and may restrict other gems
+  s.add_runtime_dependency('json', '~> 2.0')
+  s.add_runtime_dependency('no_proxy_fix', '~> 0.1.2', '>= 0.1.2')
+
+  s.required_ruby_version = '>= 2.5.0'
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+end