scout_apm 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36adf5a7555ede28d15fa10c9998f5f0bb033a68
-  data.tar.gz: 669e743655d365c1ffbe9f6f286386f374784a50
+  metadata.gz: b13f09a100d1842c8aa30d4b494907796b30dac4
+  data.tar.gz: 94b7e8b9ce5bc0a884db7df223728fda3d475dd6
 SHA512:
-  metadata.gz: 01b264703cdaa45a38dd705afec5726211b2a1c23e575c4a0fb0a9f86edbb738cd6aecbaf99e0a828da217abdc5df22850195954e11fd2f9dde7514730e13497
-  data.tar.gz: bc2f83e3448c141529e24ffd7acaa774ea884665aedcc88879830bd99486225d88f5ed2b099db667ba056dfbf9acb7b86381fe972de6f55865c89899b2724888
+  metadata.gz: 2692fa9370afc2fd71ae1c8a6985a535174ce0607b048dc5ceb653149b3fb2dfe2fdf2411f25f36f58f3bbfa46fa49bb79cf0fa929e74d4d6028596c3ebfafad
+  data.tar.gz: 5529282c94ea75dbfb6f6c7bab6b12634880f6e8942452a510db90d9eac09857f8843d1658c1d252c4eab1b3bad5463aca69113a13f2a28eed60f68a35d61f30

data/CHANGELOG.markdown

@@ -1,3 +1,14 @@
+# 0.1.10
+
+* Prevent instrumentation in non-web contexts. Prevents agent running in rails
+  console, sidekiq, and similar contexts.
+* Send active Gems with App Load message
+
+# 0.1.9
+
+* Added environment (production, development, etc) to App Load message
+* Bugfix in Reporter class
+
 # 0.1.8
 
 * Ping APM on Application Load

data/lib/scout_apm.rb

@@ -28,6 +28,7 @@ require 'scout_apm/app_server_load'
 
 require 'scout_apm/utils/sql_sanitizer'
 require 'scout_apm/utils/null_logger'
+require 'scout_apm/utils/installed_gems'
 require 'scout_apm/config'
 require 'scout_apm/environment'
 require 'scout_apm/agent'

data/lib/scout_apm/agent.rb

@@ -52,12 +52,12 @@ module ScoutApm
         return false
       end
 
-      if !Environment.instance.application_name
-        logger.warn "An application name is required. Specify the :name value in scout_apm.yml. Not starting agent."
+      if !environment.application_name
+        logger.warn "An application name could not be determined. Specify the :name value in scout_apm.yml. Not starting agent."
         return false
       end
 
-      if !environment.app_server
+      if !environment.app_server_integration.found?
         logger.warn "Couldn't find a supported app server. Not starting agent."
         return false
       end
@@ -83,7 +83,8 @@ module ScoutApm
 
       logger.info "Starting monitoring for [#{environment.application_name}]. Framework [#{environment.framework}] App Server [#{environment.app_server}]."
 
-      load_instruments
+      load_instruments if should_load_instruments?
+
       @samplers = [
         ScoutApm::Instruments::Process::ProcessCpu.new(environment.processors, logger),
         ScoutApm::Instruments::Process::ProcessMemory.new(logger)
@@ -168,9 +169,14 @@ module ScoutApm
       logger.debug "Done creating worker thread."
     end
 
+    def should_load_instruments?
+      environment.app_server_integration.found?
+    end
+
     # Loads the instrumention logic.
     def load_instruments
       logger.debug "Installing instrumentation"
+
       case environment.framework
       when :rails
         require File.expand_path(File.join(File.dirname(__FILE__),'instruments/rails/action_controller_instruments.rb'))

data/lib/scout_apm/app_server_load.rb

@@ -24,6 +24,7 @@ module ScoutApm
         :hostname           => ScoutApm::Environment.instance.hostname,
         :database_engine    => ScoutApm::Environment.instance.database_engine,
         :application_name   => ScoutApm::Environment.instance.application_name,
+        :libraries          => ScoutApm::Utils::InstalledGems.new.run,
       }
     end
   end

data/lib/scout_apm/context.rb

@@ -3,103 +3,104 @@
 # There are 2 types of context: User and Extra.
 # For user-specific context, use @Context#add_user@.
 # For misc context, use @Context#add@.
-class ScoutApm::Context
+module ScoutApm
+  class Context
+    def initialize
+      @extra = {}
+      @user = {}
+    end
 
