right_agent 2.1.1 → 2.1.2

data/lib/right_agent/clients/balanced_http_client.rb

@@ -145,7 +145,8 @@ module RightScale
     #   provided during object initialization
     # @option options [Hash] :headers to be added to request
     # @option options [Numeric] :poll_timeout maximum wait for individual poll; defaults to :request_timeout
-    # @option options [Symbol] :log_level to use when logging information about the request other than errors
+    # @option options [Symbol] :log_level to use when logging information about the request other than errors;
+    #   defaults to :info
     #
     # @return [Object] result returned by receiver of request
     #
@@ -154,11 +155,11 @@ module RightScale
     def request(verb, path, params = {}, options = {})
       started_at = Time.now
       filter = @filter_params + (options[:filter_params] || []).map { |p| p.to_s }
-      log_level = options[:log_level] || Log.level
+      log_level = options[:log_level] || :info
       request_uuid = options[:request_uuid] || RightSupport::Data::UUID.generate
       connect_options, request_options = @http_client.options(verb, path, params, request_headers(request_uuid, options), options)
 
-      Log.send(log_level, "Requesting #{verb.to_s.upcase} <#{request_uuid}> " + log_text(path, params, filter, log_level))
+      Log.send(log_level, "Requesting #{verb.to_s.upcase} <#{request_uuid}> " + log_text(path, params, filter))
 
       used = {}
       result, code, body, headers = if verb != :poll
@@ -171,14 +172,14 @@ module RightScale
       result
     rescue RightSupport::Net::NoResult => e
       handle_no_result(e, used[:host]) do |e2|
-        log_failure(used[:host], path, params, filter, request_uuid, started_at, log_level, e2)
+        log_failure(used[:host], path, params, filter, request_uuid, started_at, e2)
       end
     rescue RestClient::Exception => e
       e2 = HttpExceptions.convert(e)
-      log_failure(used[:host], path, params, filter, request_uuid, started_at, log_level, e2)
+      log_failure(used[:host], path, params, filter, request_uuid, started_at, e2)
       raise e2
     rescue Exception => e
-      log_failure(used[:host], path, params, filter, request_uuid, started_at, log_level, e)
+      log_failure(used[:host], path, params, filter, request_uuid, started_at, e)
       raise
     end
 
@@ -304,7 +305,7 @@ module RightScale
       length = (headers && headers[:content_length]) || (body && body.size) || "-"
       duration = "%.0fms" % ((Time.now - started_at) * 1000)
       completed = "Completed <#{request_uuid}> in #{duration} | #{code || "nil"} [#{host}#{path}] | #{length} bytes"
-      completed << " | #{result.inspect}" if log_level == :debug
+      completed << " | #{result.inspect}" if Log.level == :debug
       Log.send(log_level, completed)
       true
     end
@@ -318,14 +319,13 @@ module RightScale
     # @param [Array] filter list of parameters whose value is to be hidden
     # @param [String] request_uuid uniquely identifying request
     # @param [Time] started_at time for request
-    # @param [Symbol] log_level to use when logging information about the request
     # @param [Exception, String] exception or message that should be logged
     #
     # @return [TrueClass] Always return true
-    def log_failure(host, path, params, filter, request_uuid, started_at, log_level, exception)
+    def log_failure(host, path, params, filter, request_uuid, started_at, exception)
       code = exception.respond_to?(:http_code) ? exception.http_code : "nil"
       duration = "%.0fms" % ((Time.now - started_at) * 1000)
-      Log.error("Failed <#{request_uuid}> in #{duration} | #{code} " + log_text(path, params, filter, log_level, host, exception))
+      Log.error("Failed <#{request_uuid}> in #{duration} | #{code} " + log_text(path, params, filter, host, exception))
       true
     end
 
@@ -334,13 +334,12 @@ module RightScale
     # @param [String] path in URI for desired resource
     # @param [Hash] params for HTTP request
     # @param [Array, NilClass] filter augmentation to base filter list
-    # @param [Symbol] log_level to use when logging information about the request
     # @param [String] host server URL where request was attempted if known
     # @param [Exception, String, NilClass] exception or failure message that should be logged
     #
     # @return [String] Log text
-    def log_text(path, params, filter, log_level, host = nil, exception = nil)
-      filtered_params = (exception || log_level == :debug) ? filter(params, filter).inspect : nil
+    def log_text(path, params, filter, host = nil, exception = nil)
+      filtered_params = (exception || Log.level == :debug) ? filter(params, filter).inspect : nil
       text = filtered_params ? "#{path} #{filtered_params}" : path
       text = "[#{host}#{text}]" if host
       text << " | #{self.class.exception_text(exception)}" if exception

data/lib/right_agent/clients/router_client.rb

@@ -530,7 +530,6 @@ module RightScale
 
     # Make long-polling request to receive one or more events
     # Do not return until an event is received or the polling times out or fails
-    # Limit logging unless in debug mode
     #
     # @param [Array, NilClass] routing_keys as strings to assist router in delivering
     #   event to interested parties
