logstash-input-jsqs 0.9.1-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85191dce09f154911ff8d1a2b5d076472bf275c6
+  data.tar.gz: 6bac1f35c24c0f04b87072a1e3d359ab742f1e45
+SHA512:
+  metadata.gz: 86639ab9e5ee0bd507d407ac76d5d0e98eb8ceb299ddb39a0ab442f41d2423173cbca96e44b132855537fac0fdb57abc953472b64513d7a6a1e7af544042cf79
+  data.tar.gz: 52b578a50de497436eaaa8a708a9d8230942290c7fef80414bbc82a832660795b77a64231da2469d9efac9857c31d4cf8f9a056e7c96390d34dbe981b37464dc

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+Gemfile.lock
+Gemfile.bak
+.bundle

data/DEVELOPER.md

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2015 Jamie Cressey <jamiecressey89@gmail.com>
+
+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/elasticsearch/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.elasticsearch.org/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/elasticsearch/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-input-jsqs", :path => "/your/local/logstash-input-jsqs"
+```
+- Install plugin
+```sh
+bin/plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'input {jsqs {queueUrl => "https://sqs.eu-west-1.amazonaws.com/xxxxxxxxxxxx/logstash-queue"}}'
+```
+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-input-jsqs.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-input-jsqs.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/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/Rakefile

@@ -0,0 +1 @@
+require "logstash/devutils/rake"

data/lib/logstash-input-jsqs_jars.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+require 'logstash/environment'
+
+root_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+LogStash::Environment.load_runtime_jars! File.join(root_dir, "vendor")
+
+java_import "com.amazonaws.services.sqs.model.DeleteMessageBatchRequestEntry"
+java_import "java.util.concurrent.Executors"
+java_import "java.util.concurrent.atomic.AtomicInteger"
+java_import "com.amazonaws.ClientConfiguration"
+java_import "com.amazonaws.services.sqs.AmazonSQSAsyncClient"
+java_import "com.amazonaws.services.sqs.buffered.AmazonSQSBufferedAsyncClient"
+java_import "com.amazonaws.services.sqs.buffered.QueueBufferConfig"
+java_import "com.amazonaws.services.sqs.model.ReceiveMessageRequest"
+java_import "com.amazonaws.services.sqs.model.DeleteMessageBatchRequest"

data/lib/logstash/inputs/jsqs.rb

@@ -0,0 +1,156 @@
+# encoding: utf-8
+require "logstash/inputs/threadable"
+require "logstash/namespace"
+require "logstash/plugin_mixins/aws_config"
+require "digest/sha2"
+require 'logstash-input-jsqs_jars.rb'
+
+# aws-java-sdk dependencies
+# require 'jar/aws-java-sdk.jar'
+# require 'jar/httpclient-4.2.jar'
+# require 'jar/httpcore-4.2.jar'
+# require 'jar/commons-codec-1.6'
+# require 'jar/jackson-core-2.1.1.jar'
+# require 'jar/jackson-databind-2.1.1.jar'
+# require 'jar/jackson-annotations-2.1.1.jar'
+#
+
+# Pull events from an Amazon Web Services Simple Queue Service (SQS) queue.
+#
+# SQS is a simple, scalable queue system that is part of the 
+# Amazon Web Services suite of tools.
+#
+# Although SQS is similar to other queuing systems like AMQP, it
+# uses a custom API and requires that you have an AWS account.
+# See http://aws.amazon.com/sqs/ for more details on how SQS works,
+# what the pricing schedule looks like and how to setup a queue.
+#
+# To use this plugin, you *must*:
+#
+#  * Have an AWS account
+#  * Setup an SQS queue
+#  * Create an identify that has access to consume messages from the queue.
+#
+# The "consumer" identity must have the following permissions on the queue:
+#
+#  * sqs:ChangeMessageVisibility
+#  * sqs:ChangeMessageVisibilityBatch
+#  * sqs:DeleteMessage
+#  * sqs:DeleteMessageBatch
+#  * sqs:GetQueueAttributes
+#  * sqs:GetQueueUrl
+#  * sqs:ListQueues
+#  * sqs:ReceiveMessage
+#
+# Typically, you should setup an IAM policy, create a user and apply the IAM policy to the user.
+# A sample policy is as follows:
+#
+#     {
+#       "Statement": [
+#         {
+#           "Action": [
+#             "sqs:ChangeMessageVisibility",
+#             "sqs:ChangeMessageVisibilityBatch",
+#             "sqs:GetQueueAttributes",
+#             "sqs:GetQueueUrl",
+#             "sqs:ListQueues",
+#             "sqs:SendMessage",
+#             "sqs:SendMessageBatch"
+#           ],
+#           "Effect": "Allow",
+#           "Resource": [
+#             "arn:aws:sqs:us-east-1:123456789012:Logstash"
+#           ]
+#         }
+#       ]
+#     } 
+#
+# See http://aws.amazon.com/iam/ for more details on setting up AWS identities.
+#
+
+# -------------------------------------
+# NOTICE:
+# This is a custom SQS input that uses the Java AWS SDK (Ruby SDK didn't scale beyond 200 messages per second).
+# This plugin assumes that the logstash distribution contains the Java AWS SDK its required dependencies.
+# In Logstash 1.3.3, Apache HTTP client (4.1) had to be removed from the Logstash distribution,
+#   as it was incompatible with the Apache HTTP client 4.2 version used by the Java AWS SDK.
+# -------------------------------------
+
+class LogStash::Inputs::JSQS < LogStash::Inputs::Threadable
+
+  config_name "jsqs"
+
+  default :codec, "json"
+
+  # Name of the SQS Queue name to pull messages from. Note that this is just the name of the queue, not the URL or ARN.
+  config :queueUrl, :validate => :string, :required => true
+  config :max_connections, :validate => :number, :default => 1000
+  config :max_batch_open_ms, :validate => :number, :default => 5000
+  config :max_inflight_receive_batches, :validate => :number, :default => 50
+  config :max_done_receive_batches, :validate => :number, :default => 50
+  config :max_number_of_messages, :validate => :number, :default => 10
+
+  @receiveRequest
+
+  public
+  def register
+
+    @logger.info("Registering SQS input", :queue => @queue)
+
+    begin
+        # Client config
+        @logger.debug("Creating AWS SQS queue client", :queue => @queue)
+        clientConfig = ClientConfiguration.new.withMaxConnections(@max_connections)
+        # SQS client
+        @sqs = AmazonSQSAsyncClient.new(clientConfig)
+        @logger.debug("Amazon SQS Client created")
+    
+        # Buffered client config
+        queueBufferConfig = QueueBufferConfig.new.withMaxBatchOpenMs(@max_batch_open_ms).withMaxInflightReceiveBatches(@max_inflight_receive_batches).withMaxDoneReceiveBatches(@max_done_receive_batches)
+
+        @bufferedSqs = AmazonSQSBufferedAsyncClient.new(@sqs, queueBufferConfig);
+        @logger.info("Connected to AWS SQS queue successfully.", :queue => @queue)
+        
+        @receiveRequest = ReceiveMessageRequest.new(@queueUrl).withMaxNumberOfMessages(@max_number_of_messages)
+        
+    rescue Exception => e
+      @logger.error("Unable to access SQS queue.", :error => e.to_s, :queue => @queue)
+      throw e
+    end # begin/rescue
+    
+  end # def register
+
+  public
+  def run(output_queue)
+    @logger.debug("Polling SQS queue", :queue => @queue)
+
+    while running?   
+        result = @bufferedSqs.receiveMessage(@receiveRequest)            
+        deleteEntries = [] 
+        # Process messages (expected 0 - 10 messages)
+        result.messages.each_with_index { |message, i|
+            @codec.decode(message.body) do |event|
+                decorate(event)
+                output_queue << event
+            end # codec.decode
+            
+            #Add Delete entry for this message
+            deleteEntries << DeleteMessageBatchRequestEntry.new.withId(i.to_s).withReceiptHandle(message.getReceiptHandle())
+        }
+        if deleteEntries.size > 0
+            deleteRequest = DeleteMessageBatchRequest.new.withQueueUrl(@queueUrl);
+            deleteRequest.setEntries(deleteEntries);
+            # Issue delete request
+            @bufferedSqs.deleteMessageBatch(deleteRequest);            
+        end # end if
+        
+    end # polling loop
+  end # def run
+
+  def teardown
+    @sqs = nil
+    @bufferedSqs = nil
+    finished
+  end # def teardown
+
+end # class LogStash::Inputs::SQS

data/logstash-input-jsqs.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.platform = RUBY_PLATFORM
+  s.name = 'logstash-input-jsqs'
+  s.version = '0.9.1'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "SQS input plugin using the AWS Java SDK"
+  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-jsqs. This gem is not a stand-alone program"
+  s.authors = ["Jamie Cressey"]
+  s.email = 'jamiecressey89@gmail.com'
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)
+   # 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', '>= 1.4.0', '< 2.0.0'
+  s.add_development_dependency 'logstash-devutils'
+
+end

data/spec/inputs/example_spec.rb

@@ -0,0 +1 @@
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-jsqs
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+platform: java
+authors:
+- Jamie Cressey
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.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'
+  name: logstash-devutils
+  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/plugin install logstash-input-jsqs. This gem is not a stand-alone program
+email: jamiecressey89@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash-input-jsqs_jars.rb
+- lib/logstash/inputs/jsqs.rb
+- logstash-input-jsqs.gemspec
+- spec/inputs/example_spec.rb
+- vendor/jar-dependencies/runtime-jars/aws-java-sdk-1.7.13.jar
+- vendor/jar-dependencies/runtime-jars/commons-codec-1.9.jar
+- vendor/jar-dependencies/runtime-jars/commons-logging-1.2.jar
+- vendor/jar-dependencies/runtime-jars/httpclient-4.4.jar
+- vendor/jar-dependencies/runtime-jars/httpcore-4.4.1.jar
+- vendor/jar-dependencies/runtime-jars/jackson-annotations-2.5.1.jar
+- vendor/jar-dependencies/runtime-jars/jackson-core-2.5.1.jar
+- vendor/jar-dependencies/runtime-jars/jackson-databind-2.5.1.jar
+- vendor/jar-dependencies/runtime-jars/joda-time-2.7.jar
+homepage:
+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.8
+signing_key:
+specification_version: 4
+summary: SQS input plugin using the AWS Java SDK
+test_files:
+- spec/inputs/example_spec.rb