sensu 0.25.0.beta → 0.25.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be31b512054dbd9dfbcaa26aafd11cafff18cb51
-  data.tar.gz: 3baad83fdc34d79b765e1145f8d5c44074865bd5
+  metadata.gz: 6d58b06b0ce22836e1207b27f5e270e943647acf
+  data.tar.gz: cfc35367183ebd01f250d3357498a8eb9eef6f59
 SHA512:
-  metadata.gz: 1ce252cc6ecfaccf54a175d61222955df5b269cf60a0dc031cd9cf1e8d9a33b74cb8ed2177bebbf24a0c8dd6e9439a5cd7a8f41d7095b70746cad7e110425f79
-  data.tar.gz: 7118338b715eafaec7e0fb16d1df8f8256f275b16881d9678d0243e2d63086f86dbdaae8b9abe22f318b3d382aeb3e9984959a7af078a905789c2fb213123157
+  metadata.gz: adfef52a3dd93c3f21b4bbf906ce9bbb2d954fdff39113a5efe500b546e5ba965adea6b6c64cf336b42f2e2341534353cef88644146ee2879565f4f51efbc66b
+  data.tar.gz: a91f043f664beae6ddab0c3cedece51148533e584a5de451c969c2fd11b022382527c6e2dbaa79a5feafa98a3fc85132fd184e28b80acdfe3abeb0ca9eaaadfe

data/lib/sensu/api/http_handler.rb

@@ -1,4 +1,3 @@
-require "sensu/api/validators"
 require "sensu/api/routes"
 
 gem "em-http-server", "0.1.8"
@@ -13,39 +12,56 @@ module Sensu
 
       attr_accessor :logger, :settings, :redis, :transport
 
-      # Log the HTTP request. This method determines the remote
-      # address for the HTTP client, `@remote_address`. The debug log
-      # level is used for requests as response logging includes the
-      # same information.
-      def log_request
-        _, @remote_address = Socket.unpack_sockaddr_in(get_peername)
-        @logger.debug("api request", {
-          :remote_address => @remote_address,
+      # Create a hash containing the HTTP request details. This method
+      # determines the remote address for the HTTP client (using
+      # EventMachine Connection `get_peername()`).
+      #
+      # @result [Hash]
+      def request_details
+        return @request_details if @request_details
+        _, remote_address = Socket.unpack_sockaddr_in(get_peername)
+        @request_details = {
+          :remote_address => remote_address,
           :user_agent => @http[:user_agent],
-          :request_method => @http_request_method,
-          :request_uri => @http_request_uri,
-          :request_query_string => @http_query_string,
-          :request_body => @http_content
-        })
+          :method => @http_request_method,
+          :uri => @http_request_uri,
+          :query_string => @http_query_string,
+          :body => @http_content
+        }
+        if @http[:x_forwarded_for]
+          @request_details[:x_forwarded_for] = @http[:x_forwarded_for]
+        end
+        @request_details
+      end
+
+      # Log the HTTP request. The debug log level is used for requests
+      # as response logging includes the same information.
+      def log_request
+        @logger.debug("api request", request_details)
       end
 
       # Log the HTTP response.
       def log_response
         @logger.info("api response", {
-          :remote_address => @remote_address,
-          :user_agent => @http[:user_agent],
-          :request_method => @http_request_method,
-          :request_uri => @http_request_uri,
-          :request_query_string => @http_query_string,
-          :request_body => @http_content,
-          :response_status => @response.status,
-          :response_body => @response.content
+          :request => request_details,
+          :status => @response.status,
+          :content_length => @response.content.to_s.bytesize
         })
       end
 
-      # Parse the HTTP query string for parameters. This method
-      # creates `@params`, a hash of parsed query parameters, used by
-      # the API routes.
+      # Parse the HTTP request URI using a regular expression,
+      # returning the URI unescaped match data values.
+      #
+      # @param regex [Regexp]
+      # @return [Array] URI unescaped match data values.
+      def parse_uri(regex)
+        uri_match = regex.match(@http_request_uri)[1..-1]
+        uri_match.map { |s| URI.unescape(s) }
+      end
+
+      # Parse the HTTP request query string for parameters. This
+      # method creates `@params`, a hash of parsed query parameters,
+      # used by the API routes.
       def parse_parameters
         @params = {}
         if @http_query_string

