scout 5.2.2 → 5.3.0

data/CHANGELOG

@@ -1,4 +1,9 @@
-== 5.2.2
+== 5.3.0
+
+* Ping over http instead of https. All plan retrievals and check-ins are still SSL
+* Added ability to post troubleshooting report back to scoutapp.com  
+
+ == 5.2.2
 
 * More graceful handling of *rare* client_history.yaml corruption
 

data/lib/scout.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby -wKU
 
 module Scout
-  VERSION = "5.2.2".freeze
+  VERSION = "5.3.0".freeze
 end
 
 require "scout/command"

data/lib/scout/command.rb

@@ -37,8 +37,8 @@ module Scout
         opts.separator "    ... OR ..."
         opts.separator "    #{program_name} [OPTIONS] install"
         opts.separator "  Troubleshoot:"
-        opts.separator "    #{program_name} troubleshoot"
-        opts.separator "    ... print Scout environment info. Recommend directing output to a file."
+        opts.separator "    #{program_name} [OPTIONS] troubleshoot"
+        opts.separator "    ... print troubleshooting info, or post it back to scoutapp.com."
         opts.separator "  Local plugin testing:"
         opts.separator "    #{program_name} [OPTIONS] test " +
                        "PATH_TO_PLUGIN [PLUGIN_OPTIONS]"
@@ -88,6 +88,16 @@ module Scout
           options[:force] = bool
         end
 
+        opts.separator " "
+        opts.separator "Troubleshooting Options:"
+        opts.separator "--------------------------------------------------------------------------"
+        opts.on( "--post", "For use with 'troubleshoot' - post the troubleshooting results back to scoutapp.com") do
+          options[:troubleshoot_post] = true
+        end
+        opts.on( "--no-history", "For use with 'troubleshoot' - don't include the history file contents.") do
+          options[:troubleshoot_no_history] = true
+        end
+
         opts.separator " "
         opts.separator "Examples: "
         opts.separator "--------------------------------------------------------------------------"

data/lib/scout/command/troubleshoot.rb

@@ -1,12 +1,25 @@
 #!/usr/bin/env ruby -wKU
 
-require "pp"
+require "uri"
+require "socket"
+require "net/https"
+require "timeout"
+
 
 module Scout
   class Command
+    class APITimeoutError < RuntimeError; end
+
+    HTTP_HEADERS = { "Client-Version"  => Scout::VERSION,
+                     "Client-Hostname" => Socket.gethostname}
+
     class Troubleshoot < Command
+      
       def initialize(options, args)
+        @post = options[:troubleshoot_post]
+        @include_history = !options[:troubleshoot_no_history]
         @contents=[]
+        options[:verbose]=true # force verbose logging for this command
         super
       end
 
@@ -32,19 +45,31 @@ module Scout
         heading "Installed Gems"
         text `gem list --local`
 
-        heading "History file Contents"
-        contents=File.read(history) rescue "History not found at #{log_path}"
-        text contents
+
+        if @include_history
+          heading "History file Contents"
+          contents=File.read(history) rescue "History not found at #{log_path}"
+          text contents
+        else
+          heading "Skipping History file Contents"
+        end
 
         heading "Agent directory Contents"
         text `ls -la #{config_dir}`
 
         heading ""
 
-        puts "Done"
-
-        puts @contents.join("\n")
-
+        if @post
+          puts "Posting troubleshooting info to #{@server} ... "
+          url = URI.join( @server,"/admin/troubleshooting_reports")
+          post_form(url, "Couldn't contact server at #{@server}",{:body=>contents_as_text}) do |res|
+            puts "Scout server says: \"#{res.body}\""
+          end
+        else
+          puts contents_as_text
+        end
+
+        puts " ... Done"
       end
     end
 
@@ -61,5 +86,57 @@ module Scout
       @contents << s
     end
 
