fluent-plugin-ping-message 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d22f7754cde3ac1dfd63bebc4a11d243a640490
-  data.tar.gz: 35b803259bd8b3b6d1ae2bbefa8a1a7fb8a54966
+  metadata.gz: a8b9231870fecfb91df01d5f379a8324e1538799
+  data.tar.gz: b5ba524177f55d2dc40216ad7e386b145f726200
 SHA512:
-  metadata.gz: f2ef631013df77f26d826cbaf59e9725c304d1209b63ba379ead64e0776cbba9278d62a4dbf3e70a70d6ff21bd7bacd3621094a7df21c4a7acf1e9924a1e458f
-  data.tar.gz: 07b97be23c0f7d869989f5a9d33138d663ef7bd5c3fe4864b74a9493225a52f5210fc3018e8a358e924987b1a6bf9303f29f32b8bcb71c145659cebea2aac288
+  metadata.gz: 22aca6fb111b552b6a10be0bb0291ffbc5c5fb727fc5cc6d77df538d263ae44f21d2df50da125c916b1ae780fa47feb4baf3b6df1ae5ab06face873d220f770f
+  data.tar.gz: ac4eb11ce057a2f6b1ad724598b6314b3a98d9ac44407f303f2e2efe6809e2b183374d26e8f4fe29df69b30ee700c0333a2be2a1746acb71563bcbdeb852f2e1

data/.travis.yml

@@ -3,6 +3,7 @@ language: ruby
 rvm:
   - 2.1
   - 2.2
+  - 2.3.1
 
 gemfile:
   - Gemfile

data/README.md

@@ -13,20 +13,63 @@ To generate 1 ping message per 60seconds(default):
 
     <source>
       @type ping_message
+      @label @heartbeat_events
     </source>
-    #=> tag: 'ping'
-    #   message: {'data' => 'your.hostname.local'}
+    
+    <label @heartbeat_events>
+      #=> tag: 'ping'
+      #   message: {'data' => 'your.hostname.local'}
+      <match ping>
+        # send hosts w/ ping_message_checker
+      </match>
+    </label>
 
 Change ping message interval into 30 seconds, and fix `tag` and `data`:
 
     <source>
       @type ping_message
+      @label @heartbeat_events
       tag ping.webserver
       interval 30
       data ping message from ${hostname}
     </source>
-    #=> tag: 'ping.webserver'
-    #   message: {'data' => 'ping message from your.hostname.local'}
+    
+    <label @heartbeat_events>
+      #=> tag: 'ping.webserver'
+      #   message: {'data' => 'ping message from your.hostname.local'}
+    </label>
+
+`<inject>` section is available to include hostname key or timestamp (unixtime, float or string).
+
+    <source>
+      @type ping_message
+      @label @heartbeat_events
+      tag      ping
+      interval 30
+      data     "this is ping message"
+      <inject>
+        hostname_key host     # {"host": "my.hostname.example.com"}
+        time_key     time
+        time_type    unixtime # {"time": 1486014439}
+      </inject>
+    </source>
+
+Example using string time format in specified time zone:
+
+    <source>
+      @type ping_message
+      @label @heartbeat_events
+      tag      ping
+      interval 30
+      data     "this is ping message"
+      <inject>
+        hostname_key host     # {"host": "my.hostname.example.com"}
+        time_key     time
+        time_type    string
+        time_format  "%Y-%m-%d %H:%M:%S" # {"time": "2017-02-01 14:50:38"}
+        timezone     -0700    # or "localtime yes" / "localtime no" (UTC), ...
+      </inject>
+    </source>
 
 ### PingMessageCheckerOutput
 

data/fluent-plugin-ping-message.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-ping-message"
-  gem.version       = "0.2.1"
+  gem.version       = "1.0.0"
   gem.authors       = ["TAGOMORI Satoshi"]
   gem.email         = ["tagomoris@gmail.com"]
   gem.description   = %q{for heartbeat monitoring of Fluentd processes}
@@ -14,8 +14,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency "fluentd", "< 0.14.0"
-  gem.add_runtime_dependency "fluent-mixin-config-placeholders", ">= 0.3.0"
+  gem.add_runtime_dependency "fluentd", ">= 0.14.0"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "test-unit", "~> 3.0"
 end

data/lib/fluent/plugin/in_ping_message.rb

@@ -1,49 +1,35 @@
-require 'fluent/input'
-require 'fluent/mixin/config_placeholders'
+require 'fluent/plugin/input'
+require 'socket'
 
-class Fluent::PingMessageInput < Fluent::Input
+class Fluent::Plugin::PingMessageInput < Fluent::Plugin::Input
   Fluent::Plugin.register_input('ping_message', self)
 
