logstash-input-heartbeat 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b757212fd17757e1b91e19640b8ffedf91c940c0
-  data.tar.gz: 0ea012c766294d3741038d3512f5dce730c147fb
+  metadata.gz: 0453e13da1d157935c3e73ccf420f85198069d66
+  data.tar.gz: ec269a6b10f45da44a83f282d1f7c65dee35c339
 SHA512:
-  metadata.gz: bfb320af864cb2d7ad9e70c4fa77fe279d241e6adc868c9e2f1fc070bfd52fc346679dedde98eb8751f5e912cdd4951c88683c908b1a113794eceab86006150a
-  data.tar.gz: 1d853db489a5b9b98ac06327be2e3e4c13a9a4588b0f922db400225615d5055abc0f935853d0281dd6f449b36cf6f1a736e00d1afcf5a828c38a3a531f6beb7d
+  metadata.gz: 467e575a02b9eb6711ed79a233acc6dc4a39f5bf416dd4602488aad96de581bea7dba44d5d34351bf2e4b211928b794ee15cfe492857f2478264c69369638b1d
+  data.tar.gz: cb6274d921ca873117b1dc41314425f9513e6f2e5eda041676036af8b33b4517af3c5a5aff6887a52e5b8a14327bd2888c3f5f2bc1fa2e05dbfa1773c15c6f2c

data/Gemfile

@@ -1,4 +1,2 @@
 source 'https://rubygems.org'
-gemspec
-gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
-
+gemspec

data/README.md

@@ -22,7 +22,7 @@ Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com
 #### Code
 - To get started, you'll need JRuby with the Bundler gem installed.
 
-- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization.
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
 
 - Install dependencies
 ```sh
@@ -31,26 +31,15 @@ bundle install
 
 #### Test
 
-```sh
-bundle exec rspec
-```
+- Update your dependencies
 
-The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to:
-```ruby
-gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
-```
-To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example:
-```ruby
-gem "logstash", :github => "elasticsearch/logstash", :ref => "master"
-```
-```ruby
-gem "logstash", :path => "/your/local/logstash"
+```sh
+bundle install
 ```
 
-Then update your dependencies and run your tests:
+- Run tests
 
 ```sh
-bundle install
 bundle exec rspec
 ```
 
@@ -58,13 +47,13 @@ bundle exec rspec
 
 #### 2.1 Run in a local Logstash clone
 
-- Edit Logstash `tools/Gemfile` and add the local plugin path, for example:
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
 ```ruby
 gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
 ```
-- Update Logstash dependencies
+- Install plugin
 ```sh
-rake vendor:gems
+bin/plugin install --no-verify
 ```
 - Run Logstash with your plugin
 ```sh
@@ -74,6 +63,8 @@ At this point any modifications to the plugin code will be applied to this local
 
 #### 2.2 Run in an installed Logstash
 
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
 - Build your plugin gem
 ```sh
 gem build logstash-filter-awesome.gemspec
@@ -90,6 +81,6 @@ All contributions are welcome: ideas, patches, documentation, bug reports, compl
 
 Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
 
-It is more important to me that you are able to contribute.
+It is more important to the community that you are able to contribute.
 
-For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/inputs/heartbeat.rb

@@ -6,7 +6,7 @@ require "socket" # for Socket.gethostname
 
 # Generate heartbeat messages.
 #
-# The general intention of this is to test the performance and 
+# The general intention of this is to test the performance and
 # availability of Logstash.
 #
 
@@ -20,8 +20,8 @@ class LogStash::Inputs::Heartbeat < LogStash::Inputs::Threadable
   # If you set this to `epoch` then this plugin will use the current
   # timestamp in unix timestamp (which is by definition, UTC).  It will
   # output this value into a field called `clock`
-  # 
-  # If you set this to `sequence` then this plugin will send a sequence of 
+  #
+  # If you set this to `sequence` then this plugin will send a sequence of
   # numbers beginning at 0 and incrementing each interval.  It will
   # output this value into a field called `clock`
   #
@@ -34,6 +34,10 @@ class LogStash::Inputs::Heartbeat < LogStash::Inputs::Threadable
   # The default, `60`, means send a message every 60 seconds.
   config :interval, :validate => :number, :default => 60
 
+  # How many times to iterate.
+  # This is typically used only for testing purposes.
+  config :count, :validate => :number, :default => -1
+
   public
   def register
     @host = Socket.gethostname
@@ -43,23 +47,24 @@ class LogStash::Inputs::Heartbeat < LogStash::Inputs::Threadable
     sequence = 0
 
     Stud.interval(@interval) do