-  def initialize
-    @extra = {}
-    @user = {}
-  end
+    # Generates a hash representation of the Context.
+    # Example: {:monthly_spend => 100, :user => {:ip => '127.0.0.1'}}
+    def to_hash
+      @extra.merge({:user => @user})
+    end
 
-  # Generates a hash representation of the Context.
-  # Example: {:monthly_spend => 100, :user => {:ip => '127.0.0.1'}}
-  def to_hash
-    @extra.merge({:user => @user})
-  end
+    def self.current
+      Thread.current[:scout_context] ||= new
+    end
 
-  def self.current
-    Thread.current[:scout_context] ||= new
-  end
+    def self.clear!
+      Thread.current[:scout_context] = nil
+    end
 
-  def self.clear!
-    Thread.current[:scout_context] = nil
-  end
+    # Add context
+    # ScoutApm::Context.add(account: current_account.name)
+    def add(hash)
+      update_context(:extra,hash)
+    end
 
-  # Add context
-  # ScoutApm::Context.add(account: current_account.name)
-  def add(hash)
-    update_context(:extra,hash)
-  end
+    def add_user(hash)
+      update_context(:user,hash)
+    end
 
-  def add_user(hash)
-    update_context(:user,hash)
-  end
+    # Convenience accessor so you can just call @ScoutAPM::Context#add@
+    def self.add(hash)
+      self.current.add(hash)
+    end
 
-  # Convenience accessor so you can just call @ScoutAPM::Context#add@
-  def self.add(hash)
-    self.current.add(hash)
-  end
+    # Convenience accessor so you can just call @ScoutAPM::Context#add_user@
+    def self.add_user(hash)
+      self.current.add_user(hash)
+    end
 
-  # Convenience accessor so you can just call @ScoutAPM::Context#add_user@
-  def self.add_user(hash)
-    self.current.add_user(hash)
-  end
+    private
 
-  private
+    def update_context(attr,hash)
+      valid_hash = Hash.new
+      # iterate over the hash of new context, adding to the valid_hash if validation checks pass.
+      hash.each do |key,value|
+        # does both checks so we can get logging info on the value even if the key is invalid.
+        key_valid = key_valid?({key => value})
+        value_valid = value_valid?({key => value})
+        if key_valid and value_valid
+          valid_hash[key] = value
+        end
+      end
 
-  def update_context(attr,hash)
-    valid_hash = Hash.new
-    # iterate over the hash of new context, adding to the valid_hash if validation checks pass.
-    hash.each do |key,value|
-      # does both checks so we can get logging info on the value even if the key is invalid.
-      key_valid = key_valid?({key => value})
-      value_valid = value_valid?({key => value})
-      if key_valid and value_valid
-        valid_hash[key] = value
+      if valid_hash.any?
+        instance_variable_get("@#{attr.to_s}").merge!(valid_hash)
       end
     end
 
-    if valid_hash.any?
-      instance_variable_get("@#{attr.to_s}").merge!(valid_hash)
+    # Returns true if the obj is one of the provided valid classes.
+    def valid_type?(classes, obj)
+      valid_type = false
+      classes.each do |klass|
+        if obj.is_a?(klass)
+          valid_type = true
+          break
+        end
+      end
+      valid_type
     end
-  end
 
-  # Returns true if the obj is one of the provided valid classes.
-  def valid_type?(classes, obj)
-    valid_type = false
-    classes.each do |klass|
-      if obj.is_a?(klass)
-        valid_type = true
-        break
+    # take the entire Hash vs. just the value so the logger output is more helpful on error.
+    def value_valid?(key_value)
+      # ensure one of our accepted types.
+      value = key_value.values.last
+      if !valid_type?([String, Symbol, Numeric, Time, Date, TrueClass, FalseClass],value)
+        ScoutApm::Agent.instance.logger.warn "The value for [#{key_value.keys.first}] is not a valid type [#{value.class}]."
+      false
+      else
+        true
       end
     end
-    valid_type
-  end
 
