kinesis_firehose_batcher 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f7aa77caaf4838350f55a6d9e53cb238a3b7990
+  data.tar.gz: 1e40c75fbf390d61b789dd1ceb8459dd1f926234
+SHA512:
+  metadata.gz: 23c200f8d4861b6d8c02fb3844f0000cfb14c56fbb384a9aa39823a998179410a3a9d2e9141dc739cfcdec5ad4ed11d1c2bedb0efef73290fd4b03fde9c7401d
+  data.tar.gz: 68e699c094df07422e71e7a6fc6a51d3485650758311f5d0ea8418c96527ce70e88344180a0e73ff63982c6fbc1a456305e8c028d5830771197ecdd8ca1ddae9

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rake", '~> 10.5'
+  gem "bundler", "~> 1.0"
+  gem "rspec", "~> 3.2.0"
+  gem "jeweler", "~> 2.0.1"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 WeTransfer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,24 @@
+# kinesis_firehose_batcher
+
+Send record strings to AWS Kinesis Firehose in sensible batches (straddling the limits for the batch
+size, maximum number of records and maximum record length).
+
+    client = Aws::Firehose::Client.new(region: "us-east-1")
+    batcher = KinesisFirehoseBatcher.new(client: client, delivery_stream_name: 'my-stream')
+    9000.times { batcher <<  JSON.dump(some_record) }
+    batcher.send!
+
+## Contributing to kinesis_firehose_batcher
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2016 WeTransfer. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+require_relative 'lib/kinesis_firehose_batcher'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.version = KinesisFirehoseBatcher::VERSION
+  gem.name = "kinesis_firehose_batcher"
+  gem.homepage = "https://github.com/wetransfer/kinesis_firehose_batcher"
+  gem.license = "MIT"
+  gem.description = %Q{Sends records to Firehose, automatically honors the limits}
+  gem.summary = %Q{Batch-send records to AWS Kinesis Firehose}
+  gem.email = "me@julik.nl"
+  gem.authors = ["Julik Tarkhanov"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/kinesis_firehose_batcher.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: kinesis_firehose_batcher 0.0.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "kinesis_firehose_batcher"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Julik Tarkhanov"]
+  s.date = "2016-01-24"
+  s.description = "Sends records to Firehose, automatically honors the limits"
+  s.email = "me@julik.nl"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "kinesis_firehose_batcher.gemspec",
+    "lib/kinesis_firehose_batcher.rb",
+    "spec/kinesis_firehose_batcher_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "https://github.com/wetransfer/kinesis_firehose_batcher"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "Batch-send records to AWS Kinesis Firehose"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rake>, ["~> 10.5"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.2.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+    else
+      s.add_dependency(%q<rake>, ["~> 10.5"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<rspec>, ["~> 3.2.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    end
+  else
+    s.add_dependency(%q<rake>, ["~> 10.5"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<rspec>, ["~> 3.2.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+  end
+end
+

data/lib/kinesis_firehose_batcher.rb

@@ -0,0 +1,127 @@
+class KinesisFirehoseBatcher
+  VERSION = '0.0.1'
+  
+  MAX_BYTES_PER_BATCH = 4 * 1024 * 1024
+  MAX_RECORDS_PER_BATCH = 500
+  MAX_BYTES_PER_RECORD = 1000 * 1024
+  
+  # Gets raised when Firehose still refuses to accept records
+  # even once the tries have been exhausted
+  class RetriesExahusted < StandardError
+  end
+  
+  # Gets raised when a record string is too large to be sent via Firehose.
+  # If you encounter this, you need to use a side-channel to send data to
+  # the Firehose destination outside of the Firehose flow. For example,
+  # if you have a stream dumping data to S3 you might have to just grab the
+  # record and upload it separately.
+  class RecordTooLarge < StandardError
+    
+    # @param [String] the record that was too large
+    attr_reader :record
+    
+    def initialize(failed_record_string, *args_for_super)
+      @record = failed_record_string
+      super(*args_for_super)
+    end
+  end
+  
+  def initialize(client:, delivery_stream_name:, max_retries: 100)
+    @buffer = []
+    @client, @delivery_stream_name, @max_retries = client, delivery_stream_name, max_retries
+  end
+  
+  # Add a record (string) to the batch
+  #
+  # @param str[String] The record to add
+  def <<(str)
+    raise RecordTooLarge.new(str) if str.bytesize >= MAX_BYTES_PER_RECORD
+    @buffer << str
+  end
+  
+  # Send the accumulated records in the buffer, and empty the buffer afterwards.
+  #
+  # @return [void]
+  def send!
+    return if @buffer.empty?
+    recursive_send(@buffer)
+    @buffer.clear
+  end
+  
+  # Tells how many records are in the buffer, ready to send
+  #
+  # @return [Fixnum] the number of records outstanding
+  def buffered
+    @buffer.length
+  end
+  
+  private
+  
+  # Accepts an array of Strings (records) and sends them via the client
+  # supplied to the constructor
+  #
+  # Kept in a separate method because normal Kinesis (not Firehose) has
+  # a different way of packing records and a different method signature
+  #
+  # @param record_strings[Array<String>] the array of records to send
+  # @return [Aws::Firehose::Types::PutRecordBatchOutput]
+  def send_via_client(record_strings)
+    record_hashes = record_strings.map do | str |
+      {data: str}
+    end
+    @client.put_record_batch(records: record_hashes, delivery_stream_name: @delivery_stream_name)
+  end
+  
+  def recursive_send(array_of_record_strings)
+    if array_of_record_strings.empty?
+      return 
+    elsif overflow?(array_of_record_strings)
+      # Split the array into parts and try again.
+      array_of_record_strings.each_slice(array_of_record_strings.length / 2) do | slice |
+        recursive_send(slice)
+      end
+    else
+      send_with_retries(array_of_record_strings)
+      array_of_record_strings.clear
+    end
+  end
+  
+  def overflow?(array_of_record_strings)
+    # Each PutRecordBatch request supports up to 500 array_of_record_strings.
+    # Each record in the request can be as large as 1,000 KB (before 64-bit encoding),
+    # up to a limit of 4 MB for the entire request.
+    return true if array_of_record_strings.length >= MAX_RECORDS_PER_BATCH
+    return true if packet_size(array_of_record_strings) >= MAX_BYTES_PER_BATCH
+  end
+  
+  def send_with_retries(record_hashes)
+    result = send_via_client(record_hashes)
+    
+    return if result.failed_put_count.zero?
+    
+    tries = 0
+    
+    while result.failed_put_count.nonzero?
+      tries += 1
+      if tries >= @max_retries
+        msg = "%d records still failed to send after %d tries" % [result.failed_put_count, tries]
+        raise RetriesExahusted.new(msg)
+      end
+       
+      # Replace all the records that did manage to send with nils
+      result.request_responses.each_with_index do | record_response, record_i |
+        record_hashes[record_i] = nil if record_response.record_id
+      end
+      
+      # Squash out all the nils (records that were sent during the previous try
+      record_hashes.compact!
+      
+      #... and try to send again
+      result = send_via_client(record_hashes)
+    end
+  end
+  
+  def packet_size(array_of_strings)
+    array_of_strings.inject(0) {|bytesize, record_str| bytesize + record_str.bytesize }
+  end
+end

data/spec/kinesis_firehose_batcher_spec.rb

@@ -0,0 +1,113 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'securerandom'
+describe KinesisFirehoseBatcher do
+  it "batches the records for sending" do
+    client = double('Aws::Firehose::Client')
+    
+    s = described_class.new(client: client, delivery_stream_name: 'some-stream')
+    
+    2000.times { s << "Some message\n" }
+    1000.times { s << "Another message\n" }
+    
+    expect(s.buffered).to eq(3000)
+    
+    s << "Closing message"
+    
+    message_sends = []
+    expect(client).to receive(:put_record_batch).exactly(9).times {|*args|
+      message_sends << args
+      double(:failed_put_count => 0)
+    }
+    
+    s.send!
+    
+    expect(message_sends).not_to be_empty
+    message_sends.each do | one_put_batch_call |
+      args = one_put_batch_call[0]
+      expect(args[:delivery_stream_name]).to eq('some-stream')
+      
+      records = args[:records]
+      expect(records).not_to be_empty
+      expect(records.length).to be < KinesisFirehoseBatcher::MAX_RECORDS_PER_BATCH
+  
+      record_strings = records.map{|e| e.fetch(:data) }
+      entire_message = record_strings.join
+      
+      expect(entire_message.bytesize).to be < KinesisFirehoseBatcher::MAX_BYTES_PER_BATCH 
+    end
+    
+    total_records = message_sends.map{|e| e[0][:records]}.flatten
+    expect(total_records.length).to eq(3001)
+  end
+  
+  it 'attempts to resend the records that failed' do
+    client = double('Aws::Firehose::Client')
+    s = described_class.new(client: client, delivery_stream_name: 'some-stream')
+    
+    expect(s).to receive(:send_via_client).once.with(['Hello 1', 'Hello 2', 'Hello 3']) {
+      fake_record_responses = [
+        double(record_id: SecureRandom.hex(2)),
+        double(record_id: nil),
+        double(record_id: SecureRandom.hex(2)),
+      ]
+      double('Firehose response', :request_responses => fake_record_responses, :failed_put_count => 1)
+    }
+    
+    expect(s).to receive(:send_via_client).once.with(['Hello 2']) {
+      fake_record_responses = [
+        double(record_id: SecureRandom.hex(2)),
+      ]
+      double('Firehose response', :request_responses => fake_record_responses, :failed_put_count => 0)
+    }
+    
+    (1..3).each { |i| s << "Hello #{i}" }
+    s.send!
+  end
+  
+  it 'sends via the given client' do
+    client = double('Aws::Firehose::Client')
+    s = described_class.new(client: client, delivery_stream_name: 'some-stream')
+    expect(client).to receive(:put_record_batch).with({
+      delivery_stream_name: 'some-stream',
+      records: [{data: 'Hello 1'}, {data: 'Hello 2'}, {data: 'Hello 3'}]
+    }).and_return(double(failed_put_count: 0))
+    
+    (1..3).each { |i| s << "Hello #{i}" }
+    
+    s.send!
+  end
+  
+  it 'gives up after the set number of retries' do
+    client = double('Aws::Firehose::Client')
+    s = described_class.new(client: double(), delivery_stream_name: 'some-stream', max_retries: 123)
+    
+    tries_used = 0
+    allow(s).to receive(:send_via_client) { |record_strings|
+      tries_used += 1
+      # Always fail one record of the batch
+      sent_record_response = double(record_id: SecureRandom.hex(2))
+      failed_record_response = double(record_id: nil)
+      
+      record_responses = [sent_record_response] * (record_strings.length - 1)
+      record_responses << failed_record_response
+      record_responses.shuffle!
+      
+      double('Firehose response', :request_responses => record_responses, :failed_put_count => 1)
+    }
+    7000.times { s << "Hello and goodbye - just a record here\n" }
+    expect {
+      s.send!
+    }.to raise_error(KinesisFirehoseBatcher::RetriesExahusted)
+    expect(tries_used).to eq(123)
+  end
+  
+  it 'explicitly fails when a record is too large' do
+    s = described_class.new(client: double(), delivery_stream_name: 'some-stream')
+    expect {
+      s << Random.new.bytes(1024 * 1024 * 3)
+    }.to raise_error {|e|
+      expect(e).to be_kind_of(KinesisFirehoseBatcher::RecordTooLarge)
+      expect(e.record).to be_kind_of(String)
+    }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'kinesis_firehose_batcher'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: kinesis_firehose_batcher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: Sends records to Firehose, automatically honors the limits
+email: me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kinesis_firehose_batcher.gemspec
+- lib/kinesis_firehose_batcher.rb
+- spec/kinesis_firehose_batcher_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/wetransfer/kinesis_firehose_batcher
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Batch-send records to AWS Kinesis Firehose
+test_files: []