data/lib/sensu/api/process.rb

@@ -22,13 +22,13 @@ module Sensu
         end
       end
 
-      # Start the Sensu API HTTP server. This method sets the service
-      # state to `:running`.
-      def start
-        api = @settings[:api] || {}
-        bind = api[:bind] || "0.0.0.0"
-        port = api[:port] || 4567
+      # Start the API HTTP server. This method sets `@http_server`.
+      #
+      # @param bind [String] address to listen on.
+      # @param port [Integer] to listen on.
+      def start_http_server(bind, port)
         @logger.info("api listening", {
+          :protocol => "http",
           :bind => bind,
           :port => port
         })
@@ -38,6 +38,15 @@ module Sensu
           handler.redis = @redis
           handler.transport = @transport
         end
+      end
+
+      # Start the Sensu API HTTP server. This method sets the service
+      # state to `:running`.
+      def start
+        api = @settings[:api] || {}
+        bind = api[:bind] || "0.0.0.0"
+        port = api[:port] || 4567
+        start_http_server(bind, port)
         super
       end
 

data/lib/sensu/api/routes/aggregates.rb

@@ -8,6 +8,7 @@ module Sensu
         AGGREGATE_CHECKS_URI = /^\/aggregates\/([\w\.-]+)\/checks$/
         AGGREGATE_RESULTS_SEVERITY_URI = /^\/aggregates\/([\w\.-]+)\/results\/([\w\.-]+)$/
 
+        # GET /aggregates
         def get_aggregates
           @redis.smembers("aggregates") do |aggregates|
             aggregates.map! do |aggregate|
@@ -18,8 +19,9 @@ module Sensu
           end
         end
 
+        # GET /aggregates/:aggregate
         def get_aggregate
