logstash-input-sqs 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8b647cdf23498e03578429d1480b20af305b9f1
-  data.tar.gz: 6dd56f7d7df34f744d0305f1dcc2b9f90138b251
+  metadata.gz: 14851d6496ebf90774a2d559f8a82c3cccfe21e1
+  data.tar.gz: d734170d3d4116663bb445bdb4d830ecb1683a7c
 SHA512:
-  metadata.gz: 8f7738bcaa0c1b477f38e83653cbbfdfb685a32aa05048b02abfb19f1dfd5c1ce1e2e4cb6d7f1eb471edff9e727908e8fdba734b30972d9b297bb5607fefb539
-  data.tar.gz: 29d724a9098d1a1be4f4a082beee61acd6eb949980978af7350a8751bbd270b5780ae9b6112abcd4545cd456396115f673e24548aff47f969bd23b03160dff03
+  metadata.gz: 84b5ecc02db5cd15a409923df221578cd193e5631932c6f158d47a28ad0bd1b20ce490fb3dea42ebd0f6b03c902d406d348b46311e3009ce4fd86b04a6fc3a51
+  data.tar.gz: 2c968877567c0eb5f0f67e630f1348683a8f01e60a9ca5a1fae9d07a9f70a5c5f59b03aed3b58a275c4dc5442a04854a0571ce20766abf1063a3078b2ff749a6

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.0.3
+  - Monkey-patch the AWS-SDK to prevent "uninitialized constant" errors.
+
 ## 3.0.2
   - Relax constraint on logstash-core-plugin-api to >= 1.60 <= 2.99
 

data/CONTRIBUTORS

@@ -5,6 +5,7 @@ Contributors:
 * Aaron Broad (AaronTheApe)
 * Colin Surprenant (colinsurprenant)
 * Jordan Sissel (jordansissel)
+* Joshua Spence (joshuaspence)
 * Pier-Hugues Pellerin (ph)
 * Richard Pijnenburg (electrical)
 * Sean Laurent (organicveggie)

data/docs/index.asciidoc

