logstash-input-beanstalkd 0.9.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40851421c36c6a6d81fc949c667df64cb33fe8a9
+  data.tar.gz: 1a80a91dd097a382efdf88a28240e0c7c2c4cbe1
+SHA512:
+  metadata.gz: d4eff4795374dcc6fb1332e8b9193a8fd17f3f84b44b562d245cb254fc33674c5e1b76fa7237c2d2c8dd765d1b8d2eb7085300053ca9214b739d261e2f8bb63f
+  data.tar.gz: 7e491b561f4ce66414a0bda6bc1dd2f9402fc55e6d92bee777ec17021e55026fd6d95336012d20ebb71dde1a210ab904f88edd164caa10613c761ebf9d891184

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 1.0.0
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully,
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Dependency on logstash-core update to 2.0
+

data/DEVELOPER.md

@@ -0,0 +1 @@
+# logstash-input-beanstalkd

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+
+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/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,106 @@
+# Logstash Input Beanstalkd
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash) to fetch jobs from [beanstalkd](https://github.com/kr/beanstalkd).
+
+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
+
+### Installation
+`bin/plugin install logstash-input-beanstalkd`
+
+### Sample Config
+```
+input {
+  beanstalkd {
+    host => "localhost"
+    port => 11300
+    tube => "test"
+    priority => 5
+    delay => 5
+    ttr => 120
+    reserve_timeout => 5
+  }
+}
+```
+`port`, `priority`, `delay`, `ttr` and `reserve_timeout` are optional.
+*NOTE*: This plugin assumes the job from beanstalkd is in json format !!!
+
+## 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/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/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/beanstalkd.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "beaneater"
+require "json"
+
+# This input will read jobs from a Beanstalk tube. It uses Beaneater(https://github.com/beanstalkd/beaneater)
+# to interact with beanstalkd. The default input codec is json
+
+class LogStash::Inputs::Beanstalkd < LogStash::Inputs::Base
+  config_name "beanstalkd"
+
+  # The address of the beanstalk server
+  config :host, :validate => :string, :required => true
+
+  # The port of your beanstalk server
+  config :port, :validate => :number, :default => 11300
+
+  # The name of the beanstalk tube
+  config :tube, :validate => :string, :required => true
+
+  # The priority of the job
+  config :priority, :validate => :number, :default => 1024
+
+  # The delay of the job in second
+  config :delay, :validate => :number, :default => 0
+
+  # The 'time to run' of the job
+  config :ttr, :validate => :number, :default => 120
+
+  # The reserve timeout of the job in second
+  config :reserve_timeout, :validate => :number, :default => 5
+
+  public
+  def register
+    Beaneater.configure do |config|
+      config.default_put_delay   = @delay
+      config.default_put_pri     = @priority
+      config.default_put_ttr     = @ttr
+    end
+    @beanstalk = Beaneater.new("#{@host}:#{@port}")
+    @beanstalk.tubes.watch!(@tube)
+  end # def register
+
+  def run(queue)
+    while !stop?
+      begin
+        job = @beanstalk.tubes.reserve(@reserve_timeout)
+        event = LogStash::Event.new(JSON.parse(job.body))
+        decorate(event)
+        queue << event
+        job.delete
+      rescue IOError, EOFError, LogStash::ShutdownSignal => e
+        # stdin closed or a requested shutdown
+        break
+      rescue Beaneater::TimedOutError
+        # no job right now, just do another reserve
+        next
+      rescue => e
+        @logger.warn(["Trouble parsing beanstalk job",
+                     {:error => e.message, :body => job.body,
+                      :backtrace => e.backtrace}])
+        job.bury
+      end
+    end # loop
+  end # def run
+
+  def stop
+    @beanstalk.close
+  end
+end # class LogStash::Inputs::Beanstalkd

data/logstash-input-beanstalkd.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-input-beanstalkd'
+  s.version = '0.9.0.1'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "This input will read jobs from a beanstalk tube. It uses beaneater to interact with beanstalkd."
+  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 logstash-input-beanstalkd. This gem is not a stand-alone program. It can read jobs from a beanstalk tube."
+  s.authors = ["Eagle Chen"]
+  s.email = "chygr1234@gmail.com"
+  s.homepage = "https://github.com/EagleChen/logstash-input-beanstalkd"
+  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", ">= 2.0.0", "< 3.0.0"
+  s.add_runtime_dependency 'logstash-codec-plain', ">= 2.0.2", "< 3.0.0"
+  s.add_runtime_dependency "beaneater", ">= 1.0.0", "< 2.0.0"
+  s.add_development_dependency "logstash-devutils", ">= 0.0.16", "< 1.0.0"
+end

data/spec/inputs/beanstalkd_spec.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/beanstalkd"
+require "beaneater"
+
+describe LogStash::Inputs::Beanstalkd do
+  let (:valid_config) {{'host' => 'localhost', 'tube' => 'test'}}
+  let (:empty_config) {{}}
+  let (:non_default_config) {{'host' => 'localhost', 'tube' => 'test', 'priority' => 20, 'delay' => 10, 'ttr' => 10, 'reserve_timeout' => 5}}
+  let (:conf) {
+    <<-CONFIG
+      input {
+        beanstalkd {
+          host => "localhost"
+          tube => "test"
+        }
+      }
+    CONFIG
+  }
+
+  it "parse config" do
+    expect do
+      LogStash::Plugin.lookup("input", "beanstalkd").new(valid_config)
+    end.to_not raise_error
+  end
+
+  it "fails with empty config" do
+    expect do
+      LogStash::Plugin.lookup("input", "beanstalkd").new(valid_config)
+    end.to_not raise_error
+  end
+
+  it "can parse beanstalkd related data" do
+    expect do
+      LogStash::Plugin.lookup("input", "beanstalkd").new(valid_config)
+    end.to_not raise_error
+  end
+
+  # this test requires a running beanstalkd on localhost:11300
+  it "receive jobs" do
+    job = '{"test": 1}'
+    beanstalk = Beaneater.new('localhost:11300')
+    tube = beanstalk.tubes["test"]
+    tube.put job
+    beanstalk.close
+
+    result = input(conf) do |pipeline, queue|
+      queue.size.times.collect { queue.pop }
+    end
+
+    expect(result.size).to eq(1)
+    expect(result[0]["test"]).to eq(1)
+  end
+
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-beanstalkd
+version: !ruby/object:Gem::Version
+  version: 0.9.0.1
+platform: ruby
+authors:
+- Eagle Chen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  name: logstash-codec-plain
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  name: beaneater
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+    - - <
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  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::Version
+        version: 1.0.0
+description: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install logstash-input-beanstalkd. This gem is not a stand-alone program. It can read jobs from a beanstalk tube.
+email: chygr1234@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/inputs/beanstalkd.rb
+- logstash-input-beanstalkd.gemspec
+- spec/inputs/beanstalkd_spec.rb
+homepage: https://github.com/EagleChen/logstash-input-beanstalkd
+licenses:
+- Apache License (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.4.5
+signing_key:
+specification_version: 4
+summary: This input will read jobs from a beanstalk tube. It uses beaneater to interact with beanstalkd.
+test_files:
+- spec/inputs/beanstalkd_spec.rb