logstash-input-ngn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d0d4c0a535ade6b061172c3a3e2405d9d9a78964ce52adb9b27eb310154529c
+  data.tar.gz: a8a87e1547dd598eb6ab7374f4d772f11fb70b205931217c068d3842e4ce4be3
+SHA512:
+  metadata.gz: 1e2aad57a0d348f3ad8c42a59b8d6e10c26d386c17a1fe2f91d2315e1f8521e0cd0bcd4c22e959cd604cc00e7ac8154e845880508cf424a04834367ba5b27b1a
+  data.tar.gz: c6a1e3211bdcc1ef772fda06829f28c19f42f05e733d97d7f7389e50ad8ca5d3547ee3aeacf03d411418e62ad65dbce51b0b6b6785b148c17f8376806678400b

data/Gemfile

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

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/ngn.rb

@@ -0,0 +1,149 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "socket" # for Socket.gethostname
+require "stud/interval"
+require "rufus/scheduler"
+
+# Periodically run a shell command and capture the whole output as an event.
+#
+# Notes:
+#
+# * The `command` field of this event will be the command run.
+# * The `message` field of this event will be the entire stdout of the command.
+#
+class LogStash::Inputs::Ngn < LogStash::Inputs::Base
+
+  config_name "ngn"
+
+  default :codec, "json"
+
+  # Command to run. For example : `uptime`
+  config :script, :validate => :string, :required => true
+
+  # ngn username
+  config :username, :validate => :string, :required => true
+
+  # ngn password
+  config :password, :validate => :string, :required => true
+
+  # authentication token
+  config :token, :validate => :string
+
+  # Interval to run the command. Value is in seconds.
+  # Either `interval` or `schedule` option must be defined.
+  config :interval, :validate => :number
+
+  # Schedule of when to periodically run command, in Cron format
+  # For example: "* * * * *" (execute command every minute, on the minute)
+  # Either `interval` or `schedule` option must be defined.
+  config :schedule, :validate => :string
+
+  def register
+    @logger.info("Registering Exec Input", :type => @type, :script => @script, :interval => @interval, :schedule => @schedule)
+    @hostname = Socket.gethostname
+    @io       = nil
+    
+    if (@interval.nil? && @schedule.nil?) || (@interval && @schedule)
+      raise LogStash::ConfigurationError, "jdbc input: either 'interval' or 'schedule' option must be defined."
+    end
+  end # def register
+
+  def run(queue)
+    if @schedule
+      @scheduler = Rufus::Scheduler.new(:max_work_threads => 1)
+      @scheduler.cron @schedule do
+        execute(queue)
+      end
+      @scheduler.join
+    else
+      while !stop?
+        duration = execute(queue)
+        wait_until_end_of_interval(duration)
+      end # loop
+    end
+  end # def run
+
+  def stop
+    close_io()
+    @scheduler.shutdown(:wait) if @scheduler
+  end
+
+  # Execute a given script
+  # @param [String] A script string
+  # @param [Array or Queue] A queue to append events to
+  def execute(queue)
+    start = Time.now
+    output = exit_status = nil
+    begin
+      @logger.debug? && @logger.debug("Running exec", :script => @script)
+      output, exit_status = run_script()
+    rescue StandardError => e
+      @logger.error("Error while running script",
+        :script => @script, :e => e, :backtrace => e.backtrace)
+    rescue Exception => e
+      @logger.error("Exception while running script",
+        :script => @script, :e => e, :backtrace => e.backtrace)
+    end
+    duration = Time.now - start
+    @logger.debug? && @logger.debug("Command completed", :script => @script, :duration => duration)
+    if output
+      @codec.decode(output) do |decoded|
+
+        @token = decoded.get("token")
+
+        decoded.get("values").each do |val|
+          event = LogStash::Event.new(val)
+          decorate(event)
+          event.set("[@metadata][host]", @hostname)
+          event.set("[@metadata][duration]", duration)
+          event.set("[@metadata][exit_status]", exit_status)
+          queue << event
+        end
+      end
+    end
+    duration
+  end
+
+  private
+
+  def run_script
+    command = "python3 #{@script} -u #{@username} -p #{@password}"
+    if @token
+      command << " -t \"#{@token}\""
+    end
+
+    @logger.debug? && @logger.debug("Running exec", :command => command)
+      
+    @io = IO.popen(command)
+    output = @io.read
+    @io.close # required in order to read $?
+    exit_status = $?.exitstatus # should be threadsafe as per rb_thread_save_context
+    [output, exit_status]
+  ensure
+    close_io()
+  end
+
+  # Close @io
+  def close_io
+    return if @io.nil? || @io.closed?
+    @io.close
+    @io = nil
+  end
+
+  # Wait until the end of the interval
+  # @param [Integer] the duration of the last command executed
+  def wait_until_end_of_interval(duration)
+    # Sleep for the remainder of the interval, or 0 if the duration ran
+    # longer than the interval.
+    sleeptime = [0, @interval - duration].max
+    if sleeptime > 0
+      Stud.stoppable_sleep(sleeptime) { stop? }
+    else
+      @logger.warn("Execution ran longer than the interval. Skipping sleep.",
+                   :script => @script, :duration => duration, :interval => @interval)
+    end
+  end
+
+
+end # class LogStash::Inputs::Exec

data/logstash-input-ngn.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-input-ngn'
+  s.version       = '0.1.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'summary'
+  s.description   = 'description'
+  s.homepage      = 'http://example.com'
+  s.authors       = ['Chris Fischer']
+  s.email         = 'chris.fischer36@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"
+  s.add_runtime_dependency "stud", "~> 0.0.22"
+  s.add_runtime_dependency "logstash-codec-json", "~> 3"
+  s.add_runtime_dependency "rufus-scheduler", "~> 3"
+
+  s.add_development_dependency "logstash-devutils", "~> 1"
+  s.add_development_dependency "timecop", "~> 0"
+end

data/spec/inputs/ngn_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/ngn"
+
+describe LogStash::Inputs::Ngn do
+
+  it_behaves_like "an interruptible input plugin" do
+    let(:config) { { "interval" => 100 } }
+  end
+
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-ngn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Fischer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2018-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+  name: stud
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  name: logstash-codec-json
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  name: rufus-scheduler
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !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: description
+email: chris.fischer36@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- lib/logstash/inputs/ngn.rb
+- logstash-input-ngn.gemspec
+- spec/inputs/ngn_spec.rb
+homepage: http://example.com
+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.7.6
+signing_key:
+specification_version: 4
+summary: summary
+test_files:
+- spec/inputs/ngn_spec.rb