right_agent 2.3.1 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d22fd938943f06f9b04001c14079c25e7724671d
-  data.tar.gz: 843eb9bf0b111a56dc763aa0cabb3f895d328b17
+  metadata.gz: 417ec9216dbf120ff9b65b4cc81f89ba85bbd2b6
+  data.tar.gz: eb8a6033c5fb7265037a5976f824ad9116ebc8ec
 SHA512:
-  metadata.gz: 727ddf697ab2329655a70636475d2698c28c4cfbf2f6665d552d43fe812ec894b262ddc0a3d621f15585d701d3c7ec6961e22cb7aedb38f737a9fa3cf59fe485
-  data.tar.gz: 40e8e9422e00f2d0fab4613853daf4ec1a8b915c103496c1249486f22267acab47ac3a2e248b0ec96f13ef670647a3eb0613b561c7a3a26de00aadf4fbe891f2
+  metadata.gz: 2de8f5d35bdb742e5805ff880085f847a7f416f29e1c251f202acb38d7dddcc6800f14430d6b25e52fd5efc1c195d74acb127c3e2e7b9282ce61703759bde348
+  data.tar.gz: 7b7234d5af8cb3fb0bb48289cfe4e9d2f35b2561936fc1e0f341aa56b1ab26869a2f39caf0f58b49e9a8cef7d27e3fb6284d3635390432b8e6b27169d1d4178d

data/lib/right_agent/error_tracker.rb

@@ -19,6 +19,9 @@ module RightScale
 
     include RightSupport::Ruby::EasySingleton
 
+    # Text used for filtered parameter value
+    FILTERED_PARAM_VALUE = "<hidden>"
+
     # Container for exception statistics
     attr_reader :exception_stats
 
@@ -32,6 +35,8 @@ module RightScale
     #   with exception class as key and :no_trace, :caller, or :trace as value; exceptions
     #   with :no_trace are not backtraced when logging nor are they recorded in stats
     #   or reported to Errbit
+    # @option options [Array<Symbol, String>] :filter_params names whose values are to be
+    #   filtered when notifying
     # @option options [String] :airbrake_endpoint URL for Airbrake for reporting exceptions
     #   to Errbit
     # @option options [String] :airbrake_api_key for using the Airbrake API to access Errbit
@@ -40,7 +45,7 @@ module RightScale
     def init(agent, agent_name, options = {})
       @agent = agent
       @trace_level = options[:trace_level] || {}
-      notify_init(agent_name, options[:shard_id], options[:airbrake_endpoint], options[:airbrake_api_key])
+      notify_init(agent_name, options)
       reset_stats
       true
     end
@@ -113,14 +118,17 @@ module RightScale
         data[:component] = component if component
         if packet && packet.is_a?(Packet)
           data[:action] = packet.type.split("/").last if packet.respond_to?(:type)
-          data[:parameters] = packet.payload if packet.respond_to?(:payload)
-          uuid = packet.token if packet.respond_to?(:token)
+          params = packet.respond_to?(:payload) && packet.payload
+          uuid = packet.respond_to?(:token) && packet.token
         elsif packet.is_a?(Hash)
           action = packet[:path] || packet["path"]
           data[:action] = action.split("/").last if action
-          data[:parameters] = packet[:data] || packet["data"]
+          params = packet[:data] || packet["data"]
           uuid = packet[:uuid] || packet["uuid"]
+        else
+          params = uuid = nil
         end
+        data[:parameters] = params.is_a?(Hash) ? filter(params) : {:param => params} if params
         data[:session_data] = {:uuid => uuid} if uuid
         HydraulicBrake.notify(data)
       end
@@ -163,44 +171,60 @@ module RightScale
     # Configure HydraulicBreak for exception notification
     #
     # @param [String] agent_name uniquely identifying agent process on given server
-    # @param [Integer, NilClass] shard_id identifying shard of database in use
-    # @param [String] endpoint URL for Airbrake for reporting exceptions to Errbit
-    # @param [String] api_key for using the Airbrake API to access Errbit
+    #
+    # @option options [Integer, NilClass] :shard_id identifying shard of database in use
+    # @option options [Array<Symbol, String>] :filter_params names whose values are to be
+    #   filtered when notifying
+    # @option options [String] :airbrake_endpoint URL for Airbrake for reporting exceptions
+    #   to Errbit
+    # @option options [String] :airbrake_api_key for using the Airbrake API to access Errbit
     #
     # @return [TrueClass] always true
     #
     # @raise [RuntimeError] hydraulic_brake gem missing
