scout_apm 2.4.20 → 2.4.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3410254ae73b93df713b64fd10fc4e913e9ac8be
-  data.tar.gz: aa5bcf808cc4a7190d8d6597f1b1ae92fc0a77a3
+  metadata.gz: 7414d9bde0f829ed4cfc7975c5bdca2e5cda5910
+  data.tar.gz: 6a0ab71bfa23362adefb328f69a887bae5551b6b
 SHA512:
-  metadata.gz: d2144aa3b55a6ff69d22cdae53a88fb4eeb8d56040606ddf9cb4421cc6b802d7604004d04bcdd64242460c8c37174e730d118c632cf37a1965e4bf0a862b7a67
-  data.tar.gz: 2f79898f6ab830d10c8f6c783e987e47d2a8caa80d5e8b3ae98336372b4cec6abf8a1a9a70b2ac16800ce530ce04b318e3db783f1481fe5439c2a03e69e77584
+  metadata.gz: 99e1906e5273202785cbd6c75acc4a833887f1a27240e7763b16d7296d1b4ba30a080729b67214372de08170c06541869b94c0d825726822be305ab05d12651b
+  data.tar.gz: 8f44f8874f66b75ac8e1146678a7c91964661422b9e3386eccc0bca115269d9874403dc042cfc771da48552636a23e33c219a0648400615e8fbbf49027117b86

data/CHANGELOG.markdown

@@ -1,3 +1,10 @@
+# 2.4.21
+
+* App & Background Integrations only install when needed (#228)
+* New Setting `collect_remote_ip`, to optionally disable automated capture of
+  end-user IP Address. No change to default behavior.
+* Allow setting `compress_payload` option from ENV var (#234)
+
 # 2.4.20
 
 * `start_resque_server_instrument` option to allow disabling the WEBrick server

data/README.markdown

@@ -55,6 +55,12 @@ gem 'scout_apm'
 SCOUT_DEV_TRACE=true rails server
 ```
 
+## How to test gem locally
+
+* Point your gemfile at your local checkout: `gem 'scout_apm', path: '/path/to/scout_apm_ruby`
+* Compile native code: `cd /path/to/scout_apm_ruby && bundle exec rake compile`
+
+
 ## Docs
 
 For the complete list of supported frameworks, Rubies, configuration options

data/lib/scout_apm/agent.rb

@@ -37,10 +37,13 @@ module ScoutApm
 
       logger.info "Scout Agent [#{ScoutApm::VERSION}] Initialized"
 
-      instrument_manager.install! if should_load_instruments? || force
-
-      install_background_job_integrations
-      install_app_server_integration
+      if should_load_instruments? || force
+        instrument_manager.install!
+        install_background_job_integrations
+        install_app_server_integration
+      else
+        logger.info "Not Loading Instruments"
+      end
 
       logger.info "Scout Agent [#{ScoutApm::VERSION}] Installed"
 

data/lib/scout_apm/config.rb

@@ -10,6 +10,7 @@ require 'scout_apm/environment'
 # customer-focused documentation.
 #
 # application_root - override the detected directory of the application
+# collect_remote_ip - automatically capture user's IP into a Trace's Context
 # compress_payload - true/false to enable gzipping of payload
 # data_file        - override the default temporary storage location. Must be a location in a writable directory
 # dev_trace        - true or false. Enables always-on tracing in development environmen only
@@ -40,6 +41,7 @@ module ScoutApm
     KNOWN_CONFIG_OPTIONS = [
         'application_root',
         'async_recording',
+        'collect_remote_ip',
         'compress_payload',
         'config_file',
         'data_file',
@@ -151,13 +153,15 @@ module ScoutApm
 
 
     SETTING_COERCIONS = {
-      "async_recording"        => BooleanCoercion.new,
-      "detailed_middleware"    => BooleanCoercion.new,
-      "dev_trace"              => BooleanCoercion.new,
-      "enable_background_jobs" => BooleanCoercion.new,
-      "ignore"                 => JsonCoercion.new,
-      "max_traces"             => IntegerCoercion.new,
-      "monitor"                => BooleanCoercion.new,
+      'async_recording' => BooleanCoercion.new,
+      'detailed_middleware' => BooleanCoercion.new,
+      'dev_trace' => BooleanCoercion.new,
+      'enable_background_jobs' => BooleanCoercion.new,
+      'ignore' => JsonCoercion.new,
+      'max_traces' => IntegerCoercion.new,
+      'monitor' => BooleanCoercion.new,
+      'collect_remote_ip' => BooleanCoercion.new,
+      'compress_payload' => BooleanCoercion.new,
       'database_metric_limit'  => IntegerCoercion.new,
       'database_metric_report_limit' => IntegerCoercion.new,
       'instrument_http_url_length' => IntegerCoercion.new,
@@ -268,6 +272,7 @@ module ScoutApm
         'database_metric_report_limit' => 1000,
         'instrument_http_url_length' => 300,
         'start_resque_server_instrument' => true, # still only starts if Resque is detected
+        'collect_remote_ip' => true,
       }.freeze
 
       def value(key)

data/lib/scout_apm/instruments/action_controller_rails_2.rb

@@ -54,7 +54,9 @@ module ScoutApm
       def perform_action_with_scout_instruments(*args, &block)
         req = ScoutApm::RequestManager.lookup
         req.annotate_request(:uri => request.path) # for security by-default, we don't use request.fullpath which could reveal filtered params.
-        req.context.add_user(:ip => request.remote_ip)
+        if ScoutApm::Agent.instance.context.config.value('collect_remote_ip')
+          req.context.add_user(:ip => request.remote_ip)
+        end
         req.set_headers(request.headers)
         req.start_layer( ScoutApm::Layer.new("Controller", "#{controller_path}/#{action_name}") )
 

data/lib/scout_apm/instruments/action_controller_rails_3_rails4.rb

@@ -60,10 +60,11 @@ module ScoutApm
           def process_action(*args)
             req = ScoutApm::RequestManager.lookup
             current_layer = req.current_layer
+            agent_context = ScoutApm::Agent.instance.context
 
             # Check if this this request is to be reported instantly
             if instant_key = request.cookies['scoutapminstant']
-              ScoutApm::Agent.instance.context.logger.info "Instant trace request with key=#{instant_key} for path=#{path}"
+              agent_context.logger.info "Instant trace request with key=#{instant_key} for path=#{path}"
               req.instant_key = instant_key
             end
 
@@ -74,7 +75,9 @@ module ScoutApm
               req.annotate_request(:uri => ScoutApm::Instruments::ActionControllerRails3Rails4.scout_transaction_uri(request))
 
               # IP Spoofing Protection can throw an exception, just move on w/o remote ip
-              req.context.add_user(:ip => request.remote_ip) rescue nil
+              if agent_context.config.value('collect_remote_ip')
+                req.context.add_user(:ip => request.remote_ip) rescue nil
+              end
               req.set_headers(request.headers)
 
               resolved_name = scout_action_name(*args)

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "2.4.20"
+  VERSION = "2.4.21"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.4.20
+  version: 2.4.21
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-22 00:00:00.000000000 Z
+date: 2018-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest