fluent-plugin-sensu 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+
+script: bundle exec rake test

data/README.md

@@ -47,19 +47,19 @@ which contains attributes as follows.
 Attributes are indicated
 by [JSONPath](http://goessner.net/articles/JsonPath/) expressions.
 
-* `$.name`
+* [`$.name`](#name-attribute)
   * The check name to identify the check.
-* `$.output`
+* [`$.output`](#output-attribute)
   * An arbitrary string to describe the check result.
   * This attribute is often used to contain metric values.
-* `$.status`
+* [`$.status`](#status-attribute)
   * The severity of the check result.
   * 0 (OK), 1 (WARNING), 2 (CRITICAL) or 3 (UNKNOWN or CUSTOM).
 
 The check result can also contain other attributes.
 This plugin supports the attributes below.
 
-* `$.type`
+* [`$.type`](#type-attribute)
   * Either "standard" or "metric".
   * If the attribute is set to "standard", the sensu-server creates an event
     only when the status is not OK or when the status is changed to OK.
@@ -67,27 +67,28 @@ This plugin supports the attributes below.
     even if the status is OK.
     It is useful when Sensu sends check results to metrics collectors
     such as [Graphite](http://graphite.wikidot.com/).
-* `$.ttl`
+* [`$.ttl`](#ttl-attribute)
   * The time to live (TTL) in seconds,
     until the check result is considered stale.
     If TTL expires, sensu-server creates an event.
   * This attribute is useful when you want to be notified
     when logs are not output for a certain period.
   * Same as `freshness_threshold` in Nagios.
-* `$.handlers`
+* [`$.handlers`](#handlers-attributes)
   * The names of handlers which process events created for the check.
-* `$.low_flap_threshold` and `$.high_flap_threshold`
+* [`$.low_flap_threshold` and `$.high_flap_threshold`](
+  #low_flap_threshold-and-high_flap_threshold-attributes)
   * Threshold percentages to determine the status is considered "flapping,"
     or the state is changed too frequently.
   * Same as the options in Nagios.
     See the description of [Flap Detection](
     https://assets.nagios.com/downloads/nagioscore/docs/nagioscore/3/en/flapping.html)
     in Nagios.
-* `$.source`
+* [`$.source`](#source-attribute)
   * The source of the check, such as servers or network switches.
   * If this attribute is not specified,
     the host of sensu-client is considered as the source.
-* `$.executed`
+* [`$.executed`](#executed-attribute)
   * The timestamp on which the check is executed.
   * Note that there is also another timestamp attribute named `issued`,
     which is automatically measured by sensu-client process.

data/fluent-plugin-sensu.gemspec

@@ -6,7 +6,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-sensu"
-  spec.version       = '0.0.1'
+  spec.version       = '0.0.2'
   spec.authors       = ["MIYAKAWA Taku"]
   spec.email         = ["miyakawa.taku@gmail.com"]
   spec.description   = 'Fluentd output plugin to send checks' +

data/lib/fluent/plugin/out_sensu.rb

@@ -1,5 +1,4 @@
 # -*- encoding: utf-8 -*-
-# vim: et sw=2 sts=2
 
 module Fluent
 
@@ -88,6 +87,10 @@ module Fluent
     # Options for "executed" attribute.
     config_param :check_executed_field, :string, :default => nil
 
+    # Buffering option.
+    # Set to 1 second by default so that checks are not delayed so much.
+    config_param :flush_interval, :time, :default => 1
+
     # Load modules.
     private
     def initialize
@@ -116,11 +119,16 @@ module Fluent
     # Reject invalid check_low_flap_threshold and check_high_flap_threshold
     private
     def reject_invalid_flapping_thresholds
-      if @check_low_flap_threshold.nil? ^ @check_high_flap_threshold.nil?
+      # Thresholds must be specified together or not specified at all.
+      only_one_threshold_is_specified =
+        @check_low_flap_threshold.nil? ^ @check_high_flap_threshold.nil?
+      if only_one_threshold_is_specified
         raise ConfigError,
           "'check_low_flap_threshold' and 'check_high_flap_threshold'" +
-          " specified togher, or not specified at all."
+          " must be specified togher, or not specified at all."
       end
+
+      # Check 0 <= check_low_flap_threshold <= check_high_flap_threshold <= 100
       if @check_low_flap_threshold
         in_order = 0 <= @check_low_flap_threshold &&
           @check_low_flap_threshold <= @check_high_flap_threshold &&
@@ -139,40 +147,46 @@ module Fluent
       [tag, time, record].to_msgpack
     end
 
-    # Send a check
+    # Send a check result for each data.
     public
     def write(chunk)
-      results = []
       chunk.msgpack_each { |(tag, time, record)|
-        payload = {
-          'name' => determine_check_name(tag, record),
-          'output' => determine_output(tag, record),
-          'status' => determine_status(tag, record),
-          'type' => @check_type,
-          'handlers' => @check_handlers,
-          'executed' => determine_executed_time(tag, time, record),
-          'fluentd' => {
-            'tag' => tag,
-            'time' => time.to_i,
-            'record' => record,
-          },
-        }
-        add_attribute_if_present(
-          payload, 'ttl', @check_ttl)
-        add_attribute_if_present(
-          payload, 'low_flap_threshold', @check_low_flap_threshold)
-        add_attribute_if_present(
-          payload, 'high_flap_threshold', @check_high_flap_threshold)
-        add_attribute_if_present(
-          payload, 'source', determine_source(tag, record))
+        payload = make_check_result(tag, time, record)
         send_check(@server, @port, payload)
       }
     end
 
-    # Send a check to sensu-client.
+    # Make a check result for the Fluentd data.
+    private
+    def make_check_result(tag, time, record)
+      check_result = {
+        'name' => determine_check_name(tag, record),
+        'output' => determine_output(tag, record),
+        'status' => determine_status(tag, record),
+        'type' => @check_type,
+        'handlers' => @check_handlers,
+        'executed' => determine_executed_time(tag, time, record),
+        'fluentd' => {
+          'tag' => tag,
+          'time' => time.to_i,
+          'record' => record,
+        },
+      }
+      add_attribute_if_present(
+        check_result, 'ttl', @check_ttl)
+      add_attribute_if_present(
+        check_result, 'low_flap_threshold', @check_low_flap_threshold)
+      add_attribute_if_present(
+        check_result, 'high_flap_threshold', @check_high_flap_threshold)
+      add_attribute_if_present(
+        check_result, 'source', determine_source(tag, record))
+      return check_result
+    end
+
+    # Send a check result to sensu-client.
     private
-    def send_check(server, port, payload)
-      json = payload.to_json
+    def send_check(server, port, check_result)
+      json = check_result.to_json
       sensu_client = TCPSocket.open(@server, @port)
       begin
         sensu_client.puts(json)
@@ -181,10 +195,10 @@ module Fluent
       end
     end
 
-    # Adds an attribute to the payload if present.
+    # Adds an attribute to the check result if present.
     private
-    def add_attribute_if_present(payload, name, value)
-      payload[name] = value if value
+    def add_attribute_if_present(check_result, name, value)
+      check_result[name] = value if value
     end
 
     # Determines "name" attribute of a check.
@@ -202,14 +216,17 @@ module Fluent
                  :value => check_name)
         # Fall through
       end
+
       # check_name option
       return @check_name if @check_name
+
       # Tag
       return tag if tag =~ CHECK_NAME_PATTERN
-      # Default value
       log.warn('Invalid check name in the tag.' +
                'Fallback to the constant "fluent-plugin-sensu".',
                :tag => tag)
+
+      # Default value
       return 'fluent-plugin-sensu'
     end
 
@@ -224,8 +241,10 @@ module Fluent
                 :tag => tag, :check_output_field => @check_output_field)
         # Fall through
       end
+
       # Returns the option value
       return @check_output if @check_output
+
       # Default to JSON notation of the record
       return record.to_json
     end
@@ -244,6 +263,7 @@ module Fluent
                 :tag => tag, :check_status_field => @check_status_field,
                 :value => status_field_val)
       end
+
       # Returns the default
       return @check_status
     end
@@ -262,27 +282,35 @@ module Fluent
     # Determines "source" attribute of a check.
     private
     def determine_source(tag, record)
+      # Read the field
       if @check_source_field
         source = record[@check_source_field]
         return source if source
         log.warn('the field for "source" attribute is absent',
                 :tag => tag, :check_source_field => @check_source_field)
       end
+
+      # Default to "check_source" option or N/A
       return @check_source
     end
 
     # Determines "executed" attribute of a check.
     private
     def determine_executed_time(tag, time, record)
+      # Read the field
       if @check_executed_field
         executed = record[@check_executed_field]
         return executed if executed.is_a?(Integer)
         log.warn('the field for "executed" attribute is absent',
                 :tag => tag, :check_executed_field => @check_executed_field)
       end
+
+      # Default to the time of Fluentd data
       return time
     end
 
   end
 
 end
+
+# vim: et sw=2 sts=2

data/test/plugin/test_out_sensu.rb

@@ -30,6 +30,13 @@ class SensuOutputTest < Test::Unit::TestCase
   # }}}1
   # Default value {{{1
 
+  # flush_interval is set to 1 second so that checks are not delayed so much
+  def test_default_buffer_setting
+    driver = create_driver('', 'ddos')
+    flush_interval = driver.instance.instance_eval{ @flush_interval }
+    assert_equal 1, flush_interval
+  end
+
   # Send default values for empty data and empty setting
   def test_write_empty_data_with_empty_setting
     driver = create_driver('', 'ddos')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-sensu
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-02 00:00:00.000000000 Z
+date: 2015-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,6 +99,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -122,7 +123,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3040551287980706948
+      hash: 494592010274468206
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -131,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3040551287980706948
+      hash: 494592010274468206
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23