logstash-output-sqs 4.0.1 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50011fedd9648692ca0abd4a9d8b2ad6ad481bfb
-  data.tar.gz: 7c070bfcc27bb92c1098ff67f52ee6534e575621
+  metadata.gz: c95c261d6faf83b572387f0b6a45edf2fc7f4730
+  data.tar.gz: d44da9ac380fd7a51631a9f5e58c43747dd7c56c
 SHA512:
-  metadata.gz: 35e0ccae091d594155a183b5007bfe4080b5741489df1e92d4517b790c2f6d15db8878f40dda54e3c588d127f84befc99ca55e58980493ddf78d079b98bad8da
-  data.tar.gz: 16aa582081eb1681d775f2ca7d4b4356d9b7bfc587dd14b2f208e2c8aaf4ef498dcd46ba2014c3d7d87d21e836d181a16957e068818565363d282419fb2d38c6
+  metadata.gz: d0edc16e7fc4ff65fc755b02755c26af9ea72cf757d1a94f7ed9eecd7f23017d62186b17e92be8f5e37b475048a72dd84804b7483272673f599230cbb114ecb2
+  data.tar.gz: 47af2b390102796f5741379a647f9aee0e5917e2b3c8a1537e677542f5cc8a1668b21f2071f38b82da6eef90c3d3fb6f19bc45ead82ab7f985abdacc2e3086d7

data/Gemfile

@@ -1,4 +1,11 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in logstash-mass_effect.gemspec
 gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/docs/index.asciidoc

@@ -0,0 +1,218 @@
+:plugin: sqs
+:type: output
+
+///////////////////////////////////////////
+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 output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+Push events to an Amazon Web Services (AWS) 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
+such as Advanced Message Queuing Protocol (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.
+
+The "consumer" identity must have the following permissions on the queue:
+
+  * `sqs:GetQueueUrl`
+  * `sqs:SendMessage`
+  * `sqs:SendMessageBatch`
+
+Typically, you should setup an IAM policy, create a user and apply the IAM
+policy to the user. See http://aws.amazon.com/iam/ for more details on
+setting up AWS identities. A sample policy is as follows:
+
+[source,json]
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Effect": "Allow",
+      "Action": [
+        "sqs:GetQueueUrl",
+        "sqs:SendMessage",
+        "sqs:SendMessageBatch"
+      ],
+      "Resource": "arn:aws:sqs:us-east-1:123456789012:my-sqs-queue"
+    }
+  ]
+}
+
+==== Batch Publishing
+This output publishes messages to SQS in batches in order to optimize event
+throughput and increase performance. This is done using the
+[`SendMessageBatch`](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessageBatch.html)
+API. When publishing messages to SQS in batches, the following service limits
+must be respected (see
+[Limits in Amazon SQS](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-messages.html)):
+
+  * The maximum allowed individual message size is 256KiB.
+  * The maximum total payload size (i.e. the sum of the sizes of all
+    individual messages within a batch) is also 256KiB.
+
+This plugin will dynamically adjust the size of the batch published to SQS in
+order to ensure that the total payload size does not exceed 256KiB.
+
+WARNING: This output cannot currently handle messages larger than 256KiB. Any
+single message exceeding this size will be dropped.
+
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Sqs Output Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-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}-batch_events>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-message_max_size>> |<<bytes,bytes>>|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}-session_token>> |<<string,string>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+output 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}-batch"]
+===== `batch`  (DEPRECATED)
+
+  * DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Set to `true` to send messages to SQS in batches (with the
+`SendMessageBatch` API) or `false` to send messages to SQS individually
+(with the `SendMessage` API). The size of the batch is configurable via
+`batch_events`.
+
+[id="plugins-{type}s-{plugin}-batch_events"]
+===== `batch_events` 
+
+  * Value type is <<number,number>>
+  * Default value is `10`
+
+The number of events to be sent in each batch. Set this to `1` to disable
+the batch sending of messages.
+
+[id="plugins-{type}s-{plugin}-batch_timeout"]
+===== `batch_timeout`  (DEPRECATED)
+
+  * DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
+  * Value type is <<number,number>>
+  * There is no default value for this setting.
+
+
+
+[id="plugins-{type}s-{plugin}-message_max_size"]
+===== `message_max_size` 
+
+  * Value type is <<bytes,bytes>>
+  * Default value is `"256KiB"`
+
+The maximum number of bytes for any message sent to SQS. Messages exceeding
+this size will be dropped. See
+http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-messages.html.
+
+[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.
+
+The name of the target SQS queue. 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}-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}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-output-sqs.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-sqs'
-  s.version         = '4.0.1'
+  s.version         = '4.0.2'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Push events to 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"
@@ -11,7 +11,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)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-sqs
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.0.2
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-02-15 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -84,6 +84,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/outputs/sqs.rb
 - lib/logstash/outputs/sqs/patch.rb
 - logstash-output-sqs.gemspec