-      if @message == "epoch"
-        event = LogStash::Event.new("clock" => Time.now.to_i, "host" => @host)
-      elsif @message == "sequence"
-        event = LogStash::Event.new("clock" => sequence, "host" => @host)
-        sequence += 1
-      else
-        event = LogStash::Event.new("message" => @message, "host" => @host)
-      end
-      
+      sequence += 1
+      event = generate_message(sequence)
       decorate(event)
       queue << event
-
+      break if sequence == @count
     end # loop
 
   end # def run
 
   public
-  def teardown
-  end # def teardown
+  def generate_message(sequence)
+    if @message == "epoch"
+      LogStash::Event.new("clock" => Time.now.to_i, "host" => @host)
+    elsif @message == "sequence"
+      LogStash::Event.new("clock" => sequence, "host" => @host)
+    else
+      LogStash::Event.new("message" => @message, "host" => @host)
+    end
+  end
+
 end # class LogStash::Inputs::Heartbeat

data/logstash-input-heartbeat.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-heartbeat'
-  s.version         = '0.1.2'
+  s.version         = '0.1.4'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This input generates a heartbeat pattern to aid in monitoring Logstash performance & availability"
-  s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program" 
+  s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
   s.authors         = ["Elasticsearch"]
   s.email           = 'info@elasticsearch.com'
   s.homepage        = "http://www.elasticsearch.org/guide/en/logstash/current/index.html"
@@ -20,11 +20,10 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
 
   # Gem dependencies
-  s.add_runtime_dependency 'logstash', '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
   s.add_runtime_dependency 'logstash-codec-plain'
   s.add_runtime_dependency 'stud'
 
   s.add_development_dependency 'logstash-devutils'
 
 end
-

data/spec/inputs/heartbeat_spec.rb

@@ -1 +1,71 @@
 require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/heartbeat"
+
+def fetch_event(config, number)
+  pipeline = LogStash::Pipeline.new(config)
+  queue = Queue.new
+  pipeline.instance_eval do
+    @output_func = lambda { |event| queue << event }
+  end
+  pipeline_thread = Thread.new { pipeline.run }
+  counter = 0
+  begin
+    event = queue.pop
+    pipeline_thread.join
+    counter += 1
+  end until counter == number
+  return event
+end
+
+describe LogStash::Inputs::Heartbeat do
+  sequence = 1
+  context "Default message test" do
+    subject { LogStash::Inputs::Heartbeat.new({}) }
+
+    it "should generate an 'ok' message" do
+      expect(subject.generate_message(sequence)['message']).to eq('ok')
+    end # it "should generate an 'ok' message"
+  end # context "Default message test"
+
+  context "Simple message test" do
+    subject { LogStash::Inputs::Heartbeat.new({"message" => "my_message"}) }
+
+    it "should generate a message containing 'my_message'" do
+      expect(subject.generate_message(sequence)['message']).to eq('my_message')
+    end # it "should generate a message containing 'my_message'"
+  end # context "Simple message test" do
+
+  context "Sequence test" do
+    subject { LogStash::Inputs::Heartbeat.new({"message" => "sequence"}) }
+
+    it "should return an event with the appropriate sequence value" do
+      expect(subject.generate_message(sequence)['clock']).to eq(sequence)
+    end # it "should return an event with the appropriate sequence value"
+  end # context "Sequence test"
+
+  context "Epoch test" do
+    subject { LogStash::Inputs::Heartbeat.new({"message" => "epoch"}) }
+
+    it "should return an event with the current time (as epoch)" do
+      now = Time.now.to_i
+      # Give it a second, just in case
+      expect(subject.generate_message(sequence)['clock'] - now).to be < 2
+    end # it "should return an event with the current time (as epoch)"
+  end # context "Epoch test"
+
+  it "should generate a fixed number of events then stop" do
+    count = 4
+    config = <<-CONFIG
+      input {
+        heartbeat {
+          interval => 1
+          message => "sequence"
+          count => #{count}
+        }
+      }
+    CONFIG
+
+    event = fetch_event(config, count)
+    expect(event['clock']).to eq(count)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-heartbeat
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-01-27 00:00:00.000000000 Z
+date: 2015-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -19,7 +19,7 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 2.0.0
-  name: logstash
+  name: logstash-core
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.1.9
+rubygems_version: 2.4.5
 signing_key:
 specification_version: 4
 summary: This input generates a heartbeat pattern to aid in monitoring Logstash performance & availability