sensu 0.13.1 → 0.14.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b97c7d173f1349f87c0770d57f03560f6ca33496
-  data.tar.gz: 97e6ab5a073fb228dd6607074b28fe15f9708434
+  metadata.gz: 03f7b351c7b3313b052fc9101104a507e222a72a
+  data.tar.gz: 9d383b007b24f9ffd36199fda48d93301e78512e
 SHA512:
-  metadata.gz: 3ed616f47828abc82ec5b886257a2012ead0c74f0f175d476163825ba5f593214852f9d150a3df4d2fe05a486f3ce98bbf23f115743129d9f9c6685dbdaf5831
-  data.tar.gz: fb72effe5bbe18f177b1a3471cb6b06c33839b4a6820a548bbcc6debb736071e881a2afe77508fb1d7912808df1ba117723b5fd64926930bbcc9b4c70e9c97a4
+  metadata.gz: 2a97f6ffac42dd09e68eea5baaf9248c9dec3f20c5495c560651c28ea2900f1b6b86ac2dfbdb202c9460e6965c18595eae76ce85bc3715028d39d5548eaa0568
+  data.tar.gz: ea7357550ec3663bad511a880d6db95b2a4454efe34af55cd21e892f6baf1a5f0f8529896f1c67e6c6488aa1c5db3e323aeba901ce9eefc0defd1c9122e9c16b

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 0.14.0 - TBD
+
+### Features
+
+Client socket now supports sending a result via a TCP stream. This feature
+allows check results to have larger output (metrics, backtraces, etc).
+
+API now supports CORS (configurable).
+
+### Other
+
+Child process manager now supports check output larger than the max OS
+buffer size. The parent process was waiting on the child to exit before
+closing its write end of the pipe.
+
+Client & server are now guarding against invalid JSON transport payloads.
+
 ## 0.13.1 - 2014-07-28
 
 ### Other

data/lib/sensu/api.rb

@@ -39,13 +39,15 @@ module Sensu
         setup_logger(options)
         set :logger, @logger
         load_settings(options)
+        set :api, @settings[:api]
         set :checks, @settings[:checks]
         set :all_checks, @settings.checks
-        if @settings[:api][:user] && @settings[:api][:password]
-          use Rack::Auth::Basic do |user, password|
-            user == @settings[:api][:user] && password == @settings[:api][:password]
-          end
-        end
+        set :cors, @settings[:cors] || {
+          'Origin' => '*',
+          'Methods' => 'GET, POST, PUT, DELETE, OPTIONS',
+          'Credentials' => 'true',
+          'Headers' => 'Origin, X-Requested-With, Content-Type, Accept, Authorization'
+        }
         on_reactor_run
         self
       end
@@ -112,10 +114,30 @@ module Sensu
         env['rack.input'].rewind
       end
 
+      def protected!
+        if settings.api[:user] && settings.api[:password]
+          return if !(settings.api[:user] && settings.api[:password]) || authorized?
+          headers['WWW-Authenticate'] = 'Basic realm="Restricted Area"'
+          unauthorized!
+        end
+      end
+
+      def authorized?
+        @auth ||=  Rack::Auth::Basic::Request.new(request.env)
+        @auth.provided? &&
+          @auth.basic? &&
+          @auth.credentials &&
+          @auth.credentials == [settings.api[:user], settings.api[:password]]
+      end
+
       def bad_request!
         ahalt 400
       end
 
+      def unauthorized!
+        ahalt 401
+      end
+
       def not_found!
         ahalt 404
       end
@@ -235,6 +257,14 @@ module Sensu
     before do
       request_log_line
       content_type 'application/json'
+      settings.cors.each do |header, value|
+        headers['Access-Control-Allow-' + header] = value
+      end
+      protected! unless env['REQUEST_METHOD'] == 'OPTIONS'
+    end
+
+    aoptions '/*' do
+      body ''
     end
 
     aget '/info/?' do

data/lib/sensu/client.rb

@@ -170,11 +170,18 @@ module Sensu
         })
         funnel = [@settings[:client][:name], VERSION, Time.now.to_i].join('-')
         @transport.subscribe(:fanout, subscription, funnel) do |message_info, message|