-    def notify_init(agent_name, shard_id, endpoint, api_key)
-      if endpoint && api_key
+    def notify_init(agent_name, options)
+      if options[:airbrake_endpoint] && options[:airbrake_api_key]
         unless require_succeeds?("hydraulic_brake")
           raise RuntimeError, "hydraulic_brake gem missing - required if airbrake options used in ErrorTracker"
         end
 
         @cgi_data = {
-          :shard_id   => shard_id,
           :process    => $0,
           :pid        => Process.pid,
           :agent_name => agent_name
         }
-        @cgi_data[:shard_id] = shard_id if shard_id
+        @cgi_data[:shard_id] = options[:shard_id] if options[:shard_id]
         @cgi_data[:sha] = CURRENT_SOURCE_SHA if defined?(CURRENT_SOURCE_SHA)
 
-        uri = URI.parse(endpoint)
+        uri = URI.parse(options[:airbrake_endpoint])
         HydraulicBrake.configure do |config|
           config.secure = (uri.scheme == "https")
           config.host = uri.host
           config.port = uri.port
-          config.api_key = api_key
+          config.api_key = options[:airbrake_api_key]
           config.project_root = AgentConfig.root_dir
         end
+        @filter_params = (options[:filter_params] || []).map { |p| p.to_s }
         @notify_enabled = true
       else
-        @cgi_data = {}
         @notify_enabled = false
       end
       true
     end
 
+    # Apply parameter filter
+    #
+    # @param [Hash] params to be filtered
+    #
+    # @return [Hash] filtered parameters
+    def filter(params)
+      if @filter_params
+        filtered_params = {}
+        params.each { |k, p| filtered_params[k] = @filter_params.include?(k.to_s) ? FILTERED_PARAM_VALUE : p }
+        filtered_params
+      end
+    end
+
   end # ErrorTracker
 
 end # RightScale

data/right_agent.gemspec

@@ -25,8 +25,8 @@ require 'rbconfig'
 
 Gem::Specification.new do |spec|
   spec.name      = 'right_agent'
-  spec.version   = '2.3.1'
-  spec.date      = '2014-06-12'
+  spec.version   = '2.3.2'
+  spec.date      = '2014-06-18'
   spec.authors   = ['Lee Kirchhoff', 'Raphael Simon', 'Tony Spataro', 'Scott Messier']
   spec.email     = 'lee@rightscale.com'
   spec.homepage  = 'https://github.com/rightscale/right_agent'

data/spec/error_tracker_spec.rb

@@ -40,13 +40,18 @@ describe RightScale::ErrorTracker do
     @tracker = RightScale::ErrorTracker.instance
     @log = flexmock(RightScale::Log)
     @brake = flexmock(HydraulicBrake)
+    @options = {
+      :shard_id => @shard_id,
+      :trace_level => @trace_level,
+      :airbrake_endpoint => @endpoint,
+      :airbrake_api_key => @api_key,
+      :filter_params => [:password] }
   end
 
   context :init do
     it "initializes the tracker" do
-      flexmock(@tracker).should_receive(:notify_init).with(@agent_name, @shard_id, @endpoint, @api_key).once
-      @tracker.init(@agent, @agent_name, :trace_level => @trace_level, :shard_id => @shard_id,
-                    :airbrake_endpoint => @endpoint, :airbrake_api_key => @api_key).should be true
+      flexmock(@tracker).should_receive(:notify_init).with(@agent_name, @options).once
+      @tracker.init(@agent, @agent_name, @options).should be true
       @tracker.instance_variable_get(:@agent).should == @agent
       @tracker.instance_variable_get(:@trace_level).should == @trace_level
       @tracker.exception_stats.should be_a RightSupport::Stats::Exceptions
@@ -154,8 +159,7 @@ describe RightScale::ErrorTracker do
   context :notify do
     before(:each) do
       @exception = RuntimeError.new("error")
-      @tracker.init(@agent, @agent_name, :trace_level => @trace_level, :shard_id => @shard_id,
-                    :airbrake_endpoint => @endpoint, :airbrake_api_key => @api_key)
+      @tracker.init(@agent, @agent_name, @options)
       @cgi_data = @tracker.instance_variable_get(:@cgi_data)
     end
 
@@ -204,6 +208,28 @@ describe RightScale::ErrorTracker do
       @tracker.notify(@exception, packet = nil, agent = nil, "component").should be true
     end
 
