fluent-plugin-ping-message 0.0.2 → 0.0.3

data/README.md

@@ -1,6 +1,9 @@
 # fluent-plugin-ping-message
 
-Fluentd plugin to generate ping messages for monitoring of heatbeats.
+Fluentd plugins:
+
+* to generate ping messages for monitoring of heatbeats
+* to check ping messages not arrived, and emits notifications
 
 ## Configuration
 
@@ -25,10 +28,23 @@ Change ping message interval into 30 seconds, and fix tag and 'data':
     #=> tag: 'ping.webserver'
     #   message: {'data' => 'ping message from your.hostname.local'}
 
+### PingMessageCheckerOutput
+
+To receive ping messages and checks ping message in-arrival, use `type ping_message_checker`:
+
+    <match ping.**>
+      type ping_message_checker
+      tag missing.ping
+      check_interval  3600   # 1hour by default
+      notification_times 3   # 3 times by default
+    </match>
+
+With this configuration, this plugin save the list of ping messages' 'data' field values. And then, at the time of ping message missing, notification message emitted with `tag`.
+
 ## TODO
 
-* 'PingMessageWatchdogOutput'
-  * accepts ping messages and notify hosts ping messages cannot be found
+* add feature to output ping messages list
+* patches welcome!
 
 ## Copyright
 

data/fluent-plugin-ping-message.gemspec

@@ -1,11 +1,11 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-ping-message"
-  gem.version       = "0.0.2"
+  gem.version       = "0.0.3"
   gem.authors       = ["TAGOMORI Satoshi"]
   gem.email         = ["tagomoris@gmail.com"]
   gem.description   = %q{for heartbeat monitoring of Fluentd processes}
-  gem.summary       = %q{Fluentd plugin to send ping message}
+  gem.summary       = %q{Fluentd plugin to send/check ping messages}
   gem.homepage      = "https://github.com/tagomoris/fluent-plugin-ping-message"
 
   gem.files         = `git ls-files`.split($\)

data/lib/fluent/plugin/out_ping_message.rb

@@ -0,0 +1,107 @@
+require 'fluent/mixin/config_placeholders'
+
+class Fluent::PingMessageCheckerOutput < Fluent::Output
+  Fluent::Plugin.register_output('ping_message_checker', self)
+
+  config_param :data_field, :string, :default => 'data'
+
+  config_param :tag, :string
+
+  config_param :notifications, :bool, :default => true
+  # config_param :report_list, :bool, :default => false # not implemented now
+
+  config_param :check_interval, :integer, :default => 3600
+  config_param :notification_times, :integer, :default => 3
+
+  config_param :exclude_pattern, :string, :default => nil
+
+  include Fluent::Mixin::ConfigPlaceholders
+
+  def configure(conf)
+    super
+    @exclude_regex = @exclude_pattern ? Regexp.compile(@exclude_pattern) : nil
+  end
+
+  def start
+    super
+    @checks = {}
+    # 'data' => notification_counts
+    # -1: checked in previous term, but not in this term
+    #  0: checked in this term
+    # 1,2,...: counts of ping missing notifications
+    @mutex = Mutex.new
+    start_watch
+  end
+
+  def shutdown
+    super
+    @watcher.terminate
+    @watcher.join
+  end
+
+  def start_watch
+    @watcher = Thread.new(&method(:watch))
+  end
+
+  def update_state(list)
+    @mutex.synchronize do
+      list.each do |data|
+        if not @checks.has_key?(data) or @checks[data] != 0
+          @checks[data] = 0
+        end
+      end
+    end
+  end
+
+  def check_and_flush
+    notifications = []
+
+    @mutex.synchronize do
+      @checks.keys.each do |key|
+        if @checks[key] == 0
+          @checks[key] = -1
+
+        elsif @checks[key] < 0
+          notifications.push(key)
+          @checks[key] = 1
+
+        else # @checks[key] > 0
+          if @checks[key] < @notification_times
+            notifications.push(key)
+            @checks[key] += 1
+          else
+            @checks.delete(key)
+          end
+        end
+      end
+    end
+    
+    if @notifications
+      notifications.each do |data|
+        Fluent::Engine.emit(@tag, Fluent::Engine.now, data)
+      end
+    end
+  end
+
+  def watch
+    @last_checked = Fluent::Engine.now
+    loop do
+      sleep 1
+      if Fluent::Engine.now - @last_checked >= @check_interval
+        check_and_flush()
+        @last_checked = Fluent::Engine.now
+      end
+    end
+  end
+
+  def emit(tag, es, chain)
+    datalist = []
+    es.each do |time,record|
+      datalist.push record[@data_field] if @exclude_regex.nil? or not @exclude_regex.match(record[@data_field])
+    end
+    datalist.uniq!
+    update_state(datalist)
+
+    chain.next
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-ping-message
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-27 00:00:00.000000000 Z
+date: 2012-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -89,6 +89,7 @@ files:
 - Rakefile
 - fluent-plugin-ping-message.gemspec
 - lib/fluent/plugin/in_ping_message.rb
+- lib/fluent/plugin/out_ping_message.rb
 - test/helper.rb
 homepage: https://github.com/tagomoris/fluent-plugin-ping-message
 licenses: []
@@ -113,6 +114,6 @@ rubyforge_project:
 rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
-summary: Fluentd plugin to send ping message
+summary: Fluentd plugin to send/check ping messages
 test_files:
 - test/helper.rb