-  # Define `log` method for v0.10.42 or earlier
-  unless method_defined?(:log)
-    define_method("log") { $log }
-  end
-
-  include Fluent::Mixin::ConfigPlaceholders
-
-  config_param :tag, :string, :default => 'ping'
-  config_param :interval, :integer, :default => 60
-  config_param :data, :string, :default => `hostname`.chomp
+  helpers :timer, :inject
 
-  # Define `router` method of v0.12 to support v0.10.57 or earlier
-  unless method_defined?(:router)
-    define_method("router") { Fluent::Engine }
-  end
+  config_param :tag, :string, default: 'ping'
+  config_param :interval, :integer, default: 60
+  config_param :data, :string, default: Socket.gethostname
+  config_param :hostname, :string, default: nil
 
-  def start
+  def configure(conf)
     super
-    start_pingloop
-  end
 
-  def shutdown
-    super
-    @loop.terminate
-    @loop.join
+    if @data.include?('${hostname}')
+      @hostname ||= Socket.gethostname
+      @data.gsub!('${hostname}', @hostname)
+    end
   end
 
-  def start_pingloop
-    @loop = Thread.new(&method(:pingloop))
+  def multi_workers_ready?
+    true
   end
 
-  def pingloop
-    @last_checked = Fluent::Engine.now
-    loop do
-      sleep 0.5
-      if Fluent::Engine.now - @last_checked >= @interval
-        @last_checked = Fluent::Engine.now
-        router.emit(@tag, Fluent::Engine.now, {'data' => @data})
-      end
+  def start
+    super
+    timer_execute(:in_ping_message_pingpong, @interval) do
+      now = Fluent::Engine.now
+      record = inject_values_to_record(@tag, now, {'data' => @data})
+      router.emit(@tag, now, record)
     end
   end
-
 end

data/lib/fluent/plugin/out_ping_message_checker.rb

@@ -1,37 +1,27 @@
-require 'fluent/mixin/config_placeholders'
+require 'fluent/plugin/output'
 
-class Fluent::PingMessageCheckerOutput < Fluent::Output
+class Fluent::Plugin::PingMessageCheckerOutput < Fluent::Plugin::Output
   Fluent::Plugin.register_output('ping_message_checker', self)
 
-  # Define `log` method for v0.10.42 or earlier
-  unless method_defined?(:log)
-    define_method("log") { $log }
-  end
-
-  # Define `router` method of v0.12 to support v0.10.57 or earlier
-  unless method_defined?(:router)
-    define_method("router") { Fluent::Engine }
-  end
-
-  config_param :data_field, :string, :default => 'data'
+  helpers :event_emitter, :timer
 
   config_param :tag, :string
+  config_param :data_field, :string, default: 'data'
+  config_param :notifications, :bool, default: true
 
-  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
+  config_param :check_interval, :time, default: 3600
+  config_param :notification_times, :integer, default: 3
+  config_param :exclude_pattern, :string, default: nil
 
   def configure(conf)
     super
     @exclude_regex = @exclude_pattern ? Regexp.compile(@exclude_pattern) : nil
   end
 
+  def multi_workers_ready?
+    true
+  end
+
   def start
     super
     @checks = {}
@@ -40,17 +30,26 @@ class Fluent::PingMessageCheckerOutput < Fluent::Output
     #  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
+    timer_execute(:out_ping_messager_chacker_timer, @check_interval) do
+      begin
+        check_and_flush
+      rescue => e
+        log.warn "unexpected error", error: e
+        log.warn_backtrace
+      end
+    end
   end
 
-  def start_watch
-    @watcher = Thread.new(&method(:watch))
+  def process(tag, es)
+    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)
+  rescue => e
+    log.warn "unexpected error while processing events", error: e
+    log.warn_backtrace
   end
 
   def update_state(list)
@@ -85,7 +84,7 @@ class Fluent::PingMessageCheckerOutput < Fluent::Output
         end
       end
     end
-    
+
     if @notifications
       notifications.each do |data|
         router.emit(@tag, Fluent::Engine.now, {@data_field => data})
@@ -94,32 +93,4 @@ class Fluent::PingMessageCheckerOutput < Fluent::Output
 
     notifications
   end
-
-  def watch
-    @last_checked = Fluent::Engine.now
-    loop do
-      sleep 1
-      begin
-        if Fluent::Engine.now - @last_checked >= @check_interval
-          check_and_flush()
-          @last_checked = Fluent::Engine.now
-        end
-      rescue => e
-        log.warn "out_ping_message_checker: #{e.class} #{e.message} #{e.backtrace.first}"
-      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
-  rescue => e
-    log.warn "out_ping_message_checker: #{e.message} #{e.class} #{e.backtrace.first}"
-  end
 end

data/test/plugin/test_in_ping_message.rb

