logstash-input-azuretopicthreadable 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eab44087211786edf86b50c29a10ad7624e0bc05
-  data.tar.gz: 080965dacdf000fc5447e1c36f2c4c981dd051a2
+  metadata.gz: fecf30d90dc023f7d2c2349fcbc64c4dc70c57eb
+  data.tar.gz: d762ad0321bba4b9698c57cf34f0fed1f8ee3391
 SHA512:
-  metadata.gz: 22aa9895e67c75d0e6560114910e69ced23fc8a33f73f17af4e253ed562b34b2182bf218b25b1e6dbf4c1a27e3063008459d8cfb40de441a76cd26abe7a9cccb
-  data.tar.gz: 570286a844078687db1a1a06495bf5994f0e9b55b6a2ae5d6e755b0cbb199e50c4c93dd041c0822032caf55e36d893be8e320839361eb51f391f53e41c6988f7
+  metadata.gz: f0000ca97d12e22de2faf2409f7dd3c3df38c42e43a1e893056fd2aa6f2ce95172e48cee4d7e7c90c9df6c69e0901a70341d0b1858166460fb566cfc2cc64214
+  data.tar.gz: 1d9438970c38b766a60858bce0ca5a6f912d46b00b7d27be489908c04603cbcb9cbf1331945f462b9086e9a7361a1fa061b76886a1e7c2a1dcabaa733bba1402

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 2016.05.03
+* Made the plugin to respect Logstash shutdown signal.
+* Updated the *logstash-core* runtime dependency requirement to '~> 2.0'.
+* Updated the *logstash-devutils* development dependency requirement to '>= 0.0.16'

data/Gemfile

@@ -1,3 +1,2 @@
 source 'https://rubygems.org'
 gemspec
-gem 'azure', '~> 0.7.1'

data/README.md