@@ -552,7 +551,6 @@ module RightScale
       params[:ack] = ack if ack && ack.any?
 
       options = {
-        :log_level => :debug,
         :request_timeout => @connect_interval,
         :poll_timeout => @options[:listen_timeout] }
 

data/right_agent.gemspec

@@ -25,8 +25,8 @@ require 'rbconfig'
 
 Gem::Specification.new do |spec|
   spec.name      = 'right_agent'
-  spec.version   = '2.1.1'
-  spec.date      = '2014-04-01'
+  spec.version   = '2.1.2'
+  spec.date      = '2014-04-07'
   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/clients/balanced_http_client_spec.rb

@@ -140,26 +140,27 @@ describe RightScale::BalancedHttpClient do
       @client.request(:post, @path) rescue nil
     end
 
-    it "logs using specified log level" do
+    it "logs using specified :log_level" do
       @params = {:some => "data"}
-      @log.should_receive(:debug).with("Requesting POST <random uuid> /foo/bar {:some=>\"data\"}").once
-      @log.should_receive(:debug).with("Completed <random uuid> in 10ms | 200 [http://my.com/foo/bar] | 11 bytes | {\"out\"=>123}").once
+      @log.should_receive(:debug).with("Requesting POST <random uuid> /foo/bar").once
+      @log.should_receive(:debug).with("Completed <random uuid> in 10ms | 200 [http://my.com/foo/bar] | 11 bytes").once
       @client.request(:post, @path, @params, :log_level => :debug)
     end
 
-    it "logs using configured log level if none specified" do
+    it "logs using :info level by default" do
       @params = {:some => "data"}
       @log.should_receive(:level).and_return(:debug)
-      @log.should_receive(:debug).with("Requesting POST <random uuid> /foo/bar {:some=>\"data\"}").once
-      @log.should_receive(:debug).with("Completed <random uuid> in 10ms | 200 [http://my.com/foo/bar] | 11 bytes | {\"out\"=>123}").once
+      @log.should_receive(:info).with("Requesting POST <random uuid> /foo/bar {:some=>\"data\"}").once
+      @log.should_receive(:info).with("Completed <random uuid> in 10ms | 200 [http://my.com/foo/bar] | 11 bytes | {\"out\"=>123}").once
       @client.request(:post, @path, @params)
     end
 
-    it "appends specified filter parameters to list" do
+    it "appends specified filter parameters to list when Log.level is :debug" do
       @params = {:some => "data", :secret => "data", :other => "data"}
-      @log.should_receive(:debug).with("Requesting POST <random uuid> /foo/bar {:some=>\"data\", :secret=>\"<hidden>\", :other=>\"<hidden>\"}").once
-      @log.should_receive(:debug).with("Completed <random uuid> in 10ms | 200 [http://my.com/foo/bar] | 11 bytes | {\"out\"=>123}").once
-      @client.request(:post, @path, @params, :log_level => :debug, :filter_params => [:other])
+      @log.should_receive(:level).and_return(:debug)
+      @log.should_receive(:info).with("Requesting POST <random uuid> /foo/bar {:some=>\"data\", :secret=>\"<hidden>\", :other=>\"<hidden>\"}").once
+      @log.should_receive(:info).with("Completed <random uuid> in 10ms | 200 [http://my.com/foo/bar] | 11 bytes | {\"out\"=>123}").once
+      @client.request(:post, @path, @params, :filter_params => [:other])
     end
 
     it "removes user and password from host when logging" do
@@ -433,7 +434,7 @@ describe RightScale::BalancedHttpClient do
       @client.send(:log_success, @result, 200, @body, @headers, "http://my.com", @path, "uuid", @now, :info).should be true
     end
 
-    it "logs response length using response body size of :content_lenght not available" do
+    it "logs response length using response body size of :content_length not available" do
       @log.should_receive(:info).with("Completed <uuid> in 10ms | 200 [http://my.com/foo/bar] | 11 bytes").once
       @client.send(:log_success, @result, 200, @body, @headers, "http://my.com", @path, "uuid", @now, :info).should be true
     end
@@ -443,9 +444,15 @@ describe RightScale::BalancedHttpClient do
       @client.send(:log_success, @result, 200, @body, @headers, "http://my.com", @path, "uuid", @now - 0.01, :info).should be true
     end
 
-    it "log result if log level option set to :debug" do
-      @log.should_receive(:debug).with("Completed <uuid> in 10ms | 200 [http://my.com/foo/bar] | 11 bytes | {\"out\"=>123}").once
-      @client.send(:log_success, @result, 200, @body, @headers, "http://my.com", @path, "uuid", @now, :debug).should be true
+    it "log result if Log.level is set to :debug" do
+      @log.should_receive(:level).and_return(:debug)
+      @log.should_receive(:info).with("Completed <uuid> in 10ms | 200 [http://my.com/foo/bar] | 11 bytes | {\"out\"=>123}").once
+      @client.send(:log_success, @result, 200, @body, @headers, "http://my.com", @path, "uuid", @now, :info).should be true
+    end
+
+    it "logs using the specified log_level" do
+      @log.should_receive(:debug).once
+      @client.send(:log_success, @result, 200, @body, @headers, "http://my.com", @path, "uuid", @now, :debug)
     end
   end
 