-          check = MultiJson.load(message)
-          @logger.info('received check request', {
-            :check => check
-          })
-          process_check(check)
+          begin
+            check = MultiJson.load(message)
+            @logger.info('received check request', {
+              :check => check
+            })
+            process_check(check)
+          rescue MultiJson::ParseError => error
+            @logger.error('failed to parse the check request payload', {
+              :message => message,
+              :error => error.to_s
+            })
+          end
         end
       end
     end
@@ -224,7 +231,7 @@ module Sensu
         socket.logger = @logger
         socket.settings = @settings
         socket.transport = @transport
-        socket.reply = false
+        socket.protocol = :udp
       end
     end
 

data/lib/sensu/constants.rb

@@ -1,6 +1,6 @@
 module Sensu
   unless defined?(Sensu::VERSION)
-    VERSION = '0.13.1'
+    VERSION = '0.14.0.beta'
 
     SEVERITIES = %w[ok warning critical unknown]
 

data/lib/sensu/daemon.rb

@@ -8,7 +8,7 @@ gem 'sensu-settings', '1.0.0'
 gem 'sensu-extension', '1.0.0'
 gem 'sensu-extensions', '1.0.0'
 gem 'sensu-transport', '1.0.0'
-gem 'sensu-spawn', '1.0.0'
+gem 'sensu-spawn', '1.1.0'
 
 require 'time'
 require 'uri'

data/lib/sensu/server.rb

@@ -26,14 +26,21 @@ module Sensu
     def setup_keepalives
       @logger.debug('subscribing to keepalives')
       @transport.subscribe(:direct, 'keepalives', 'keepalives', :ack => true) do |message_info, message|
-        client = MultiJson.load(message)
-        @logger.debug('received keepalive', {
-          :client => client
-        })
-        @redis.set('client:' + client[:name], MultiJson.dump(client)) do
-          @redis.sadd('clients', client[:name]) do
-            @transport.ack(message_info)
+        begin
+          client = MultiJson.load(message)
+          @logger.debug('received keepalive', {
+            :client => client
+          })
+          @redis.set('client:' + client[:name], MultiJson.dump(client)) do
+            @redis.sadd('clients', client[:name]) do
+              @transport.ack(message_info)
+            end
           end
+        rescue MultiJson::ParseError => error
+          @logger.error('failed to parse keepalive payload', {
+            :message => message,
+            :error => error.to_s
+          })
         end
       end
     end
@@ -447,13 +454,20 @@ module Sensu
     def setup_results
       @logger.debug('subscribing to results')
       @transport.subscribe(:direct, 'results', 'results', :ack => true) do |message_info, message|
-        result = MultiJson.load(message)
-        @logger.debug('received result', {
-          :result => result
-        })
-        process_result(result)
-        EM::next_tick do
-          @transport.ack(message_info)
+        begin
+          result = MultiJson.load(message)
+          @logger.debug('received result', {
+            :result => result
+          })
+          process_result(result)
+          EM::next_tick do
+            @transport.ack(message_info)
+          end
+        rescue MultiJson::ParseError => error
+          @logger.error('failed to parse result payload', {
+            :message => message,
+            :error => error.to_s
+          })
         end
       end
     end

data/lib/sensu/socket.rb

@@ -1,15 +1,184 @@
+require 'multi_json'
+
 module Sensu
+  # EventMachine connection handler for the Sensu client's socket.
+  #
+  # The Sensu client listens on localhost, port 3030 (by default), for
+  # UDP and TCP traffic. This allows software running on the host to
+  # push check results (that may contain metrics) into Sensu, without
+  # needing to know anything about Sensu's internal implementation.
+  #
+  # The socket only accepts 7-bit ASCII-encoded data.
+  #
+  # Although the Sensu client accepts UDP and TCP traffic, you must be
+  # aware of the UDP protocol limitations. Any data you send over UDP
+  # must fit in a single datagram and you will not receive a response
+  # (no confirmation).
+  #
+  # == UDP Protocol ==
+  #
+  # If the socket receives a message containing whitespace and the
+  # string +'ping'+, it will ignore it.
+  #
+  # The socket assumes all other messages will contain a single,
+  # complete, JSON hash. The hash must be a valid JSON check result.
+  # Deserialization failures will be logged at the ERROR level by the
+  # Sensu client, but the sender of the invalid data will not be
+  # notified.
+  #
+  # == TCP Protocol ==
+  #
+  # If the socket receives a message containing whitespace and the
+  # string +'ping'+, it will respond with the message +'pong'+.
+  #
+  # The socket assumes any other stream will be a single, complete,
+  # JSON hash. A deserialization failure will be logged at the WARN
+  # level by the Sensu client and respond with the message
+  # +'invalid'+. An +'ok'+ response indicates the Sensu client
+  # successfully received the JSON hash and will publish the check
+  # result.
+  #
+  # Streams can be of any length. The socket protocol does not require
+  # any headers, instead the socket tries to parse everything it has
+  # been sent each time a chunk of data arrives. Once the JSON parses
+  # successfully, the Sensu client publishes the result. After
+  # +WATCHDOG_DELAY+ (default is 500 msec) since the most recent chunk
+  # of data was received, the agent will give up on the sender, and
+  # instead respond +'invalid'+ and close the connection.
   class Socket < EM::Connection
