logstash-input-kinesis 2.0.4-java → 2.0.5-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b5c3090597b24ebd6da06abbbf85c0df32ea4ea0
-  data.tar.gz: 8ff2630b18a77e3ea6dcf24edcc431e795dbfaec
+SHA256:
+  metadata.gz: f3e4d9614e4481f001a52c155e113fa7597462bd6d23961e3ae925895b5c800f
+  data.tar.gz: 35e2f182b3c99631a5dc8585b161239b3d25881654869423d84cad7cff3394ae
 SHA512:
-  metadata.gz: 7ee4c392e8632b9ba9585be1ea6559352242d2d9b6fcde2039f38219844d4290b59c4f25b3f3ed8fbf9074a5c201b7ef6dcd96c57c6000ffaf1e3bc9b882c57e
-  data.tar.gz: dba756ebc37f517ea69528abd87a9ce8df261165cb48c8d2ccdcc4d27721d54541b00e4b9d8a3e32626053a3ce1bf65ea6d067a23d7ff81375659981e5622db3
+  metadata.gz: 0aa496b90b0bc671323218b4a1d057857c518745a9e5b2eff66272598f37507a7ea4fc049f48e405c480ad56beafd1f69bad6cd22fdc8e230d429f28a9de1295
+  data.tar.gz: e6461c17ea75489281a20cb216494d864559bb6ea59a3f5dc69b0a2f997038a8d97f9b27ac2c980f2c53a6e8ed4357a339dc31c66e84963546c49aaf618e6079

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+## 2.0.5
+ - Docs: Add CHANGELOG.md
+ - Support for specifying an AWS credentials profile with the `profile` config parameter
+ - Docs: Remove extraneous text added during doc extract
+
+## 2.0.4
+ -  Docs: Bump version for automated doc build
+
+## 2.0.3
+ -  Fix error about failed to coerce java.util.logging.Level to org.apache.log4j.Level with logstash 5.1.1
+
+## 2.0.2
+ -  Fix error with Logstash 5.0
+ 
+## 2.0.1
+ -  Add partition_key, approximate_arrival_timestamp and sequence_number fields in the @metadata sub-has

data/README.md

@@ -46,10 +46,13 @@ This are the properties you can configure and what are the default values:
 * `metrics`: Worker metric tracking. By default this is disabled, set it to "cloudwatch" to enable the cloudwatch integration in the Kinesis Client Library.
     * **required**: false
     * **default value**: `nil`
+* `profile`: The AWS profile name for authentication. This ensures that the `~/.aws/credentials` AWS auth provider is used. By default this is empty and the default chain will be used.
+    * **required**: false
+    * **default value**: `""`    
 
 ## Authentication
 
-This plugin uses the default AWS SDK auth chain, [DefaultAWSCredentialsProviderChain](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/DefaultAWSCredentialsProviderChain.html), to determine which credentials the client will use.
+This plugin uses the default AWS SDK auth chain, [DefaultAWSCredentialsProviderChain](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/DefaultAWSCredentialsProviderChain.html), to determine which credentials the client will use, unless `profile` is set, in which case [ProfileCredentialsProvider](http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/profile/ProfileCredentialsProvider.html) is used.
 
 The default chain follows this order trying to read the credentials:
  * `AWS_ACCESS_KEY_ID` / `AWS_SECRET_KEY` environment variables
@@ -61,7 +64,7 @@ The credentials will need access to the following services:
 * AWS DynamoDB: the client library stores information for worker coordination in DynamoDB (offsets and active worker per partition)
 * AWS CloudWatch: if the metrics are enabled the credentials need CloudWatch update permisions granted.
 
-Look at the [documentation](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/DefaultAWSCredentialsProviderChain.html) for deeper information.
+Look at the [documentation](https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/DefaultAWSCredentialsProviderChain.html) for deeper information on the default chain.
 
 ## Contributing
 

data/lib/logstash/inputs/kinesis.rb

@@ -50,6 +50,9 @@ class LogStash::Inputs::Kinesis < LogStash::Inputs::Base
   # to enable the cloudwatch integration in the Kinesis Client Library.
   config :metrics, :validate => [nil, "cloudwatch"], :default => nil
 
