appoptics_apm 4.0.2

data/lib/appoptics_apm/loading.rb

@@ -0,0 +1,66 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'digest/sha1'
+
+module AppOpticsAPM
+  module Util
+    ##
+    # This module was used solely for the deprecated RUM ID calculation
+    # but may be useful in the future.
+    #
+    module Base64URL
+      module_function
+
+      def encode(bin)
+        c = [bin].pack('m0').gsub(/\=+\Z/, '').tr('+/', '-_').rstrip
+        m = c.size % 4
+        c += '=' * (4 - m) if m != 0
+        c
+      end
+
+      def decode(bin)
+        m = bin.size % 4
+        bin += '=' * (4 - m) if m != 0
+        bin.tr('-_', '+/').unpack('m0').first
+      end
+    end
+  end
+
+  ##
+  # This module houses all of the loading functionality for the appoptics_apm gem.
+  #
+  # Note that this does not necessarily _have_ to include initialization routines
+  # (although it can).
+  #
+  # Actual initialization is often separated out as it can be dependent on on the state
+  # of the stack boot process.  e.g. code requiring that initializers, frameworks or
+  # instrumented libraries are already loaded...
+  #
+  module Loading
+    ##
+    # Load the appoptics_apm tracing API
+    #
+    def self.require_api
+      pattern = File.join(File.dirname(__FILE__), 'api', '*.rb')
+      Dir.glob(pattern) do |f|
+        require f
+      end
+      require 'appoptics_apm/api'
+
+      begin
+        AppOpticsAPM::API.extend_with_tracing
+      rescue LoadError => e
+        AppOpticsAPM.logger.fatal "[appoptics_apm/error] Couldn't load api: #{e.message}"
+      end
+    end
+  end
+end
+
+AppOpticsAPM::Loading.require_api
+
+# Auto-start the Reporter unless we running Unicorn on Heroku
+# In that case, we start the reporters after fork
+unless AppOpticsAPM.heroku? && AppOpticsAPM.forking_webserver?
+  AppOpticsAPM::Reporter.start if AppOpticsAPM.loaded
+end

data/lib/appoptics_apm/logger.rb

@@ -0,0 +1,41 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'logger'
+
+module AppOpticsAPM
+  class << self
+    attr_accessor :logger
+  end
+
+  class Logger
+    # Fatal message
+    def fatal(string, exception = nil)
+      AppOpticsAPM.logger.fatal(string) if AppOpticsAPM.logger
+    end
+
+    # Error message
+    def error(msg, exception = nil)
+      AppOpticsAPM.logger.error(string) if AppOpticsAPM.logger
+    end
+
+    # Warn message
+    def warn(msg, exception = nil)
+      AppOpticsAPM.logger.warn(string) if AppOpticsAPM.logger
+    end
+
+    # Info message
+    def info(msg, exception = nil)
+      AppOpticsAPM.logger.info(string) if AppOpticsAPM.logger
+    end
+
+    # Debug message
+    def debug(msg, exception = nil)
+      AppOpticsAPM.logger.debug(string) if AppOpticsAPM.logger
+    end
+
+  end
+end
+
+AppOpticsAPM.logger = Logger.new(STDERR)
+

data/lib/appoptics_apm/method_profiling.rb

@@ -0,0 +1,33 @@
+
+module AppOpticsAPM
+  module MethodProfiling
+    def profile_wrapper(method, report_kvs, opts, *args, &block)
+      report_kvs[:Backtrace] = AppOpticsAPM::API.backtrace(2) if opts[:backtrace]
+      report_kvs[:Arguments] = args if opts[:arguments]
+
+      # if this is a rails controller we want to set the transaction for the outbound metrics
+      if defined?(request) && defined?(request.env)
+        report_kvs['Controller'] = self.class.name
+        report_kvs['Action'] = self.action_name
+        request.env['appoptics_apm.controller'] = report_kvs['Controller']
+        request.env['appoptics_apm.action'] = report_kvs['Action']
+      end
+
+      AppOpticsAPM::API.log(nil, :profile_entry, report_kvs)
+
+      begin
+        rv = self.send(method, *args, &block)
+        report_kvs[:ReturnValue] = rv if opts[:result]
+        rv
+      rescue => e
+        AppOpticsAPM::API.log_exception(nil, e)
+        raise
+      ensure
+        report_kvs.delete(:Backtrace)
+        report_kvs.delete(:Controller)
+        report_kvs.delete(:Action)
+        AppOpticsAPM::API.log(nil, :profile_exit, report_kvs)
+      end
+    end
+  end
+end

data/lib/appoptics_apm/ruby.rb