@@ -0,0 +1,25 @@
+require 'helper'
+require 'fluent/test/driver/input'
+
+class PingMessageCheckerInputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    tag ping.message
+  ]
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::Driver::Input.new(Fluent::Plugin::PingMessageInput).configure(conf)
+  end
+
+  def test_configure
+    assert_nothing_raised {
+      create_driver(CONFIG)
+    }
+    assert_nothing_raised {
+      create_driver('')
+    }
+  end
+end

data/test/plugin/test_out_ping_message_checker.rb

@@ -1,4 +1,5 @@
 require 'helper'
+require 'fluent/test/driver/output'
 
 class PingMessageCheckerOutputTest < Test::Unit::TestCase
   def setup
@@ -9,38 +10,38 @@ class PingMessageCheckerOutputTest < Test::Unit::TestCase
     tag ping.message.checker
   ]
 
-  def create_driver(conf = CONFIG, tag='test.input')
-    Fluent::Test::OutputTestDriver.new(Fluent::PingMessageCheckerOutput, tag).configure(conf)
+  def create_driver(conf = CONFIG)
+    Fluent::Test::Driver::Output.new(Fluent::Plugin::PingMessageCheckerOutput).configure(conf)
   end
 
   def test_configure
     assert_nothing_raised {
-      d = create_driver(CONFIG)
+      create_driver(CONFIG)
     }
     assert_raise(Fluent::ConfigError) {
-      d = create_driver('')
+      create_driver('')
     }
   end
 
   def test_found_not_emit
-    d1 = create_driver(CONFIG, 'ping.webserver')
+    d1 = create_driver(CONFIG)
     flushed = nil
-    d1.run do
-      d1.emit({'data' => 'your.hostname.local'})
+    d1.run(default_tag: 'ping.webserver') do
+      d1.feed({'data' => 'your.hostname.local'})
       flushed = d1.instance.check_and_flush
       assert_equal [], flushed
 
-      d1.emit({'data' => 'your.hostname.local'})
+      d1.feed({'data' => 'your.hostname.local'})
       flushed = d1.instance.check_and_flush
       assert_equal [], flushed
     end
   end
 
   def test_missing_emit
-    d1 = create_driver(CONFIG, 'ping.webserver')
+    d1 = create_driver(CONFIG)
     flushed = nil
-    d1.run do
-      d1.emit({'data' => 'your.hostname.local'})
+    d1.run(default_tag: 'ping.webserver') do
+      d1.feed({'data' => 'your.hostname.local'})
       flushed = d1.instance.check_and_flush
       assert_equal [], flushed
 
@@ -50,10 +51,10 @@ class PingMessageCheckerOutputTest < Test::Unit::TestCase
   end
 
   def test_notification_times
-    d1 = create_driver(CONFIG + %[notification_times 3], 'ping.webserver')
+    d1 = create_driver(CONFIG + %[notification_times 3])
     flushed = nil
-    d1.run do
-      d1.emit({'data' => 'your.hostname.local'})
+    d1.run(default_tag: 'ping.webserver') do
+      d1.feed({'data' => 'your.hostname.local'})
       flushed = d1.instance.check_and_flush
       assert_equal [], flushed
 
@@ -72,10 +73,10 @@ class PingMessageCheckerOutputTest < Test::Unit::TestCase
   end
 
   def test_recovery
-    d1 = create_driver(CONFIG + %[notification_times 3], 'ping.webserver')
+    d1 = create_driver(CONFIG + %[notification_times 3])
     flushed = nil
-    d1.run do
-      d1.emit({'data' => 'your.hostname.local'})
+    d1.run(default_tag: 'ping.webserver') do
+      d1.feed({'data' => 'your.hostname.local'})
       flushed = d1.instance.check_and_flush
       assert_equal [], flushed
 
@@ -85,7 +86,7 @@ class PingMessageCheckerOutputTest < Test::Unit::TestCase
       flushed = d1.instance.check_and_flush
       assert_equal 'your.hostname.local', flushed.first
 
-      d1.emit({'data' => 'your.hostname.local'})
+      d1.feed({'data' => 'your.hostname.local'})
       flushed = d1.instance.check_and_flush
       assert_equal [], flushed
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-ping-message
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - TAGOMORI Satoshi
@@ -12,32 +12,18 @@ date: 2017-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.14.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.14.0
-- !ruby/object:Gem::Dependency
-  name: fluent-mixin-config-placeholders
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -84,6 +70,7 @@ files:
 - lib/fluent/plugin/in_ping_message.rb
 - lib/fluent/plugin/out_ping_message_checker.rb
 - test/helper.rb
+- test/plugin/test_in_ping_message.rb
 - test/plugin/test_out_ping_message_checker.rb
 homepage: https://github.com/tagomoris/fluent-plugin-ping-message
 licenses:
@@ -111,4 +98,5 @@ specification_version: 4
 summary: Fluentd plugin to send/check ping messages
 test_files:
 - test/helper.rb
+- test/plugin/test_in_ping_message.rb
 - test/plugin/test_out_ping_message_checker.rb