+  # Select AWS profile for input
+  config :profile, :validate => :string
+
   def initialize(params = {})
     super(params)
   end
@@ -64,7 +67,14 @@ class LogStash::Inputs::Kinesis < LogStash::Inputs::Base
     end
 
     worker_id = java.util::UUID.randomUUID.to_s
-    creds = com.amazonaws.auth::DefaultAWSCredentialsProviderChain.new
+
+    # If the AWS profile is set, use the profile credentials provider.
+    # Otherwise fall back to the default chain.
+    unless @profile.nil?
+      creds = com.amazonaws.auth.profile::ProfileCredentialsProvider.new(@profile)
+    else
+      creds = com.amazonaws.auth::DefaultAWSCredentialsProviderChain.new
+    end
     @kcl_config = KCL::KinesisClientLibConfiguration.new(
       @application_name,
       @kinesis_stream_name,

data/lib/logstash/inputs/kinesis/version.rb

@@ -2,7 +2,7 @@
 module Logstash
   module Input
     module Kinesis
-      VERSION = "2.0.4"
+      VERSION = "2.0.5"
     end
   end
 end

data/spec/inputs/kinesis_spec.rb

@@ -2,7 +2,6 @@ require "logstash/plugin"
 require "logstash/inputs/kinesis"
 require "logstash/codecs/json"
 
-
 RSpec.describe "inputs/kinesis" do
   KCL = com.amazonaws.services.kinesis.clientlibrary.lib.worker
 
@@ -13,6 +12,18 @@ RSpec.describe "inputs/kinesis" do
     "metrics" => metrics,
     "checkpoint_interval_seconds" => 120,
     "region" => "ap-southeast-1",
+    "profile" => nil
+  }}
+
+  # Config hash to test credentials provider to be used if profile is specified
+  let(:config_with_profile) {{
+    "application_name" => "my-processor",
+    "kinesis_stream_name" => "run-specs",
+    "codec" => codec,
+    "metrics" => metrics,
+    "checkpoint_interval_seconds" => 120,
+    "region" => "ap-southeast-1",
+    "profile" => "my-aws-profile"
   }}
 
   subject!(:kinesis) { LogStash::Inputs::Kinesis.new(config) }
@@ -33,6 +44,14 @@ RSpec.describe "inputs/kinesis" do
     expect(kinesis.kcl_config.streamName).to eq("run-specs")
     expect(kinesis.kcl_config.regionName).to eq("ap-southeast-1")
     expect(kinesis.kcl_config.initialPositionInStream).to eq(KCL::InitialPositionInStream::TRIM_HORIZON)
+    expect(kinesis.kcl_config.get_kinesis_credentials_provider.getClass.to_s).to eq("com.amazonaws.auth.DefaultAWSCredentialsProviderChain")
+  end
+
+  subject!(:kinesis_with_profile) { LogStash::Inputs::Kinesis.new(config_with_profile) }
+
+  it "uses ProfileCredentialsProvider if profile is specified" do
+    kinesis_with_profile.register
+    expect(kinesis_with_profile.kcl_config.get_kinesis_credentials_provider.getClass.to_s).to eq("com.amazonaws.auth.profile.ProfileCredentialsProvider")
   end
 
   context "#run" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-kinesis
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: java
 authors:
 - Brian Palmer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-27 00:00:00.000000000 Z
+date: 2017-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -72,13 +72,16 @@ dependencies:
     - - ">="
       - !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 gemname. This gem is not a stand-alone program
+description: This gem is a logstash plugin required to be installed on top of the
+  Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not
+  a stand-alone program
 email:
 - brian@codekitchen.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - CONTRIBUTORS
 - Gemfile
 - README.md
@@ -134,7 +137,7 @@ requirements:
 - jar 'com.amazonaws:amazon-kinesis-client', '1.7.0'
 - jar 'com.amazonaws:aws-java-sdk-core', '1.11.16'
 rubyforge_project:
-rubygems_version: 2.4.8
+rubygems_version: 2.6.11
 signing_key:
 specification_version: 4
 summary: Logstash plugin for Kinesis input