@@ -0,0 +1,35 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  ##
+  # This module provides a method to manually initialize the
+  # Ruby instrumentation.  Normally this is done by detecting
+  # frameworks at load time and inserting initialization hooks.
+  module Ruby
+    class << self
+      def initialize
+        load
+      end
+
+      ##
+      # The core method to load Ruby instrumentation.  Call this
+      # from raw Ruby scripts or in Ruby applications where a
+      # supported framework isn't being used.  Supported frameworks
+      # will instead be detected at load time and initialization is
+      # automatic.
+      def load
+        # In case some apps call this manually, make sure
+        # that the gem is fully loaded and not in no-op
+        # mode (e.g. on unsupported platforms etc.)
+        if AppOpticsAPM.loaded
+          AppOpticsAPM::Inst.load_instrumentation
+        end
+      end
+    end
+  end
+end
+
+if AppOpticsAPM.loaded && !AppOpticsAPM.framework?
+  ::AppOpticsAPM::Ruby.load
+end

data/lib/appoptics_apm/support.rb

@@ -0,0 +1,135 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'rbconfig'
+require 'logger'
+
+module AppOpticsAPM
+  ##
+  # This module is used to debug problematic setups and/or environments.
+  # Depending on the environment, output may be to stdout or the framework
+  # log file (e.g. log/production.log)
+
+  ##
+  # yesno
+  #
+  # Utility method to translate value/nil to "yes"/"no" strings
+  def self.yesno(x)
+    x ? 'yes' : 'no'
+  end
+
+  # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
+  def self.support_report
+    @logger_level = AppOpticsAPM.logger.level
+    AppOpticsAPM.logger.level = ::Logger::DEBUG
+
+    AppOpticsAPM.logger.warn '********************************************************'
+    AppOpticsAPM.logger.warn '* BEGIN AppOpticsAPM Support Report'
+    AppOpticsAPM.logger.warn '*   Please email the output of this report to support@appoptics.com'
+    AppOpticsAPM.logger.warn '********************************************************'
+    AppOpticsAPM.logger.warn "Ruby: #{RUBY_DESCRIPTION}"
+    AppOpticsAPM.logger.warn "$0: #{$0}"
+    AppOpticsAPM.logger.warn "$1: #{$1}" unless $1.nil?
+    AppOpticsAPM.logger.warn "$2: #{$2}" unless $2.nil?
+    AppOpticsAPM.logger.warn "$3: #{$3}" unless $3.nil?
+    AppOpticsAPM.logger.warn "$4: #{$4}" unless $4.nil?
+    AppOpticsAPM.logger.warn "AppOpticsAPM.loaded == #{AppOpticsAPM.loaded}"
+
+    using_jruby = defined?(JRUBY_VERSION)
+    AppOpticsAPM.logger.warn "Using JRuby?: #{yesno(using_jruby)}"
+    if using_jruby
+      AppOpticsAPM.logger.warn "Joboe Agent Status: #{Java::ComTracelyticsAgent::Agent.getStatus}"
+    end
+
+    on_heroku = AppOpticsAPM.heroku?
+    AppOpticsAPM.logger.warn "On Heroku?: #{yesno(on_heroku)}"
+    if on_heroku
+      AppOpticsAPM.logger.warn "APPOPTICS_URL: #{ENV['APPOPTICS_URL']}"
+    end
+
+    AppOpticsAPM.logger.warn "AppOpticsAPM::Ruby defined?: #{yesno(defined?(AppOpticsAPM::Ruby))}"
+    AppOpticsAPM.logger.warn "AppOpticsAPM.reporter: #{AppOpticsAPM.reporter}"
+
+    AppOpticsAPM.logger.warn '********************************************************'
+    AppOpticsAPM.logger.warn '* Frameworks'
+    AppOpticsAPM.logger.warn '********************************************************'
+
+    using_rails = defined?(::Rails)
+    AppOpticsAPM.logger.warn "Using Rails?: #{yesno(using_rails)}"
+    if using_rails
+      AppOpticsAPM.logger.warn "AppOpticsAPM::Rails loaded?: #{yesno(defined?(::AppOpticsAPM::Rails))}"
+      AppOpticsAPM.logger.warn "AppOpticsAPM::Rack middleware loaded?: #{yesno(::Rails.configuration.middleware.include? AppOpticsAPM::Rack)}"
+    end
+
+    using_sinatra = defined?(::Sinatra)
+    AppOpticsAPM.logger.warn "Using Sinatra?: #{yesno(using_sinatra)}"
+
+    using_padrino = defined?(::Padrino)
+    AppOpticsAPM.logger.warn "Using Padrino?: #{yesno(using_padrino)}"
+
+    using_grape = defined?(::Grape)
+    AppOpticsAPM.logger.warn "Using Grape?: #{yesno(using_grape)}"
+
+    AppOpticsAPM.logger.warn '********************************************************'
+    AppOpticsAPM.logger.warn '* ActiveRecord Adapter'
+    AppOpticsAPM.logger.warn '********************************************************'
+    if defined?(::ActiveRecord)
+      if defined?(::ActiveRecord::Base.connection.adapter_name)
+        AppOpticsAPM.logger.warn "ActiveRecord adapter: #{::ActiveRecord::Base.connection.adapter_name}"
+      end
+    else
+      AppOpticsAPM.logger.warn 'No ActiveRecord'
+    end
+
+    AppOpticsAPM.logger.warn '********************************************************'
+    AppOpticsAPM.logger.warn '* AppOpticsAPM Libraries'
+    AppOpticsAPM.logger.warn '********************************************************'
+    files = []
+    ['/usr/lib/liboboe*', '/usr/lib64/liboboe*'].each do |d|
+      files = Dir.glob(d)
+      break if !files.empty?
+    end
+    if files.empty?
+      AppOpticsAPM.logger.warn 'Error: No liboboe libs!'
+    else
+      files.each { |f|
+        AppOpticsAPM.logger.warn f
+      }
+    end
+
+    AppOpticsAPM.logger.warn '********************************************************'
+    AppOpticsAPM.logger.warn '* AppOpticsAPM::Config Values'
+    AppOpticsAPM.logger.warn '********************************************************'
+    AppOpticsAPM::Config.show.each { |k,v|
+      AppOpticsAPM.logger.warn "#{k}: #{v}"
+    }
+
+    AppOpticsAPM.logger.warn '********************************************************'
+    AppOpticsAPM.logger.warn '* OS, Platform + Env'
+    AppOpticsAPM.logger.warn '********************************************************'
+    AppOpticsAPM.logger.warn "host_os: " + RbConfig::CONFIG['host_os']
+    AppOpticsAPM.logger.warn "sitearch: " + RbConfig::CONFIG['sitearch']
+    AppOpticsAPM.logger.warn "arch: " + RbConfig::CONFIG['arch']
+    AppOpticsAPM.logger.warn RUBY_PLATFORM
+    AppOpticsAPM.logger.warn "RACK_ENV: #{ENV['RACK_ENV']}"
+    AppOpticsAPM.logger.warn "RAILS_ENV: #{ENV['RAILS_ENV']}" if using_rails
+
+    AppOpticsAPM.logger.warn '********************************************************'
+    AppOpticsAPM.logger.warn '* Raw __Init KVs'
+    AppOpticsAPM.logger.warn '********************************************************'
+    platform_info = AppOpticsAPM::Util.build_init_report
+    platform_info.each { |k,v|
+      AppOpticsAPM.logger.warn "#{k}: #{v}"
+    }
+
+    AppOpticsAPM.logger.warn '********************************************************'
+    AppOpticsAPM.logger.warn '* END AppOpticsAPM Support Report'
+    AppOpticsAPM.logger.warn '*   Support Email: support@appoptics.com'
+    AppOpticsAPM.logger.warn '*   Github: https://github.com/librato/ruby-appoptics'
+    AppOpticsAPM.logger.warn '********************************************************'
+
+    AppOpticsAPM.logger.level = @logger_level
+    nil
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
+end