+    it "converts non-nil, non-hash payload in packet to a hash" do
+      request = RightScale::Request.new("/foo/bar", "payload", :token => "token")
+      @brake.should_receive(:notify).with(on { |a| a[:parameters] == {:param => "payload"} }).once
+      @tracker.notify(@exception, request).should be true
+    end
+
+    it "converts non-nil, non-hash data in event to a hash" do
+      @brake.should_receive(:notify).with(on { |a| a[:parameters] == {:param => "payload"} }).once
+      @tracker.notify(@exception, {"uuid" => "token", "path" => "/foo/bar", "data" => "payload"}).should be true
+    end
+
+    it "omits :parameters from notification if payload in packet is nil" do
+      request = RightScale::Request.new("/foo/bar", nil, :token => "token")
+      @brake.should_receive(:notify).with(on { |a| !a.has_key?(:parameters) }).once
+      @tracker.notify(@exception, request).should be true
+    end
+
+    it "omits :parameters from notification if data in packet is nil" do
+      @brake.should_receive(:notify).with(on { |a| !a.has_key?(:parameters) }).once
+      @tracker.notify(@exception, {"uuid" => "token", "path" => "/foo/bar", "data" => nil}).should be true
+    end
+
     it "functions even if cgi_data has not been initialized by notify_init" do
       @tracker.instance_variable_set(:@cgi_data, nil)
       @brake.should_receive(:notify).with(on { |a| a[:error_message] == "error" &&
@@ -223,8 +249,7 @@ describe RightScale::ErrorTracker do
 
   context :notify_callback do
     it "returns proc that calls notify" do
-      @tracker.init(@agent, @agent_name, :trace_level => @trace_level, :shard_id => @shard_id,
-                    :airbrake_endpoint => @endpoint, :airbrake_api_key => @api_key)
+      @tracker.init(@agent, @agent_name, @options)
       flexmock(@tracker).should_receive(:notify).with("exception", "packet", "agent", "component").once
       @tracker.notify_callback.call("exception", "packet", "agent", "component")
     end
@@ -265,17 +290,16 @@ describe RightScale::ErrorTracker do
 
     it "does not initialize if Airbrake endpoint or API key is undefined" do
       @brake.should_receive(:configure).never
-      @tracker.send(:notify_init, @agent_name, @shard_id, @endpoint, nil)
+      @tracker.send(:notify_init, @agent_name, @options.merge(:airbrake_endpoint => nil))
       @tracker.instance_variable_get(:@notify_enabled).should be false
-      @tracker.send(:notify_init, @agent_name, @shard_id, nil, @api_key)
+      @tracker.send(:notify_init, @agent_name, @options.merge(:airbrake_api_key => nil))
       @tracker.instance_variable_get(:@notify_enabled).should be false
-      @tracker.instance_variable_get(:@cgi_data).should be_empty
     end
 
     it "initializes cgi data and configures HydraulicBrake" do
       config = ConfigMock.new
       @brake.should_receive(:configure).and_yield(config).once
-      @tracker.send(:notify_init, @agent_name, @shard_id, @endpoint, @api_key).should be true
+      @tracker.send(:notify_init, @agent_name, @options).should be true
       cgi_data = @tracker.instance_variable_get(:@cgi_data)
       cgi_data[:agent_name].should == @agent_name
       cgi_data[:pid].should be_a Integer
@@ -287,20 +311,36 @@ describe RightScale::ErrorTracker do
       config.api_key.should == @api_key
       config.project_root.should be_a String
       @tracker.instance_variable_get(:@notify_enabled).should be true
+      @tracker.instance_variable_get(:@filter_params).should == ["password"]
     end
 
     it "raises exception if hydraulic_gem is not available" do
       flexmock(@tracker).should_receive(:require_succeeds?).with("hydraulic_brake").and_return(false)
       lambda do
-        @tracker.send(:notify_init, @agent_name, @shard_id, @endpoint, @api_key)
+        @tracker.send(:notify_init, @agent_name, @options)
       end.should raise_error(RuntimeError, /hydraulic_brake gem missing/)
     end
   end
 
-  context "notify_init" do
+  context :filter do
+
     before(:each) do
-      @tracker.init(@agent, @agent_name, :trace_level => @trace_level, :shard_id => @shard_id,
-                    :airbrake_endpoint => @endpoint, :airbrake_api_key => @api_key)
+      @params = {:user => "me", :password => "secret"}
+    end
+
+    it "applies filters" do
+      @tracker.init(@agent, @agent_name, @options)
+      @tracker.send(:filter, @params).should == {:user => "me", :password => "<hidden>"}
+    end
+
+    it "converts parameter names to string form before comparison" do
+      @tracker.init(@agent, @agent_name, @options)
+      @tracker.send(:filter, :user => "me", "password" => "secret").should == {:user => "me", "password" => "<hidden>"}
+    end
+
+    it "does not filter if no filters are specified" do
+      @tracker.init(@agent, @agent_name, @options.merge(:filter_params => nil))
+      @tracker.send(:filter, @params).should == @params
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: right_agent
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.3.2
 platform: ruby
 authors:
 - Lee Kirchhoff
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-12 00:00:00.000000000 Z
+date: 2014-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: right_support