-          aggregate = AGGREGATE_URI.match(@http_request_uri)[1]
+          aggregate = parse_uri(AGGREGATE_URI).first
           @redis.smembers("aggregates:#{aggregate}") do |aggregate_members|
             unless aggregate_members.empty?
               @response_content = {
@@ -75,8 +77,9 @@ module Sensu
           end
         end
 
+        # DELETE /aggregates/:aggregate
         def delete_aggregate
-          aggregate = AGGREGATE_URI.match(@http_request_uri)[1]
+          aggregate = parse_uri(AGGREGATE_URI).first
           @redis.smembers("aggregates") do |aggregates|
             if aggregates.include?(aggregate)
               @redis.srem("aggregates", aggregate) do
@@ -90,8 +93,9 @@ module Sensu
           end
         end
 
+        # GET /aggregates/:aggregate/clients
         def get_aggregate_clients
-          aggregate = AGGREGATE_CLIENTS_URI.match(@http_request_uri)[1]
+          aggregate = parse_uri(AGGREGATE_CLIENTS_URI).first
           @response_content = []
           @redis.smembers("aggregates:#{aggregate}") do |aggregate_members|
             unless aggregate_members.empty?
@@ -114,8 +118,9 @@ module Sensu
           end
         end
 
+        # GET /aggregates/:aggregate/checks
         def get_aggregate_checks
-          aggregate = AGGREGATE_CHECKS_URI.match(@http_request_uri)[1]
+          aggregate = parse_uri(AGGREGATE_CHECKS_URI).first
           @response_content = []
           @redis.smembers("aggregates:#{aggregate}") do |aggregate_members|
             unless aggregate_members.empty?
@@ -138,14 +143,13 @@ module Sensu
           end
         end
 
+        # GET /aggregates/:aggregate/results/:severity
         def get_aggregate_results_severity
-          uri_match = AGGREGATE_RESULTS_SEVERITY_URI.match(@http_request_uri)
-          aggregate = uri_match[1]
-          severity = uri_match[2]
-          @response_content = []
+          aggregate, severity = parse_uri(AGGREGATE_RESULTS_SEVERITY_URI)
           if SEVERITIES.include?(severity)
             @redis.smembers("aggregates:#{aggregate}") do |aggregate_members|
               unless aggregate_members.empty?
+                @response_content = []
                 summaries = Hash.new
                 max_age = integer_parameter(@params[:max_age])
                 current_timestamp = Time.now.to_i

data/lib/sensu/api/routes/checks.rb

@@ -5,13 +5,15 @@ module Sensu
         CHECKS_URI = /^\/checks$/
         CHECK_URI = /^\/checks\/([\w\.-]+)$/
 
+        # GET /checks
         def get_checks
           @response_content = @settings.checks
           respond
         end
 
+        # GET /checks/:check_name
         def get_check
-          check_name = CHECK_URI.match(@http_request_uri)[1]
+          check_name = parse_uri(CHECK_URI).first
           if @settings[:checks][check_name]
             @response_content = @settings[:checks][check_name].merge(:name => check_name)
             respond

data/lib/sensu/api/routes/clients.rb

@@ -1,3 +1,4 @@
+require "sensu/api/validators/client"
 require "sensu/api/utilities/resolve_event"
 
 module Sensu
@@ -10,6 +11,7 @@ module Sensu
         CLIENT_URI = /^\/clients\/([\w\.-]+)$/
         CLIENT_HISTORY_URI = /^\/clients\/([\w\.-]+)\/history$/
 
+        # POST /clients
         def post_clients
           read_data do |client|
             client[:keepalives] = client.fetch(:keepalives, false)
@@ -29,6 +31,7 @@ module Sensu
           end
         end
 
+        # GET /clients
         def get_clients
           @response_content = []
           @redis.smembers("clients") do |clients|
@@ -53,8 +56,9 @@ module Sensu
           end
         end
 
+        # GET /clients/:client_name
         def get_client
-          client_name = CLIENT_URI.match(@http_request_uri)[1]
+          client_name = parse_uri(CLIENT_URI).first
           @redis.get("client:#{client_name}") do |client_json|
             unless client_json.nil?
               @response_content = Sensu::JSON.load(client_json)
@@ -65,8 +69,9 @@ module Sensu
           end
         end
 
+        # GET /clients/:client_name/history
         def get_client_history
-          client_name = CLIENT_HISTORY_URI.match(@http_request_uri)[1]
+          client_name = parse_uri(CLIENT_HISTORY_URI).first
           @response_content = []
           @redis.smembers("result:#{client_name}") do |checks|
             unless checks.empty?
@@ -104,8 +109,9 @@ module Sensu
           end
         end
 
+        # DELETE /clients/:client_name
         def delete_client
-          client_name = CLIENT_URI.match(@http_request_uri)[1]
+          client_name = parse_uri(CLIENT_URI).first
           @redis.get("client:#{client_name}") do |client_json|
             unless client_json.nil?
               @redis.hgetall("events:#{client_name}") do |events|

data/lib/sensu/api/routes/events.rb

@@ -10,6 +10,7 @@ module Sensu
         EVENTS_CLIENT_URI = /^\/events\/([\w\.-]+)$/
         EVENT_URI = /^\/events\/([\w\.-]+)\/([\w\.-]+)$/
 
+        # GET /events
         def get_events
           @response_content = []
           @redis.smembers("clients") do |clients|
@@ -30,8 +31,9 @@ module Sensu
           end
         end
 
+        # GET /events/:client_name
         def get_events_client
-          client_name = EVENTS_CLIENT_URI.match(@http_request_uri)[1]
+          client_name = parse_uri(EVENTS_CLIENT_URI).first
           @response_content = []
           @redis.hgetall("events:#{client_name}") do |events|
             events.each do |check_name, event_json|
@@ -41,10 +43,9 @@ module Sensu
           end
         end
 
+        # GET /events/:client_name/:check_name
         def get_event
-          uri_match = EVENT_URI.match(@http_request_uri)
-          client_name = uri_match[1]
-          check_name = uri_match[2]
+          client_name, check_name = parse_uri(EVENT_URI)
           @redis.hgetall("events:#{client_name}") do |events|
             event_json = events[check_name]
             unless event_json.nil?
@@ -56,10 +57,9 @@ module Sensu
           end
         end
 
+        # DELETE /events/:client_name/:check_name
         def delete_event
-          uri_match = EVENT_URI.match(@http_request_uri)
-          client_name = uri_match[1]
-          check_name = uri_match[2]
+          client_name, check_name = parse_uri(EVENT_URI)
           @redis.hgetall("events:#{client_name}") do |events|
             if events.include?(check_name)
               resolve_event(events[check_name])

data/lib/sensu/api/routes/health.rb

@@ -8,6 +8,7 @@ module Sensu
 
         HEALTH_URI = /^\/health$/
 
+        # GET /health
         def get_health
           if @redis.connected? && @transport.connected?
             healthy = []

data/lib/sensu/api/routes/info.rb

@@ -8,6 +8,7 @@ module Sensu
 
         INFO_URI = /^\/info$/
 
+        # GET /info
         def get_info
           transport_info do |info|
             @response_content = {

data/lib/sensu/api/routes/request.rb

@@ -8,6 +8,7 @@ module Sensu
 
         REQUEST_URI = /^\/request$/
 
+        # POST /request
         def post_request
           rules = {
             :check => {:type => String, :nil_ok => false},

data/lib/sensu/api/routes/resolve.rb

@@ -8,6 +8,7 @@ module Sensu
 
         RESOLVE_URI = /^\/resolve$/
 
+        # POST /resolve
         def post_resolve
           rules = {
             :client => {:type => String, :nil_ok => false},

data/lib/sensu/api/routes/results.rb

@@ -10,6 +10,7 @@ module Sensu
         RESULTS_CLIENT_URI = /^\/results\/([\w\.-]+)$/
         RESULT_URI = /^\/results\/([\w\.-]+)\/([\w\.-]+)$/
 
+        # POST /results
         def post_results
           rules = {
             :name => {:type => String, :nil_ok => false, :regex => /\A[\w\.-]+\z/},
@@ -24,6 +25,7 @@ module Sensu
           end
         end
 
+        # GET /results
         def get_results
           @response_content = []
           @redis.smembers("clients") do |clients|
@@ -54,8 +56,9 @@ module Sensu
           end
         end
 
+        # GET /results/:client_name
         def get_results_client
-          client_name = RESULTS_CLIENT_URI.match(@http_request_uri)[1]
+          client_name = parse_uri(RESULTS_CLIENT_URI).first
           @response_content = []
           @redis.smembers("result:#{client_name}") do |checks|
             unless checks.empty?
@@ -72,15 +75,14 @@ module Sensu
                 end
               end
             else
-              not_found!
+              respond
             end
           end
         end
 
+        # GET /results/:client_name/:check_name
         def get_result
-          uri_match = RESULT_URI.match(@http_request_uri)
-          client_name = uri_match[1]
-          check_name = uri_match[2]
+          client_name, check_name = parse_uri(RESULT_URI)
           result_key = "result:#{client_name}:#{check_name}"
           @redis.get(result_key) do |result_json|
             unless result_json.nil?
@@ -93,10 +95,9 @@ module Sensu
           end
         end
 
+        # DELETE /results/:client_name/:check_name
         def delete_result
-          uri_match = RESULT_URI.match(@http_request_uri)
-          client_name = uri_match[1]
-          check_name = uri_match[2]
+          client_name, check_name = parse_uri(RESULT_URI)
           result_key = "result:#{client_name}:#{check_name}"
           @redis.exists(result_key) do |result_exists|
             if result_exists

data/lib/sensu/api/routes/stashes.rb

@@ -5,8 +5,9 @@ module Sensu
         STASHES_URI = /^\/stashes$/
         STASH_URI = /^\/stash(?:es)?\/(.*)$/
 
+        # POST /stash/:path or /stashes/:path
         def post_stash
-          path = STASH_URI.match(@http_request_uri)[1]
+          path = parse_uri(STASH_URI).first
           read_data do |data|
             @redis.set("stash:#{path}", Sensu::JSON.dump(data)) do
               @redis.sadd("stashes", path) do
@@ -17,8 +18,9 @@ module Sensu
           end
         end
 
+        # GET /stash/:path or /stashes/:path
         def get_stash
-          path = STASH_URI.match(@http_request_uri)[1]
+          path = parse_uri(STASH_URI).first
           @redis.get("stash:#{path}") do |stash_json|
             unless stash_json.nil?
               @response_content = Sensu::JSON.load(stash_json)
@@ -29,8 +31,9 @@ module Sensu
           end
         end
 
+        # DELETE /stash/:path or /stashes/:path
         def delete_stash
-          path = STASH_URI.match(@http_request_uri)[1]
+          path = parse_uri(STASH_URI).first
           @redis.exists("stash:#{path}") do |stash_exists|
             if stash_exists
               @redis.srem("stashes", path) do
@@ -44,6 +47,7 @@ module Sensu
           end
         end
 
+        # GET /stashes
         def get_stashes
           @response_content = []
           @redis.smembers("stashes") do |stashes|
@@ -74,6 +78,7 @@ module Sensu
           end
         end
 
+        # POST /stashes
         def post_stashes
           rules = {
             :path => {:type => String, :nil_ok => false},

data/lib/sensu/api/{validators.rb → validators/client.rb}

@@ -1,12 +1,10 @@
+require "sensu/api/validators/invalid"
 require "sensu/settings/rules"
 require "sensu/settings/validators/client"
 
 module Sensu
   module API
     module Validators
-      # The error class for validation.
-      class Invalid < RuntimeError; end
-
       class Client
         # Include Sensu Settings rules and client validator.
         include Sensu::Settings::Rules

data/lib/sensu/api/validators/invalid.rb

@@ -0,0 +1,8 @@
+module Sensu
+  module API
+    module Validators
+      # The error class for validation.
+      class Invalid < RuntimeError; end
+    end
+  end
+end

data/lib/sensu/client/process.rb

@@ -131,21 +131,24 @@ module Sensu
       # the result. This method guards against multiple executions for
       # the same check. Check attribute value tokens are substituted
       # with the associated client attribute values, via
-      # `object_substitute_tokens()`. If there are unmatched check
-      # attribute value tokens, the check will not be executed,
-      # instead a check result will be published reporting the
-      # unmatched tokens.
+      # `object_substitute_tokens()`. The original check command is
+      # always published, to guard against publishing
+      # sensitive/redacted client attribute values. If there are
+      # unmatched check attribute value tokens, the check will not be
+      # executed, instead a check result will be published reporting
+      # the unmatched tokens.
       #
       # @param check [Hash]
       def execute_check_command(check)
         @logger.debug("attempting to execute check command", :check => check)
         unless @checks_in_progress.include?(check[:name])
           @checks_in_progress << check[:name]
-          check, unmatched_tokens = object_substitute_tokens(check)
+          substituted, unmatched_tokens = object_substitute_tokens(check.dup)
+          check = substituted.merge(:command => check[:command])
           if unmatched_tokens.empty?
             started = Time.now.to_f
             check[:executed] = started.to_i
-            Spawn.process(check[:command], :timeout => check[:timeout]) do |output, status|
+            Spawn.process(substituted[:command], :timeout => check[:timeout]) do |output, status|
               check[:duration] = ("%.3f" % (Time.now.to_f - started)).to_f
               check[:output] = output
               check[:status] = status

data/lib/sensu/constants.rb

@@ -1,7 +1,7 @@
 module Sensu
   unless defined?(Sensu::VERSION)
     # Sensu release version.
-    VERSION = "0.25.0.beta".freeze
+    VERSION = "0.25.0.rc1".freeze
 
     # Sensu check severities.
     SEVERITIES = %w[ok warning critical unknown].freeze

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu
 version: !ruby/object:Gem::Version
-  version: 0.25.0.beta
+  version: 0.25.0.rc1
 platform: ruby
 authors:
 - Sean Porter
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-10 00:00:00.000000000 Z
+date: 2016-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -244,7 +244,8 @@ files:
 - lib/sensu/api/utilities/publish_check_result.rb
 - lib/sensu/api/utilities/resolve_event.rb
 - lib/sensu/api/utilities/transport_info.rb
-- lib/sensu/api/validators.rb
+- lib/sensu/api/validators/client.rb
+- lib/sensu/api/validators/invalid.rb
 - lib/sensu/cli.rb
 - lib/sensu/client/process.rb
 - lib/sensu/client/socket.rb