-  # take the entire Hash vs. just the value so the logger output is more helpful on error.
-  def value_valid?(key_value)
-    # ensure one of our accepted types.
-    value = key_value.values.last
-    if !valid_type?([String, Symbol, Numeric, Time, Date, TrueClass, FalseClass],value)
-      ScoutApm::Agent.instance.logger.warn "The value for [#{key_value.keys.first}] is not a valid type [#{value.class}]."
-     false
-    else
+    # for consistently with #value_valid?, takes a hash eventhough the value isn't yet used.
+    def key_valid?(key_value)
+      key = key_value.keys.first
+      # ensure a string or a symbol
+      if !valid_type?([String, Symbol],key)
+        ScoutApm::Agent.instance.logger.warn "The key [#{key}] is not a valid type [#{key.class}]."
+        return false
+      end
+      # only alphanumeric, dash, and underscore allowed.
+      if key.to_s.match(/[^\w-]/)
+        ScoutApm::Agent.instance.logger.warn "They key name [#{key}] is not valid."
+        return false
+      end
       true
     end
   end
-
-  # for consistently with #value_valid?, takes a hash eventhough the value isn't yet used.
-  def key_valid?(key_value)
-    key = key_value.keys.first
-    # ensure a string or a symbol
-    if !valid_type?([String, Symbol],key)
-      ScoutApm::Agent.instance.logger.warn "The key [#{key}] is not a valid type [#{key.class}]."
-      return false
-    end
-    # only alphanumeric, dash, and underscore allowed.
-    if key.to_s.match(/[^\w-]/)
-      ScoutApm::Agent.instance.logger.warn "They key name [#{key}] is not valid."
-      return false
-    end
-    true
-  end
 end

data/lib/scout_apm/environment.rb

@@ -47,9 +47,10 @@ module ScoutApm
         config = ActiveRecord::Base.connection_config
         if config && config[:adapter]
           case config[:adapter]
-          when "postgres" then :postgres
-          when "sqlite3"  then :sqlite
-          when "mysql"    then :mysql
+          when "postgres"   then :postgres
+          when "postgresql" then :postgres
+          when "sqlite3"    then :sqlite
+          when "mysql"      then :mysql
           else default
           end
         else

data/lib/scout_apm/server_integrations/null.rb

@@ -25,6 +25,10 @@ module ScoutApm
       def forking?
         false
       end
+
+      def found?
+        false
+      end
     end
   end
 end

data/lib/scout_apm/server_integrations/passenger.rb

@@ -30,6 +30,10 @@ module ScoutApm
           ScoutApm::Agent.instance.shutdown
         end
       end
+
+      def found?
+        true
+      end
     end
   end
 end

data/lib/scout_apm/server_integrations/puma.rb

@@ -25,6 +25,10 @@ module ScoutApm
       rescue
         logger.warn "Unable to install Puma worker loop: #{$!.message}"
       end
+
+      def found?
+        true
+      end
     end
   end
 end

data/lib/scout_apm/server_integrations/rainbows.rb

@@ -31,6 +31,10 @@ module ScoutApm
           end
         end
       end
+
+      def found?
+        true
+      end
     end
   end
 end

data/lib/scout_apm/server_integrations/thin.rb

@@ -35,6 +35,10 @@ module ScoutApm
       # TODO: What does it mean to install on a non-forking env?
       def install
       end
+
+      def found?
+        true
+      end
     end
   end
 end

data/lib/scout_apm/server_integrations/unicorn.rb

@@ -30,6 +30,10 @@ module ScoutApm
           end
         end
       end
+
+      def found?
+        true
+      end
     end
   end
 end

data/lib/scout_apm/server_integrations/webrick.rb

@@ -20,6 +20,10 @@ module ScoutApm
       # TODO: What does it mean to install on a non-forking env?
       def install
       end
+
+      def found?
+        true
+      end
     end
   end
 end

data/lib/scout_apm/utils/installed_gems.rb

@@ -0,0 +1,18 @@
+module ScoutApm
+  module Utils
+    class InstalledGems
+      attr_reader :logger
+
+      def initialize(logger=ScoutApm::Agent.instance.logger)
+        @logger = logger
+      end
+
+      def run
+        Bundler.rubygems.all_specs.map {|spec| [spec.name, spec.version.to_s] }
+      rescue => e
+        logger.warn("Couldn't fetch Gem information: #{e.message}")
+        []
+      end
+    end
+  end
+end

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "0.1.9"
+  VERSION = "0.1.10"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-27 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -107,6 +107,7 @@ files:
 - lib/scout_apm/stack_item.rb
 - lib/scout_apm/store.rb
 - lib/scout_apm/tracer.rb
+- lib/scout_apm/utils/installed_gems.rb
 - lib/scout_apm/utils/null_logger.rb
 - lib/scout_apm/utils/sql_sanitizer.rb
 - lib/scout_apm/utils/sql_sanitizer_regex.rb