logstash-output-kinesis-leprechaun-fork 0.1.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzFjOGFmMDNkMWUyNGYyOTMxMGNkNzMxZDg1ODZjZDMzYzMyNjExOQ==
+  data.tar.gz: !binary |-
+    N2U0YmRmMmNjN2FlYjFlMDQ4Mzg5NGI1NzhiMmE1OWQ1MmE3YmZkZg==
+SHA512:
+  metadata.gz: !binary |-
+    YmQ4NjA4N2Q2YzVkODFiNTNkOTYxOWNmMTk5Y2ViYTJkMGJjOWMwOGZlNWY4
+    ZTY2MzU3YzVhMDQ5M2Y5ZTdmY2E1ODAxNmRiZTU1ODEyODFhNDJkNmE4ZjI3
+    OTgxN2UzZTk0ZWUxOTRiMzFhMTgwYzEwODQ5MjkwYjNhZjA2YmM=
+  data.tar.gz: !binary |-
+    MWFlOTBiMjA4ZGJmYjc2MzYxM2EyYzExZmRiYWM2Y2MyNzE0NDFlODM2OTNj
+    ZTIyMjUzNjFmYzI3YmIyNTVjMzBiM2M3Zjk2ZWEzYWFhMmFlNGM3MDE4MjMw
+    ODkyZWUyYjk3NTA1YmJhZThlNDA4N2E3NzQ2OWQ5NzIwMmIyYjI=

data/.gitignore

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

data/CONTRIBUTORS

@@ -0,0 +1,18 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Aaron Broad (AaronTheApe)
+* James Turnbull (jamtur01)
+* John Price (awesometown)
+* Jordan Sissel (jordansissel)
+* Kurt Hurtado (kurtado)
+* Pier-Hugues Pellerin (ph)
+* Richard Pijnenburg (electrical)
+* Sean Laurent (organicveggie)
+* Toby Collier (tobyw4n)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+gem "logstash-mixin-aws", :github => "logstash-plugins/logstash-mixin-aws", :branch => "master"

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012-2015 Elasticsearch <http://www.elasticsearch.org>
+
+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 logstash-users@googlegroups.com mailing list.
+
+## 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/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/Rakefile

@@ -0,0 +1,7 @@
+@files=[]
+
+task :default do
+  system("rake -T")
+end
+
+require "logstash/devutils/rake"

data/lib/logstash/outputs/kinesis.rb