@@ -457,17 +464,17 @@ describe RightScale::BalancedHttpClient do
     it "logs exception" do
       exception = RightScale::HttpExceptions.create(400, "bad data")
       @log.should_receive(:error).with("Failed <uuid> in 10ms | 400 [http://my.com/foo/bar \"params\"] | 400 Bad Request: bad data").once
-      @client.send(:log_failure, @url, @path, "params", [], "uuid", @now, :info, exception).should be true
+      @client.send(:log_failure, @url, @path, "params", [], "uuid", @now, exception).should be true
     end
 
     it "logs error string" do
       @log.should_receive(:error).with("Failed <uuid> in 10ms | nil [http://my.com/foo/bar \"params\"] | bad data").once
-      @client.send(:log_failure, @url, @path, "params", [], "uuid", @now, :info, "bad data").should be true
+      @client.send(:log_failure, @url, @path, "params", [], "uuid", @now, "bad data").should be true
     end
 
     it "filters parameters" do
       @log.should_receive(:error).with("Failed <uuid> in 10ms | nil [http://my.com/foo/bar {:secret=>\"<hidden>\"}] | bad data").once
-      @client.send(:log_failure, @url, @path, {:secret => "data"}, ["secret"], "uuid", @now, :info, "bad data").should be true
+      @client.send(:log_failure, @url, @path, {:secret => "data"}, ["secret"], "uuid", @now, "bad data").should be true
     end
   end
 
@@ -478,37 +485,38 @@ describe RightScale::BalancedHttpClient do
 
     context "when no exception" do
 
-      context "in info mode with no host" do
+      context "and Log.level is :info with no host" do
         it "generates text containing path" do
-          text = @client.send(:log_text, @path, {:value => 123}, [], :info)
+          text = @client.send(:log_text, @path, {:value => 123}, [])
           text.should == "/foo/bar"
         end
       end
 
-      context "in info mode with host" do
+      context "and Log.level is :info with host" do
         it "generates text containing host and path" do
-          text = @client.send(:log_text, @path, {:value => 123}, [], :info, @url)
+          text = @client.send(:log_text, @path, {:value => 123}, [], @url)
           text.should == "[http://my.com/foo/bar]"
         end
       end
 
-      context "and in debug mode" do
+      context "and Log.level is :debug" do
         it "generates text containing containing host, path, and filtered parameters" do
-          text = @client.send(:log_text, @path, {:some => "data", :secret => "data"}, ["secret"], :debug, @url)
+          @log.should_receive(:level).and_return(:debug)
+          text = @client.send(:log_text, @path, {:some => "data", :secret => "data"}, ["secret"], @url)
           text.should == "[http://my.com/foo/bar {:some=>\"data\", :secret=>\"<hidden>\"}]"
         end
       end
     end
 
     context "when exception" do
-      it "includes params regardless of mode" do
-        text = @client.send(:log_text, @path, {:some => "data", :secret => "data"}, ["secret"], :info, @url, "failed")
+      it "includes params regardless of Log.level" do
+        text = @client.send(:log_text, @path, {:some => "data", :secret => "data"}, ["secret"], @url, "failed")
         text.should == "[http://my.com/foo/bar {:some=>\"data\", :secret=>\"<hidden>\"}] | failed"
       end
 
       it "includes exception text" do
         exception = RightScale::HttpExceptions.create(400, "bad data")
-        text = @client.send(:log_text, @path, {:some => "data", :secret => "data"}, ["secret"], :info, @url, exception)
+        text = @client.send(:log_text, @path, {:some => "data", :secret => "data"}, ["secret"], @url, exception)
         text.should == "[http://my.com/foo/bar {:some=>\"data\", :secret=>\"<hidden>\"}] | 400 Bad Request: bad data"
       end
     end

data/spec/clients/router_client_spec.rb

@@ -683,7 +683,7 @@ describe RightScale::RouterClient do
       it "uses listen timeout for request poll timeout and connect interval for request timeout" do
         @client.instance_variable_set(:@connect_interval, 300)
         flexmock(@client).should_receive(:make_request).with(:poll, "/listen", Hash, "listen", nil,
-            {:poll_timeout => 60, :request_timeout => 300, :log_level => :debug}).and_return([@event]).once
+            {:poll_timeout => 60, :request_timeout => 300}).and_return([@event]).once
         @client.send(:long_poll, @routing_keys, @ack, &@handler)
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: right_agent
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-01 00:00:00.000000000 Z
+date: 2014-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: right_support
@@ -412,7 +412,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4244231635060832919
+      hash: 701936506677112594
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.26