@@ -0,0 +1,219 @@
+:plugin: sqs
+:type: input
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}-{plugin}"]
+
+=== Sqs
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+
+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:
+[source,json]
+    {
+      "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.
+
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Sqs Input Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-common-options>> described later.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-access_key_id>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-aws_credentials_file>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-id_field>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-md5_field>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-polling_frequency>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-proxy_uri>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-queue>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-region>> |<<string,string>>, one of `["us-east-1", "us-east-2", "us-west-1", "us-west-2", "eu-central-1", "eu-west-1", "eu-west-2", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2", "sa-east-1", "us-gov-west-1", "cn-north-1", "ap-south-1", "ca-central-1"]`|No
+| <<plugins-{type}s-{plugin}-secret_access_key>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-sent_timestamp_field>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-session_token>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-threads>> |<<number,number>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-common-options>> for a list of options supported by all
+input plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-access_key_id"]
+===== `access_key_id` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+This plugin uses the AWS SDK and supports several ways to get credentials, which will be tried in this order:
+
+1. Static configuration, using `access_key_id` and `secret_access_key` params in logstash plugin config
+2. External credentials file specified by `aws_credentials_file`
+3. Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
+4. Environment variables `AMAZON_ACCESS_KEY_ID` and `AMAZON_SECRET_ACCESS_KEY`
+5. IAM Instance Profile (available when running inside EC2)
+
+[id="plugins-{type}s-{plugin}-aws_credentials_file"]
+===== `aws_credentials_file` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Path to YAML file containing a hash of AWS credentials.
+This file will only be loaded if `access_key_id` and
+`secret_access_key` aren't set. The contents of the
+file should look like this:
+
+[source,ruby]
+----------------------------------
+    :access_key_id: "12345"
+    :secret_access_key: "54321"
+----------------------------------
+
+
+[id="plugins-{type}s-{plugin}-id_field"]
+===== `id_field` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Name of the event field in which to store the SQS message ID
+
+[id="plugins-{type}s-{plugin}-md5_field"]
+===== `md5_field` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Name of the event field in which to store the SQS message MD5 checksum
+
+[id="plugins-{type}s-{plugin}-polling_frequency"]
+===== `polling_frequency` 
+
+  * Value type is <<number,number>>
+  * Default value is `20`
+
+Polling frequency, default is 20 seconds
+
+[id="plugins-{type}s-{plugin}-proxy_uri"]
+===== `proxy_uri` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+URI to proxy server if required
+
+[id="plugins-{type}s-{plugin}-queue"]
+===== `queue` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+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.
+
+[id="plugins-{type}s-{plugin}-region"]
+===== `region` 
+
+  * Value can be any of: `us-east-1`, `us-east-2`, `us-west-1`, `us-west-2`, `eu-central-1`, `eu-west-1`, `eu-west-2`, `ap-southeast-1`, `ap-southeast-2`, `ap-northeast-1`, `ap-northeast-2`, `sa-east-1`, `us-gov-west-1`, `cn-north-1`, `ap-south-1`, `ca-central-1`
+  * Default value is `"us-east-1"`
+
+The AWS Region
+
+[id="plugins-{type}s-{plugin}-secret_access_key"]
+===== `secret_access_key` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The AWS Secret Access Key
+
+[id="plugins-{type}s-{plugin}-sent_timestamp_field"]
+===== `sent_timestamp_field` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Name of the event field in which to store the SQS message Sent Timestamp
+
+[id="plugins-{type}s-{plugin}-session_token"]
+===== `session_token` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The AWS Session token for temporary credential
+
+[id="plugins-{type}s-{plugin}-threads"]
+===== `threads` 
+
+  * Value type is <<number,number>>
+  * Default value is `1`
+
+
+
+
+
+include::{include_path}/{type}.asciidoc[]

data/lib/logstash/inputs/sqs/patch.rb

@@ -0,0 +1,21 @@
+# This patch was stolen from logstash-plugins/logstash-output-sqs#20.
+#
+# This patch is a workaround for a JRuby issue which has been fixed in JRuby
+# 9000, but not in JRuby 1.7. See https://github.com/jruby/jruby/issues/3645
+# and https://github.com/jruby/jruby/issues/3920. This is necessary because the
+# `aws-sdk` is doing tricky name discovery to generate the correct error class.
+#
+# As per https://github.com/aws/aws-sdk-ruby/issues/1301#issuecomment-261115960,
+# this patch may be short-lived anyway.
+require 'aws-sdk'
+
+begin
+  old_stderr = $stderr
+  $stderr = StringIO.new
+
+  module Aws
+    const_set(:SQS, Aws::SQS)
+  end
+ensure
+  $stderr = old_stderr
+end

data/lib/logstash/inputs/sqs.rb

@@ -5,6 +5,13 @@ require "logstash/namespace"
 require "logstash/timestamp"
 require "logstash/plugin_mixins/aws_config"
 require "logstash/errors"
+require 'logstash/inputs/sqs/patch'
+
+# Forcibly load all modules marked to be lazily loaded.
+#
+# It is recommended that this is called prior to launching threads. See
+# https://aws.amazon.com/blogs/developer/threading-with-the-aws-sdk-for-ruby/.
+Aws.eager_autoload!
 
 # Pull events from an Amazon Web Services Simple Queue Service (SQS) queue.
 #

data/logstash-input-sqs.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-input-sqs'
-  s.version         = '3.0.2'
+  s.version         = '3.0.3'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Pull events from an Amazon Web Services Simple Queue Service (SQS) queue."
   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"
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})

data/spec/inputs/sqs_spec.rb

@@ -1,10 +1,10 @@
 # encoding: utf-8
+require "spec_helper"
 require "logstash/inputs/sqs"
 require "logstash/errors"
 require "logstash/event"
 require "logstash/json"
 require "aws-sdk"
-require "spec_helper"
 require "ostruct"
 
 describe LogStash::Inputs::SQS do

data/spec/integration/sqs_spec.rb

@@ -1,9 +1,9 @@
 # encoding: utf-8
+require "spec_helper"
 require "logstash/inputs/sqs"
 require "logstash/event"
 require "logstash/json"
 require "aws-sdk"
-require "spec_helper"
 require_relative "../support/helpers"
 require "thread"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-sqs
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2017-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -84,7 +84,9 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/inputs/sqs.rb
+- lib/logstash/inputs/sqs/patch.rb
 - logstash-input-sqs.gemspec
 - spec/inputs/sqs_spec.rb
 - spec/integration/sqs_spec.rb
@@ -112,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.3
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: Pull events from an Amazon Web Services Simple Queue Service (SQS) queue.