@@ -1,91 +1,60 @@
-# Notice
-This plugin is a part of [Microsoft Azure Diagnostics with ELK](https://github.com/mspnp/semantic-logging/tree/v3/ELK).
-
-[See more documentation.](https://github.com/mspnp/semantic-logging/blob/v3/ELK/md/LogstashExtensions.md#azure-wad-table)
-
-# 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 https://discuss.elastic.co/c/logstash discussion forum.
-
-## 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.
+# Logstash input plugin for Azure Service Bus Topics
+
+## Summary
+This plugin reads messages from Azure Service Bus Topics using multiple threads.
+
+## Installation
+You can install this plugin using the Logstash "plugin" or "logstash-plugin" (for newer versions of Logstash) command:
+```sh
+logstash-plugin install logstash-input-azuretopicthreadable
+```
+For more information, see Logstash reference [Working with plugins](https://www.elastic.co/guide/en/logstash/current/working-with-plugins.html).
+
+## Configuration
+### Required Parameters
+__*namespace*__
+
+The Service Bus namespace.
+
+__*access_key*__
+
+The access key to the Service Bus resource.
+
+__*subscription*__
+
+The name of the Topic Subscription.
+
+__*topic*__
+
+The name of the Topic.
+
+### Optional Parameters
+__*deliverycount*__
+
+Specifies the number of times to try (and retry) to process a message before the message shall be deleted. The default value is 10.
+
+__*threads*__
+
+Specifies the number of threads to use to read the messages. The default value is 1.
+
+__*thread_sleep_time*__
+
+Specifies the number of seconds each thread should sleep before starting another loop of processing. The default value is 1/50.
+
+### Examples
+```
+input
+{
+    azuretopic
+    {
+        namespace => "mysbns"
+        access_key => "VGhpcyBpcyBhIGZha2Uga2V5Lg=="
+        subscription => "mytopicsubscription"
+        topic => "mytopic"
+        threads => 3
+    }
+}
+```
+
+## More information
+The source code of this plugin is hosted in GitHub repo [Microsoft Azure Diagnostics with ELK](https://github.com/Azure/azure-diagnostics-tools). We welcome you to provide feedback and/or contribute to the project.

data/lib/logstash/inputs/azuretopicthreadable.rb

@@ -1,78 +1,77 @@
-# encoding: utf-8
-require "logstash/inputs/base"
-require "logstash/namespace"
-
-require "thread"
-
-require "azure"
-
-# Reads events from Azure topics
-class LogStash::Inputs::Azuretopicthreadable < LogStash::Inputs::Base
-  class Interrupted < StandardError; end
-
-  config_name "azuretopicthreadable"
-  milestone 0
-  
-  default :codec, "json" # default json codec
-  
-  config :namespace, :validate => :string
-  config :access_key, :validate => :string
-  config :subscription, :validate => :string
-  config :topic, :validate => :string
-  config :deliverycount, :validate => :number, :default => 10
-  config :threads, :validate => :number, :default => 1
-  config :thread_sleep_time, :validate => :number, :default => 1.0/50.0
-  
-  def initialize(*args)
-	super(*args)
-  end # def initialize
-  
-  public
-  def register
-	  # Configure credentials
-	  Azure.configure do |config|
-	    config.sb_namespace = @namespace
-	    config.sb_access_key = @access_key
- 	  end
-  end # def register
-  
-  def process(output_queue, pid)
-    # Get a new instance of a service
-  	azure_service_bus = Azure::ServiceBus::ServiceBusService.new
-	while true
-		begin
-	    # check if we have a message in the subscription
-		message = azure_service_bus.receive_subscription_message(@topic ,@subscription, { :peek_lock => true, :timeout => 1 } )
-		if message
-		    # decoding returns a yield
-			codec.decode(message.body) do |event|
-				output_queue << event
-			end # codec.decode
-			# delete the message after reading it
-			azure_service_bus.delete_subscription_message(message)
-		end
-		rescue LogStash::ShutdownSignal => e
-			raise e
-		rescue => e
-			@logger.error("Oh My, An error occurred. Thread id:" + pid.to_s, :exception => e)
-			if message and message.delivery_count > @deliverycount
-				azure_service_bus.delete_subscription_message(message)
-			end
-		end
-	sleep(@thread_sleep_time)
-	end
-  end # def process
-  
-  public
-  def run(output_queue)
-	threads = []
-    (0..(@threads-1)).each do |pid|
-      threads << Thread.new { process(output_queue, pid) }
-    end
-    threads.each { |thr| thr.join }
-  end # def run
- 
-  public
-  def teardown
-  end # def teardown
-end # class LogStash::Inputs::Azuretopic
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+
+require "thread"
+require "azure"
+
+# Reads events from Azure topics
+class LogStash::Inputs::Azuretopicthreadable < LogStash::Inputs::Base
+  class Interrupted < StandardError; end
+
+  config_name "azuretopicthreadable"
+  milestone 1
+  
+  default :codec, "json" # default json codec
+  
+  config :namespace, :validate => :string
+  config :access_key, :validate => :string
+  config :subscription, :validate => :string
+  config :topic, :validate => :string
+  config :deliverycount, :validate => :number, :default => 10
+  config :threads, :validate => :number, :default => 1
+  config :thread_sleep_time, :validate => :number, :default => 1.0/50.0
+  
+  def initialize(*args)
+  super(*args)
+  end # def initialize
+  
+  public
+  def register
+    # Configure credentials
+    Azure.configure do |config|
+      config.sb_namespace = @namespace
+      config.sb_access_key = @access_key
+    end
+  end # def register
+  
+  def process(output_queue, pid)
+    # Get a new instance of a service
+    azure_service_bus = Azure::ServiceBus::ServiceBusService.new
+    while !stop?
+      begin
+        # check if we have a message in the subscription
+        message = azure_service_bus.receive_subscription_message(@topic ,@subscription, { :peek_lock => true, :timeout => 1 } )
+        if message
+          # decoding returns a yield
+          codec.decode(message.body) do |event|
+          output_queue << event
+        end # codec.decode
+        # delete the message after reading it
+        azure_service_bus.delete_subscription_message(message)
+      end
+      rescue LogStash::ShutdownSignal => e
+        raise e
+      rescue => e
+        @logger.error("Oh My, An error occurred. Thread id:" + pid.to_s, :exception => e)
+        if message and message.delivery_count > @deliverycount
+          azure_service_bus.delete_subscription_message(message)
+        end
+      end
+      sleep(@thread_sleep_time)
+    end
+  end # def process
+  
+  public
+  def run(output_queue)
+    threads = []
+      (0..(@threads-1)).each do |pid|
+        threads << Thread.new { process(output_queue, pid) }
+      end
+    threads.each { |thr| thr.join }
+  end # def run
+ 
+  public
+  def teardown
+  end # def teardown
+end # class LogStash::Inputs::Azuretopic

data/logstash-input-azuretopicthreadable.gemspec

@@ -1,16 +1,16 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-input-azuretopicthreadable'
-  s.version       = '0.9.4'
+  s.version       = '0.9.5'
   s.licenses      = ['Apache License (2.0)']
-  s.summary       = "This plugin will collect Microsoft Azure Diagnostics data from Azure Service Bus."
-  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.summary       = "This plugin reads messages from Azure Service Bus Topics."
+  s.description   = "This gem is a Logstash plugin. It reads messages from Azure Service Bus Topics using multiple threads."
   s.authors       = ["Microsoft Corporation"]
   s.email         = 'azdiag@microsoft.com'
   s.homepage      = "https://github.com/Azure/azure-diagnostics-tools"
   s.require_paths = ["lib"]
 
   # Files
-  s.files = `git ls-files`.split($\)
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','Gemfile','LICENSE']
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
 
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
 
   # Gem dependencies
-  s.add_runtime_dependency 'logstash-core', '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency 'logstash-core', '~> 2.0'
   s.add_runtime_dependency 'azure', '~> 0.7.1'
-  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'logstash-devutils', '>= 0.0.16'
 end

metadata

@@ -1,64 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-azuretopicthreadable
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - Microsoft Corporation
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-09 00:00:00.000000000 Z
+date: 2016-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
+        version: '2.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
-  name: logstash-core
+        version: '2.0'
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: azure
   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
+        version: 0.7.1
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
-  name: azure
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.1
-- !ruby/object:Gem::Dependency
+        version: 0.0.16
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  name: logstash-devutils
+        version: 0.0.16
   prerelease: false
   type: :development
-  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.
+description: This gem is a Logstash plugin. It reads messages from Azure Service Bus Topics using multiple threads.
 email: azdiag@microsoft.com
 executables: []
 extensions: []
@@ -68,7 +62,6 @@ files:
 - Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - lib/logstash/inputs/azuretopicthreadable.rb
 - logstash-input-azuretopicthreadable.gemspec
 - spec/inputs/azuretopicthreadable_spec.rb
@@ -84,12 +77,12 @@ 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: []
@@ -97,6 +90,6 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
-summary: This plugin will collect Microsoft Azure Diagnostics data from Azure Service Bus.
+summary: This plugin reads messages from Azure Service Bus Topics.
 test_files:
 - spec/inputs/azuretopicthreadable_spec.rb

data/Rakefile

@@ -1 +0,0 @@
-require "logstash/devutils/rake"