-    attr_accessor :logger, :settings, :transport, :reply
+    class DataError < StandardError; end
+
+    attr_accessor :logger, :settings, :transport, :protocol
+
+    # The number of seconds that may elapse between chunks of data
+    # from a sender before it is considered dead, and the connection
+    # is close.
+    WATCHDOG_DELAY = 0.5
+
+    #
+    # Sensu::Socket operating mode enum.
+    #
+
+    # ACCEPT mode. Append chunks of data to a buffer and test to see
+    # whether the buffer contents are valid JSON.
+    MODE_ACCEPT = :ACCEPT
 
+    # REJECT mode. No longer receiving data from sender. Discard
+    # chunks of data in this mode, the connection is being closed.
+    MODE_REJECT = :REJECT
+
+    # Initialize instance variables that will be used throughout the
+    # lifetime of the connection. This method is called when the
+    # network connection has been established, and immediately after
+    # responding to a sender.
+    def post_init
+      @protocol ||= :tcp
+      @data_buffer = ''
+      @parse_error = nil
+      @watchdog = nil
+      @mode = MODE_ACCEPT
+    end
+
+    # Send a response to the sender, close the
+    # connection, and call post_init().
+    #
+    # @param [String] data to send as a response.
     def respond(data)
-      unless @reply == false
+      if @protocol == :tcp
         send_data(data)
+        close_connection_after_writing
       end
+      post_init
     end
 
-    def receive_data(data)
-      if data =~ /[\x80-\xff]/n
+    # Cancel the current connection watchdog.
+    def cancel_watchdog
+      if @watchdog
+        @watchdog.cancel
+      end
+    end
+
+    # Reset (or start) the connection watchdog.
+    def reset_watchdog
+      cancel_watchdog
+      @watchdog = EM::Timer.new(WATCHDOG_DELAY) do
+        @mode = MODE_REJECT
+        @logger.warn('discarding data buffer for sender and closing connection', {
+          :data => @data_buffer,
+          :parse_error => @parse_error
+        })
+        respond('invalid')
+      end
+    end
+
+    # Validate check result attributes.
+    #
+    # @param [Hash] check result to validate.
+    def validate_check_result(check)
+      unless check[:name] =~ /^[\w\.-]+$/
+        raise DataError, 'check name must be a string and cannot contain spaces or special characters'
+      end
+      unless check[:output].is_a?(String)
+        raise DataError, 'check output must be a string'
+      end
+      unless check[:status].is_a?(Integer)
+        raise DataError, 'check status must be an integer'
+      end
+    end
+
+    # Publish a check result to the Sensu transport.
+    #
+    # @param [Hash] check result.
+    def publish_check_result(check)
+      payload = {
+        :client => @settings[:client][:name],
+        :check => check.merge(:issued => Time.now.to_i)
+      }
+      @logger.info('publishing check result', {
+        :payload => payload
+      })
+      @transport.publish(:direct, 'results', MultiJson.dump(payload))
+    end
+
+    # Process a check result. Set check result attribute defaults,
+    # validate the attributes, publish the check result to the Sensu
+    # transport, and respond to the sender with the message +'ok'+.
+    #
+    # @param [Hash] check result to be validated and published.
+    # @raise [DataError] if +check+ is invalid.
+    def process_check_result(check)
+      check[:status] ||= 0
+      validate_check_result(check)
+      publish_check_result(check)
+      respond('ok')
+    end
+
+    # Parse a JSON check result. For UDP, immediately raise a parser
+    # error. For TCP, record parser errors, so the connection
+    # +watchdog+ can report them.
+    #
+    # @param [String] data to parse for a check result.
+    def parse_check_result(data)
+      begin
+        check = MultiJson.load(data)
+        cancel_watchdog
+        process_check_result(check)
+      rescue MultiJson::ParseError, ArgumentError => error
+        if @protocol == :tcp
+          @parse_error = error.to_s
+        else
+          raise error
+        end
+      end
+    end
+
+    # Process the data received. This method validates the data
+    # encoding, provides ping/pong functionality, and passes potential
+    # check results on for further processing.
+    #
+    # @param [String] data to be processed.
+    def process_data(data)
+      if data.bytes.find { |char| char > 0x80 }
         @logger.warn('socket received non-ascii characters')
         respond('invalid')
       elsif data.strip == 'ping'