data/lib/appoptics_apm/test.rb

@@ -0,0 +1,94 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  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 AppOpticsAPM::Test.gemfile?(:libraries)
+          # Load all of the test workers
+          pattern = File.join(File.dirname(__FILE__), '../../test/jobs/**/', '*.rb')
+          Dir.glob(pattern) do |f|
+            AppOpticsAPM.logger.debug "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/travis_ci_test"
+        elsif ENV.key?('DOCKER_PSQL_PASS')
+          ENV['DATABASE_URL'] = "postgresql://docker:#{ENV['DOCKER_PSQL_PASS']}@127.0.0.1:5432/travis_ci_test"
+        else
+          ENV['DATABASE_URL'] = 'postgresql://postgres@127.0.0.1:5432/travis_ci_test'
+        end
+      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/travis_ci_test"
+        elsif ENV.key?('DOCKER_MYSQL_PASS')
+          ENV['DATABASE_URL'] = "mysql://root:#{ENV['DOCKER_MYSQL_PASS']}@mysql:3306/travis_ci_test"
+        else
+          ENV['DATABASE_URL'] = 'mysql://root@127.0.0.1:3306/travis_ci_test'
+        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/travis_ci_test"
+        elsif ENV.key?('DOCKER_MYSQL_PASS')
+          ENV['DATABASE_URL'] = "mysql2://root:#{ENV['DOCKER_MYSQL_PASS']}@mysql:3306/travis_ci_test"
+        else
+          ENV['DATABASE_URL'] = 'mysql2://root@127.0.0.1:3306/travis_ci_test'
+        end
+      end
+    end
+  end
+end

data/lib/appoptics_apm/thread_local.rb

@@ -0,0 +1,26 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  ##
+  # Provides thread local storage for AppOpticsAPM.
+  #
+  # Example usage:
+  # module AppOpticsAPMBase
+  #   extend ::AppOpticsAPM::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