fluent-plugin-azure-queue 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6a171e37ab51926fea05fb9a3af2b1732c2dc06
+  data.tar.gz: 20de54cb2df97d3a1f2f25d2e66a30a6b8ea79e6
+SHA512:
+  metadata.gz: ef3d713e38a5cee209a69930dfba747ac37239d1ae443e7473de000391b558bd9eecae4f29b6e111e3d891bb1fe91b17b0dbe458dbf9a2905e16e27939966bd5
+  data.tar.gz: aef6bd13e15495361dcc8414d3b17d8abf92c13ca87b98bd6e76c057d0f2e7be0d68fe2b8a750ccbcad6b1818a88fef959369f2f0069397b3128e90d94651ef6

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+
+rvm:
+  - 2.1
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+
+branches:
+  only:
+    - master
+
+gemfile:
+ - Gemfile
+
+before_install: gem update bundler
+script: bundle exec rake test
+
+sudo: false

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    fluent-plugin-azure-queue (0.0.1.pre.pre)
+      azure-storage (>= 0.12.3.preview, < 0.13)
+      fluentd (>= 0.12.2, < 0.14)
+      nokogiri
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    azure-core (0.1.10)
+      faraday (~> 0.9)
+      faraday_middleware (~> 0.10)
+    azure-storage (0.12.3.preview)
+      azure-core (~> 0.1)
+      faraday (~> 0.9)
+      faraday_middleware (~> 0.10)
+    cool.io (1.5.1)
+    faraday (0.13.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    flexmock (2.3.5)
+    fluentd (0.12.39)
+      cool.io (>= 1.2.2, < 2.0.0)
+      http_parser.rb (>= 0.5.1, < 0.7.0)
+      json (>= 1.4.3)
+      msgpack (>= 0.5.11, < 2)
+      sigdump (~> 0.2.2)
+      string-scrub (>= 0.0.3, <= 0.0.5)
+      tzinfo (>= 1.0.0)
+      tzinfo-data (>= 1.0.0)
+      yajl-ruby (~> 1.0)
+    http_parser.rb (0.6.0)
+    json (2.1.0)
+    mini_portile2 (2.1.0)
+    msgpack (1.1.0)
+    multipart-post (2.0.0)
+    nokogiri (1.7.2)
+      mini_portile2 (~> 2.1.0)
+    power_assert (1.0.2)
+    rake (12.0.0)
+    sigdump (0.2.4)
+    string-scrub (0.0.5)
+    test-unit (3.2.5)
+      power_assert
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    tzinfo-data (1.2017.2)
+      tzinfo (>= 1.0.0)
+    yajl-ruby (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  flexmock (>= 1.3.3)
+  fluent-plugin-azure-queue!
+  rake (>= 0.9.2)
+  test-unit (>= 3.0.8)
+
+BUNDLED WITH
+   1.15.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Scott Bonebrake
+
+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,51 @@
+# A  [Fluentd](http://github.com/fluent/fluentd) plugin to read from azure queues
+
+## Dependencies
+
+fluentd v.12
+
+## Input: Configuration
+
+    <source>
+      @type azure_queue
+
+      tag queue_input
+      storage_account_name my_storage_account
+      storage_access_key my_storage_access_key
+      queue_name my_storage_queue
+      fetch_interval 5     
+      batch_size 10 
+      lease_time 30
+    </source>
+
+**tag (required)**
+
+The tag for the input
+
+**storage_account_name (required)**
+
+The storage account name
+
+**storage_access_key (required)**
+
+The storage account access key
+
+**queue_name (required)**
+
+The storage queue name
+
+**message_key**
+
+The the record key to put the message data into. Default 'message'
+
+**fetch_interval**
+
+How long to wait between getting messages from the queue. Default 5
+
+**batch_size**
+
+The maximum number of messages to pull from the queue at once. Default 10. Max 32
+
+**lease_time**
+
+The time to lease the messages for. Default 30

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib'
+  test.test_files = FileList['test/test_*.rb']
+  test.verbose = false
+  test.warning = false
+end
+
+task :default => [:build]

data/VERSION

@@ -0,0 +1 @@
+0.0.1.pre

data/fluent-plugin-azure-queue.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "fluent-plugin-azure-queue"
+  gem.description = "Fluent input plugin for azure queue input"
+  gem.license     = "MIT"
+  gem.homepage    = "https://github.com/sbonebrake/fluent-plugin-azure-queue"
+  gem.summary     = gem.description
+  gem.version     = File.read("VERSION").strip
+  gem.authors     = ["Scott Bonebrake"]
+  gem.email       = "N/A"
+  gem.has_rdoc    = false
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ['lib']
+
+  gem.add_dependency "fluentd", [">= 0.12.2", "< 0.14"]
+  gem.add_dependency "azure-storage", [">= 0.12.3.preview", "< 0.13"]
+  gem.add_dependency "nokogiri"
+  gem.add_development_dependency "rake", ">= 0.9.2"
+  gem.add_development_dependency "test-unit", ">= 3.0.8"
+  gem.add_development_dependency "flexmock", ">= 1.3.3"
+end

data/lib/fluent/plugin/in_azure_queue.rb

@@ -0,0 +1,90 @@
+require 'fluent/input'
+require 'azure/storage'
+require 'base64'
+
+module Fluent
+  class AzureQueueInput < Input
+    Fluent::Plugin.register_input('azure_queue', self)
+
+    desc 'Tag of the output events.'
+    config_param :tag, :string
+    desc 'The azure storage account name'
+    config_param :storage_account_name, :string
+    desc 'The azure storage account access key'
+    config_param :storage_access_key, :string
+    desc 'The azure storage account queue name'
+    config_param :queue_name, :string
+    desc 'The the record key to put the message data into'
+    config_param :message_key, :string, default: 'message'
+    desc 'The time in seconds to sleep between fetching messages'
+    config_param :fetch_interval, :integer, default: 5
+    desc 'The number of messages to fetch during each request'
+    config_param :batch_size, :integer, default: 10
+    desc 'The the lease time on the messages in seconds'
+    config_param :lease_time, :integer, default: 30
+
+    def configure(conf)
+      super
+    end
+
+    def start
+      super
+      if @batch_size > 32 || @batch_size < 1
+        raise Fluent::ConfigError, "fluent-plugin-azure-queue: 'batch_size' parameter must be between 1 and 32: #{@batch_size}"
+      end
+      @queue_client = Azure::Storage::Client.create(
+        :storage_account_name => @storage_account_name,
+        :storage_access_key => @storage_access_key).queue_client
+      log.debug("Succeeded to creating azure queue client")
+      @running = true
+
+      @thread = Thread.new(&method(:run))
+    end
+
+    def shutdown
+      log.debug("Begin azure queue shutdown")
+      @running = false
+      @thread.join
+      log.debug("Finish azure queue shutdown")
+      super
+    end
+
+    private
+
+    def run
+      log.debug("Begin running azure queue")
+      @next_fetch_time = Time.now
+      while @running
+        deleted = false
+        begin
+          if Time.now > @next_fetch_time
+            @next_fetch_time += @fetch_interval
+            log.trace("Fetching #{@batch_size} messages from azure queue", queue_name: @queue_name)
+            messages = @queue_client.list_messages(@queue_name, @lease_time, { number_of_messages: @batch_size })
+            log.trace("Recieved #{messages.count} messages from azure queue", queue_name: @queue_name)
+            messages.each do |message|
+              deleted = false
+              message_content = Base64.decode64(message.message_text)
+              router.emit(@tag, Fluent::Engine.now, { @message_key => message_content })
+              log.trace("Emitted azure queue message", queue_name: @queue_name, id: message.id, content: message_content)
+              @queue_client.delete_message(@queue_name, message.id, message.pop_receipt)
+              log.trace("Deleted azure queue message", queue_name: @queue_name, id: message.id)
+              deleted = true
+            end
+          else
+            sleep 0.05
+          end
+        rescue => e
+          if deleted
+            log.warn(error: e)
+            log.warn_backtrace(e.backtrace)
+          else
+            log.warn("Message emmitted but not deleted from azure queue", queue_name: @queue_name, error: e)
+            log.warn_backtrace(e.backtrace)
+          end
+        end
+      end
+
+    end
+  end
+end

data/test/test_in_azure_queue.rb

@@ -0,0 +1,73 @@
+require 'fluent/test'
+require 'fluent/plugin/in_azure_queue'
+require 'flexmock/test_unit'
+
+class AzureQueueInputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+    @time = Time.parse("2017-08-17 18:03:27 UTC")
+    Fluent::Engine.now = @time
+    if Fluent.const_defined?(:EventTime)
+      stub(Fluent::EventTime).now { @time }
+    end
+  end
+
+  CONFIG = %[
+    tag test_tag
+    storage_account_name test_storage_account_name
+    storage_access_key test_storage_access_key
+    queue_name test_queue_name
+  ]
+
+  def create_driver(conf = CONFIG)
+    d = Fluent::Test::InputTestDriver.new(Fluent::AzureQueueInput)
+    d.configure(conf)
+    d
+  end
+
+  def test_configure
+    d = create_driver
+    assert_equal 'test_tag', d.instance.tag
+    assert_equal 'test_storage_account_name', d.instance.storage_account_name
+    assert_equal 'test_storage_access_key', d.instance.storage_access_key
+    assert_equal 'test_queue_name', d.instance.queue_name
+  end
+
+  Struct.new("QueueMessage", :id, :pop_receipt, :message_text)
+
+  def setup_mocks(driver, messages)
+    queue_client = flexmock("queue_client")
+    queue_client.should_receive(:list_messages).with(
+      driver.instance.queue_name,
+      driver.instance.lease_time,
+      { number_of_messages: driver.instance.batch_size}).and_return(messages).once
+    client = flexmock("client", :queue_client => queue_client)
+    flexmock(Azure::Storage::Client, :create => client)
+    queue_client
+  end
+
+  def test_two_messages
+    d = create_driver
+    messages = [ Struct::QueueMessage.new(1, 99, Base64.encode64("test line")),
+                 Struct::QueueMessage.new(2, 100, Base64.encode64("test line2"))]
+    queue_client = setup_mocks(d, messages)
+    queue_client.should_receive(:delete_message).with(d.instance.queue_name, messages[0].id,messages[0].pop_receipt).once
+    queue_client.should_receive(:delete_message).with(d.instance.queue_name, messages[1].id,messages[1].pop_receipt).once
+    d.run do
+      sleep 1
+    end
+    assert_equal(2, d.emits.size)
+    d.expect_emit(d.instance.tag, @time, { "message" => "test line" })
+    d.expect_emit(d.instance.tag, @time, { "message" => "test line2" })
+  end
+
+  def test_no_messages
+    d = create_driver
+    messages = []
+    queue_client = setup_mocks(d, messages)
+    d.run do
+      sleep 1
+    end
+    assert_equal(0, d.emits.size)
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-azure-queue
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Scott Bonebrake
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: azure-storage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.3.preview
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.3.preview
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.8
+- !ruby/object:Gem::Dependency
+  name: flexmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+description: Fluent input plugin for azure queue input
+email: N/A
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- fluent-plugin-azure-queue.gemspec
+- lib/fluent/plugin/in_azure_queue.rb
+- test/test_in_azure_queue.rb
+homepage: https://github.com/sbonebrake/fluent-plugin-azure-queue
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Fluent input plugin for azure queue input
+test_files:
+- test/test_in_azure_queue.rb