@@ -20,32 +189,9 @@ module Sensu
           :data => data
         })
         begin
-          check = MultiJson.load(data)
-          check[:issued] = Time.now.to_i
-          check[:status] ||= 0
-          validates = [
-            check[:name] =~ /^[\w\.-]+$/,
-            check[:output].is_a?(String),
-            check[:status].is_a?(Integer)
-          ].all?
-          if validates
-            payload = {
-              :client => @settings[:client][:name],
-              :check => check
-            }
-            @logger.info('publishing check result', {
-              :payload => payload
-            })
-            @transport.publish(:direct, 'results', MultiJson.dump(payload))
-            respond('ok')
-          else
-            @logger.warn('invalid check result', {
-              :check => check
-            })
-            respond('invalid')
-          end
-        rescue MultiJson::ParseError => error
-          @logger.warn('check result must be valid json', {
+          parse_check_result(data)
+        rescue => error
+          @logger.error('failed to process check result from socket', {
             :data => data,
             :error => error.to_s
           })
@@ -53,6 +199,27 @@ module Sensu
         end
       end
     end
+
+    # This method is called whenever data is received. For UDP, it
+    # will only be called once, the original data length can be
+    # expected. For TCP, this method may be called several times, data
+    # received is buffered. TCP connections require a +watchdog+.
+    #
+    # @param [String] data received from the sender.
+    def receive_data(data)
+      unless @mode == MODE_REJECT
+        case @protocol
+        when :udp
+          process_data(data)
+        when :tcp
+          if EM.reactor_running?
+            reset_watchdog
+          end
+          @data_buffer << data
+          process_data(@data_buffer)
+        end
+      end
+    end
   end
 
   class SocketHandler < EM::Connection

data/sensu.gemspec

@@ -22,15 +22,15 @@ Gem::Specification.new do |s|
   s.add_dependency('sensu-extension', '1.0.0')
   s.add_dependency('sensu-extensions', '1.0.0')
   s.add_dependency('sensu-transport', '1.0.0')
-  s.add_dependency('sensu-spawn', '1.0.0')
+  s.add_dependency('sensu-spawn', '1.1.0')
   s.add_dependency('em-redis-unified', '0.5.0')
   s.add_dependency('sinatra', '1.3.5')
   s.add_dependency('async_sinatra', '1.0.0')
   s.add_dependency('thin', '1.5.0') unless RUBY_PLATFORM =~ /java/
 
-  s.add_development_dependency('rake')
-  s.add_development_dependency('rspec')
-  s.add_development_dependency('em-http-request')
+  s.add_development_dependency('rake', '~> 10.3')
+  s.add_development_dependency('rspec', '~> 3.0.0')
+  s.add_development_dependency('em-http-request', '~> 1.1')
 
   s.files         = Dir.glob('{bin,lib}/**/*') + %w[sensu.gemspec README.md CHANGELOG.md MIT-LICENSE.txt]
   s.executables   = Dir.glob('bin/**/*').map { |file| File.basename(file) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0.beta
 platform: ruby
 authors:
 - Sean Porter
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-28 00:00:00.000000000 Z
+date: 2014-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -129,14 +129,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: em-redis-unified
   requirement: !ruby/object:Gem::Requirement
@@ -197,52 +197,52 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: em-http-request
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 description: A monitoring framework that aims to be simple, malleable, and scalable.
 email:
 - portertech@gmail.com
 - justin.kolberg@sonian.net
 executables:
-- sensu-api
-- sensu-client
 - sensu-server
+- sensu-client
+- sensu-api
 extensions: []
 extra_rdoc_files: []
 files:
@@ -279,13 +279,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A monitoring framework
 test_files: []
+has_rdoc: false