+    def contents_as_text
+      @contents.join("\n")
+    end
+
+    def post_form(url, error, form_data, headers = Hash.new, &response_handler)
+      return unless url
+      request(url, response_handler, error) do |connection|
+        post = Net::HTTP::Post.new( url.path +
+                                    (url.query ? ('?' + url.query) : ''),
+                                    HTTP_HEADERS.merge(headers) )
+        post.set_form_data(form_data)
+        connection.request(post)
+      end
+    end
+
+    def request(url, response_handler, error, &connector)
+      response           = nil
+      Timeout.timeout(5 * 60, APITimeoutError) do
+        http               = Net::HTTP.new(url.host, url.port)
+        if url.is_a? URI::HTTPS
+          http.use_ssl     = true
+          http.ca_file     = File.join( File.dirname(__FILE__),
+                                        *%w[.. .. data cacert.pem] )
+          http.verify_mode = OpenSSL::SSL::VERIFY_PEER |
+                             OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
+        end
+        response           = no_warnings { http.start(&connector) }
+      end
+      case response
+      when Net::HTTPSuccess, Net::HTTPNotModified
+        response_handler[response] unless response_handler.nil?
+      else
+        error = "Server says: #{response['x-scout-msg']}" if response['x-scout-msg']
+        log.fatal error
+        raise SystemExit.new(error)
+      end
+    rescue Timeout::Error
+      log.fatal "Request timed out."
+      exit
+    rescue Exception
+      raise if $!.is_a? SystemExit
+      log.fatal "An HTTP error occurred:  #{$!.message}"
+      exit
+    end
+
+    def no_warnings
+      old_verbose = $VERBOSE
+      $VERBOSE    = false
+      yield
+    ensure
+      $VERBOSE = old_verbose
+    end
   end
 end

data/lib/scout/server.rb

@@ -62,6 +62,26 @@ module Scout
       end
     end
 
+    def refresh?
+      return true if !ping_key
+
+      url=URI.join( @server.sub("https://","http://"), "/clients/#{ping_key}/ping.scout")
+
+      headers = {"x-scout-tty" => ($stdin.tty? ? 'true' : 'false')}
+      if @history["plan_last_modified"] and @history["old_plugins"]
+        headers["If-Modified-Since"] = @history["plan_last_modified"]
+      end
+      get(url, "Could not ping #{url} for refresh info", headers) do |res|
+        if res.is_a?(Net::HTTPNotModified)
+          return false
+        else
+          info "Plan has been modified!"
+          return true
+        end
+      end
+    end
+
+
     #
     # Retrieves the Plugin Plan from the server. This is the list of plugins
     # to execute, along with all options.
@@ -70,23 +90,13 @@ module Scout
     # 1) it sets the @plugin_plan with either A) whatever is in history, B) the results of the /plan retrieval
     # 2) it sets @checkin_to = true IF so directed by the scout server
     def fetch_plan
-      url = urlify(:plan)
-      info "Pinging server at #{url}..."
-      headers = {"x-scout-tty" => ($stdin.tty? ? 'true' : 'false')}
+      if refresh?
 
-      if @history["plan_last_modified"] and @history["old_plugins"]
-        headers["If-Modified-Since"] = @history["plan_last_modified"]
-      end
-      get(url, "Could not retrieve plan from server.", headers) do |res|
-        if res.is_a? Net::HTTPNotModified
-          info "Plan not modified. Will reuse saved plan."
-          @plugin_plan = Array(@history["old_plugins"])
-          # Add local plugins to the plan. Note that local plugins are NOT saved to history file
-          @plugin_plan += get_local_plugins
-          @directives = @history["directives"] || Hash.new
+        url = urlify(:plan)
+        info "Fetching plan from server at #{url}..."
+        headers = {"x-scout-tty" => ($stdin.tty? ? 'true' : 'false')}
 
-        else
-          info "plan has been modified. Will run the new plan now."
+        get(url, "Could not retrieve plan from server.", headers) do |res|
           begin
             body = res.body
             if res["Content-Encoding"] == "gzip" and body and not body.empty?
@@ -144,6 +154,11 @@ module Scout
             exit
           end
         end
+      else
+        info "Plan not modified."
+        @plugin_plan = Array(@history["old_plugins"])
+        @plugin_plan += get_local_plugins
+        @directives = @history["directives"] || Hash.new
       end
     end
 
@@ -174,6 +189,10 @@ module Scout
       (@history['directives'] || {})['sleep_interval'].to_f
     end
 
+    def ping_key
+      (@history['directives'] || {})['ping_key']
+    end
+
     # uses values from history and current time to determine if we should checkin at this time
     def time_to_checkin?
       @history['last_checkin'] == nil ||

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 5
-  - 2
-  - 2
-  version: 5.2.2
+  - 3
+  - 0
+  version: 5.3.0
 platform: ruby
 authors: 
 - Scout Monitoring
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-01 00:00:00 -08:00
+date: 2011-03-07 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency