logstash-input-ping 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de8cd823d25369b0b14bdf3af18a4703e8493cad139b1d2c20a48c9fa372a654
+  data.tar.gz: 53347e595d9a9a0279afb2b3468ae8fe9a455a3c96b1023ba7162835c65cdd98
+SHA512:
+  metadata.gz: 59697dc6258d8aef750156d8b725abffc2e2fec52c2a1f085e0e00c915e6f158937204686e352a43e9d543323f903c40a9421c986db98e2d654555eb3791d05f
+  data.tar.gz: 19c14a33e777f8f08c3ba8412611c77fff4c9598fa02635ac8e6d728ccd352e4b731b6d8d81781d2f1de7cac2547c710f4b5f9710f61d5234bedd8dbdeddcb7d

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin created with the logstash plugin generator

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Davide Cavestro - davide.cavestro@gmail.com
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-input-ping
+Example input plugin. This should help bootstrap your effort to write your own input plugin!

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+

data/LICENSE

@@ -0,0 +1,11 @@
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,86 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### 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. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/logstash-plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 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
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+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 the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/inputs/ping.rb

@@ -0,0 +1,230 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "stud/interval"
+require 'net/ping'
+
+# This plugin was created as a way to ingest data from ping probes
+# into Logstash. You can periodically schedule ingestion
+# using a cron syntax (see `schedule` setting).
+#
+#
+# ==== Ping types
+#
+# This plugin uses 'net/ping' which provides different ways to ping 
+# computers. The desired ping mode must be explicitly passed in to the 
+# plugin using the `ping_mode` configuration option.
+#
+# ==== Scheduling
+#
+# Input from this plugin can be scheduled to run periodically according to a specific
+# schedule. This scheduling syntax is powered by https://github.com/jmettraux/rufus-scheduler[rufus-scheduler].
+# The syntax is cron-like with some extensions specific to Rufus (e.g. timezone support ).
+#
+# Examples:
+#
+# |==========================================================
+# | `* 5 * 1-3 *`               | will execute every minute of 5am every day of January through March.
+# | `0 * * * *`                 | will execute on the 0th minute of every hour every day.
+# | `0 6 * * * America/Chicago` | will execute at 6:00am (UTC/GMT -5) every day.
+# |==========================================================
+#
+#
+# Further documentation describing this syntax can be found https://github.com/jmettraux/rufus-scheduler#parsing-cronlines-and-time-strings[here].
+#
+# ==== Usage:
+#
+# Here is an example of setting up the plugin to ping google DNS.
+# First, we place the appropriate JDBC driver library in our current
+# path (this can be placed anywhere on your filesystem). In this example, we connect to
+# the 'mydb' database using the user: 'mysql' and wish to input all rows in the 'songs'
+# table that match a specific artist. The following examples demonstrates a possible
+# Logstash configuration for this. The `schedule` option in this example will
+# instruct the plugin to execute this input statement on the minute, every minute.
+#
+# [source,ruby]
+# ------------------------------------------------------------------------------
+# input {
+#   ping {
+#     mode => "external"
+#     host => "8.8.8.8"
+#     timeout => 5
+#     schedule => "* * * * * *"
+#   }
+# }
+# ------------------------------------------------------------------------------
+#
+
+class LogStash::Inputs::Ping < LogStash::Inputs::Base
+  config_name "ping"
+
+  # If undefined, Logstash will complain, even if codec is unused.
+  default :codec, "json"
+
+  # The host to ping.
+  #
+  # The default is `127.0.0.1`.
+  config :host, :validate => :string, :default => "127.0.0.1"
+
+  # The ping mode to use.
+  #
+  # The default is `external`.
+  config :mode, :validate => :string, :default => "external"
+
+  # Set how frequently messages should be sent.
+  #
+  # The default, `1`, means send a message every second.
+  config :interval, :validate => :number, :default => 1
+
+  # Schedule of when to periodically run statement, in Cron format
+  # for example: "* * * * * *" (execute ping every second, on the second)
+  #
+  # There is no schedule by default. If no schedule is given, then the ping is run
+  # using `interval` confguration.
+  config :schedule, :validate => :string, :default => nil #"* * * * * *"
+
+
+  public
+
+  def register
+    @thishost = Socket.gethostname
+    if @schedule
+      require "rufus/scheduler"
+    end
+
+#    @logger = self.logger
+  end # def register
+
+  def run(queue)
+    create_probe
+    if @schedule
+      @scheduler = Rufus::Scheduler.new(:max_work_threads => 1)
+      @scheduler.cron @schedule do
+        do_ping (queue)
+      end
+
+      @scheduler.join
+    else
+      # we can abort the loop if stop? becomes true
+      while !stop?
+        do_ping (queue)
+        # because the sleep interval can be big, when shutdown happens
+        # we want to be able to abort the sleep
+        # Stud.stoppable_sleep will frequently evaluate the given block
+        # and abort the sleep(@interval) if the return value is true
+        Stud.stoppable_sleep(@interval) { stop? }
+      end # loop
+    end
+  end # def run
+
+  def stop
+    @scheduler.stop if @scheduler
+
+  end
+
+  private
+
+  def create_probe ()
+    @probe = case @mode.upcase
+      when "ICMP" then IcmpProbe.new
+      when "EXTERNAL" then ExternalProbe.new
+      when "HTTP" then HttpProbe.new
+      when "TCP" then TcpProbe.new
+      when "UDP" then UdpProbe.new
+      else
+        raise(LogStash::ConfigurationError, "Must set a valid :mode.")
+    end
+
+    @probe
+  end
+
+  def do_ping (queue)
+    success = @probe.ping(@host)
+    duration = @probe.duration
+    message = {"success" => success, "duration" => duration, "host" => @host}
+    event = LogStash::Event.new("message" => message, "host" => @thishost)
+    decorate(event)
+    queue << event
+  end
+
+  class Probe
+    def ping (host)
+    end
+
+    def duration ()
+    end
+  end
+
+  class IcmpProbe < Probe
+    def initialize
+        @delegate = Net::Ping::ICMP.new
+    end
+
+    def ping (host)
+        @delegate.ping (host)
+    end
+
+    def duration ()
+      @delegate.duration
+    end
+  end
+
+  class ExternalProbe < Probe
+    def initialize
+        @delegate = Net::Ping::External.new
+    end
+
+    def ping (host)
+        @delegate.ping (host)
+    end
+
+    def duration ()
+      @delegate.duration
+    end
+  end
+
+  class HttpProbe < Probe
+  # warning, exception
+    def initialize
+        @delegate = Net::Ping::HTTP.new
+    end
+
+    def ping (host)
+        @delegate.ping (host)
+    end
+
+    def duration ()
+      @delegate.duration
+    end
+  end
+
+  class TcpProbe < Probe
+  # http?
+    def initialize
+        @delegate = Net::Ping::TCP.new
+    end
+
+    def ping (host)
+        @delegate.ping (host)
+    end
+
+    def duration ()
+      @delegate.duration
+    end
+  end
+
+  class UdpProbe < Probe
+  # http?
+    def initialize
+        @delegate = Net::Ping::UDP.new
+    end
+
+    def ping (host)
+        @delegate.ping (host)
+    end
+
+    def duration ()
+      @delegate.duration
+    end
+  end
+end # class LogStash::Inputs::Ping

data/logstash-input-ping.gemspec

@@ -0,0 +1,31 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-input-ping'
+  s.version       = '0.1.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'Provides ping data as input for Logstash'
+  s.description   = 'This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program'
+  s.homepage      = 'https://github.com/davidecavestro/logstash-input-ping'
+  s.authors       = ['Davide Cavestro']
+  s.email         = 'davide.cavestro@gmail.com'
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_runtime_dependency 'logstash-codec-json'
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'tzinfo'
+  s.add_runtime_dependency 'tzinfo-data'
+  s.add_runtime_dependency 'rufus-scheduler'
+  s.add_runtime_dependency 'net-ping'
+
+  s.add_development_dependency 'logstash-devutils', '>= 0.0.16'
+  s.add_development_dependency 'timecop'
+end

data/spec/inputs/ping_spec.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/ping"
+require "net/ping"
+require "timecop"
+require "time"
+require "date"
+
+describe LogStash::Inputs::Ping do
+
+  let(:plugin) { LogStash::Inputs::Ping.new(config) }
+  let(:queue) { Queue.new }
+
+  it_behaves_like "an interruptible input plugin" do
+    let(:config) do
+      {
+        "host" => ["127.0.0.1"],
+        "mode" => "external",
+        "interval" => 1
+      }
+    end
+  end
+
+  context "when scheduling" do
+    let(:config) do
+      {
+          "host" => ["127.0.0.1"],
+          "mode" => "external",
+          "schedule" => "* * * * * UTC"
+      }
+    end
+
+    before do
+      plugin.register
+    end
+
+    it "should properly schedule" do
+
+      Timecop.travel(Time.new(2000))
+      Timecop.scale(60)
+      runner = Thread.new do
+        expect(plugin).to receive(:do_ping) {
+          queue << LogStash::Event.new({})
+        }.at_least(:twice)
+
+        plugin.run(queue)
+      end
+      sleep 3
+      plugin.stop
+      runner.kill
+      runner.join
+      expect(queue.size).to eq(2)
+      Timecop.return
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-ping
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Davide Cavestro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-json
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-plain
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: tzinfo
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: tzinfo-data
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rufus-scheduler
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: net-ping
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: timecop
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a Logstash plugin required to be installed on top of the
+  Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
+  gem is not a stand-alone program
+email: davide.cavestro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/inputs/ping.rb
+- logstash-input-ping.gemspec
+- spec/inputs/ping_spec.rb
+homepage: https://github.com/davidecavestro/logstash-input-ping
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: input
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.13
+signing_key:
+specification_version: 4
+summary: Provides ping data as input for Logstash
+test_files:
+- spec/inputs/ping_spec.rb