@@ -0,0 +1,197 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "logstash/plugin_mixins/aws_config"
+require "stud/buffer"
+require "digest/sha2"
+
+# Push events to an Amazon Web Services Kinesis stream.
+#
+# Amazon Kinesis is a fully managed, cloud-based service for real-time data processing
+# over large, distributed data streams.
+#
+# To use this plugin, you *must*:
+#
+#  * Have an AWS account
+#  * Setup an Kinesis stream
+#  * Create an identify that has access to publish messages to the stream.
+#
+# The "consumer" identity must have the following permissions on the strem:
+#
+#  * kinesis:PutRecords
+#
+# 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,ruby]
+#      {
+#        "Statement": [
+#          {
+#            "Sid": "Stmt1347986764948",
+#            "Action": [
+#                "kinesis:PutRecords",
+#            ],
+#            "Effect": "Allow",
+#            "Resource": [
+#              "arn:aws:kinesis:us-east-1:111122223333:stream/Logstash"
+#            ]
+#          }
+#        ]
+#      }
+#
+# See http://aws.amazon.com/iam/ for more details on setting up AWS identities.
+#
+# #### Usage:
+# This is an example of logstash config:
+# [source,ruby]
+# output {
+#    kinesis {
+#      access_key_id => "crazy_key"                (required)
+#      secret_access_key => "monkey_access_key"    (required)
+#      region => "eu-west-1"                       (required)
+#      stream_name => "my_stream"                  (required)
+#      event_partition_keys => ["message","@uuid"] (optional)
+#      batch_events => 100                         (optional, batch size)
+#      batch_timeout => 5                          (optional)
+#    }
+#
+class LogStash::Outputs::Kinesis < LogStash::Outputs::Base
+  include LogStash::PluginMixins::AwsConfig
+  include Stud::Buffer
+
+  config_name "kinesis"
+  milestone 1
+
+  # Name of Kinesis stream to push messages into. Note that this is just the name of the stream, not the URL or ARN.
+  config :stream_name, :validate => :string, :required => true
+
+  # Name of the field in an event that contains the partition key for kinesis
+  config :event_partition_keys, :validate => :array, :default => ["message", "@uuid"]
+
+  # Set to true if you want send messages to Kinesis in batches with `put_records`
+  # from the amazon sdk
+  config :batch, :validate => :boolean, :default => true
+
+  # If `batch` is set to true, the number of events we queue up for a `put_records`.
+  config :batch_events, :validate => :number, :default => 100
+
+  # If `batch` is set to true, the maximum amount of time between `put_records` commands when there are pending events to flush.
+  config :batch_timeout, :validate => :number, :default => 5
+
+  public
+  def aws_service_endpoint(region)
+    return {
+        :kinesis_endpoint => "kinesis.#{region}.amazonaws.com"
+    }
+  end
+
+  public 
+  def register
+    require "aws-sdk-resources"
+
+    @kinesis = Aws::Kinesis::Client.new(
+      region: @region,
+      access_key_id: @access_key_id,
+      secret_access_key: @secret_access_key
+    )
+
+    if @batch
+      if @batch_events > 500
+        raise RuntimeError.new(
+          "AWS only allows a batch_events parameter of 10 or less"
+        )
+      elsif @batch_events <= 1
+        raise RuntimeError.new(
+          "batch_events parameter must be greater than 1 (or its not a batch)"
+        )
+      end
+      buffer_initialize(
+        :max_items => @batch_events,
+        :max_interval => @batch_timeout,
+        :logger => @logger
+      )
+    else
+      raise NotImplementedError, 'Currently only batch write is supported'
+    end
+  end # def register
+
+  public
+  def receive(event)
+    if @batch
+      partition_key = ""
+
+      @event_partition_keys.each do |partition_key_name|
+        if not event[partition_key_name].nil? and event[partition_key_name].to_s.length > 0
+          @logger.info("Found field named #{partition_key_name}")
+          partition_key = event[partition_key_name].to_s
+          break
+        end
+        @logger.info("No field named #{partition_key_name}")
+      end
+
+      buffer_receive(
+        {
+          data: event.to_json,
+          partition_key: partition_key
+        }
+      )
+    else
+      raise NotImplementedError, 'Currently only batch write is supported'
+    end
+  end # def receive
+
+  # Return a list of events that failed when writing to kinesis
+  def get_failed_records(responses, events)
+    # Iterate over response records
+    response_record_index = 0
+    failed_events = []
+
+    # Check each page in the response
+    if responses.class.name == "Array"
+      responses.each do |response_page|
+        # Check each record in each page
+        response_page.data.records.each do |response_record|
+          # Collect all failed records
+          if not response_record.error_code.nil?
+            @logger.info("put_records: #{response_record.error_message} (#{response_record.error_code})")
+            failed_events.push(events[response_record_index])
+          end
+          response_record_index += 1
+        end
+      end
+    end
+
+    return failed_events
+  end
+
+  # called from Stud::Buffer#buffer_flush when there are events to flush
+  def flush(events, teardown=false)
+    # Initial backoff time
+    backoff = 0.01
+
+    # A retry loop
+    loop do
+      responses = @kinesis.put_records(
+        records: events,
+        stream_name: @stream_name
+      )
+
+      failed_events = get_failed_records(responses, events)
+
+      # Retry if failed events if any
+      break if failed_events.count == 0
+
+      @logger.warn("Failed #{failed_events.count} records. Retrying in #{backoff}.")
+      events = failed_events
+
+      # Exponential + random backoff
+      sleep(backoff)
+      backoff *= 1.95 + rand() / 10
+    end
+  end
+
+  public
+  def teardown
+    buffer_flush(:final => true)
+    finished
+  end # def teardown
+end

data/logstash-output-kinesis.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+  s.name            = 'logstash-output-kinesis-leprechaun-fork'
+  s.version         = '0.1.4'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "Push events to an Amazon Web Services Kinesis stream."
+  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 gemname. This gem is not a stand-alone program"
+  s.authors         = ["Elasticsearch", "Laurence MacGuire"]
+  s.email           = 'leprechaun@gmail.com'
+  s.homepage        = "https://github.com/leprechaun/logstash-output-kinesis"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)+::Dir.glob('vendor/*')
+
+  # 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" => "output" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency 'logstash-mixin-aws'
+
+  s.add_runtime_dependency 'aws-sdk-resources', '~> 2'
+  s.add_runtime_dependency 'stud'
+
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/outputs/kinesis_spec.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require 'logstash/outputs/kinesis'
+
+

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-kinesis-leprechaun-fork
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Elasticsearch
+- Laurence MacGuire
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  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
+  name: logstash-mixin-aws
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: stud
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  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 gemname. This gem is not
+  a stand-alone program
+email: leprechaun@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash/outputs/kinesis.rb
+- logstash-output-kinesis.gemspec
+- spec/outputs/kinesis_spec.rb
+homepage: https://github.com/leprechaun/logstash-output-kinesis
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+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: Push events to an Amazon Web Services Kinesis stream.
+test_files:
+- spec/outputs/kinesis_spec.rb