logstash-input-azure_event_hubs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 902edadba15d69ce6f3dddccb45d032da18822480c3877eb6c2aa0774838c02e
+  data.tar.gz: 9c80e3da69f7f8872edd278bedb3102f212ab3a4cbb6d643674e6543eda09ce0
+SHA512:
+  metadata.gz: f49d124219f4618b051afe5d6ff705a6bad7b611474c20640d033014937a0ac95b7b97ef744f3e57d6e4d924006c0575b8d9b428efb9e5128b3ceb0c5838e70b
+  data.tar.gz: d0a8bd34fbbb9fb7f4c45216fdeeb22ce6978d72ed1b3bfdeb77ad1fe07f5188846ac1e50b60ac33296d908bb39ce18ceb86bec8b7b6c4e645764d71ada0e85f

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 1.0.0 
+  - Initial release of `logstash-input-azure_event_hubs` supersedes `logstash-input-azureeventhub`
+  - Re-implementation that uses Event Processor Host API and new configuration options.
+

data/CONTRIBUTORS

@@ -0,0 +1,11 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+# jakelandis
+* brahmnes
+
+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,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+logstash_path = "../../logstash"
+
+if Dir.exist?(logstash_path) && ENV["LOGSTASH_SOURCE"] == "1"
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end
+
+if RUBY_VERSION == "1.9.3"
+  gem 'rake', '12.2.1'
+end

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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,88 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/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.elastic.co/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/elastic/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 Development 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
+./gradlew vendor
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+gem install rspec
+bundle exec rspec --pattern spec/**/*_spec.rb
+```
+
+### 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/logstash-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/logstash-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/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/logstash-input-azure_event_hubs.rb

@@ -0,0 +1,10 @@
+# AUTOGENERATED BY THE GRADLE SCRIPT. DO NOT EDIT.
+
+require 'jar_dependencies'
+require_jar('com.google.code.gson', 'gson', '2.8.3')
+require_jar('org.apache.qpid', 'proton-j', '0.27.1')
+require_jar('org.apache.logging.log4j', 'log4j-slf4j-impl', '2.9.1')
+require_jar('com.microsoft.azure', 'azure-eventhubs', '1.0.1')
+require_jar('com.microsoft.azure', 'azure-eventhubs-eph', '1.0.0')
+require_jar('com.microsoft.azure', 'azure-storage', '7.0.0')
+require_jar('org.apache.logging.log4j', 'log4j-api', '2.9.1')

data/lib/logstash/inputs/azure_event_hubs.rb

@@ -0,0 +1,479 @@
+# encoding: utf-8
+require "logstash-input-azure_event_hubs"
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "stud/interval"
+require "logstash/inputs/processor_factory"
+require "logstash/inputs/error_notification_handler"
+require "logstash/inputs/named_thread_factory"
+require "logstash/inputs/look_back_position_provider"
+
+
+java_import com.microsoft.azure.eventprocessorhost.EventProcessorHost
+java_import com.microsoft.azure.eventprocessorhost.EventProcessorOptions
+java_import com.microsoft.azure.eventprocessorhost.InMemoryCheckpointManager
+java_import com.microsoft.azure.eventprocessorhost.InMemoryLeaseManager
+java_import com.microsoft.azure.eventprocessorhost.HostContext
+java_import com.microsoft.azure.eventhubs.ConnectionStringBuilder
+java_import java.util.concurrent.Executors
+java_import java.util.concurrent.TimeUnit
+
+
+class LogStash::Inputs::AzureEventHubs < LogStash::Inputs::Base
+  config_name "azure_event_hubs"
+
+  # This plugin supports two styles of configuration
+  # basic - You supply a list of Event Hub connection strings complete with the 'EntityPath' that defines the Event Hub name. All other configuration is shared.
+  # advanced - You supply a list of Event Hub names, and under each name provide that Event Hub's configuration. Most all of the configuration options are identical as the basic model, except they are configured per Event Hub.
+  # Defaults to basic
+  # Example:
+  # azure_event_hubs {
+  #    config_mode => "basic"
+  #    event_hub_connections => ["Endpoint=sb://example1...;EntityPath=event_hub_name1"  , "Endpoint=sb://example2...;EntityPath=event_hub_name2"  ]
+  # }
+  config :config_mode, :validate => ['basic', 'advanced'], :default => 'basic'
+
+  # advanced MODE ONLY - The event hubs to read from. This is a array of hashes, where the each entry of the array is a hash of the event_hub_name => {configuration}.
+  # Note - most basic configuration options are supported under the Event Hub names, and examples proved where applicable
+  # Note - while in advanced mode, if any basic options are defined at the top level they will be used if not already defined under the Event Hub name.  e.g. you may define shared configuration at the top level
+  # Note - the required event_hub_connection is named 'event_hub_connection' (singular) which differs from the basic configuration option 'event_hub_connections' (plural)
+  # Note - the 'event_hub_connection' may contain the 'EntityPath', but only if it matches the Event Hub name.
+  # Note - the same Event Hub name is allowed under different configurations (and is why the config is array of Hashes)
+  # Example:
+  # azure_event_hubs {
+  #   config_mode => "advanced"
+  #   event_hubs => [
+  #       { "event_hub_name1" => {
+  #           event_hub_connection => "Endpoint=sb://example1..."
+  #       }},
+  #       { "event_hub_name2" => {
+  #           event_hub_connection => "Endpoint=sb://example2..."
+  #           storage_connection => "DefaultEndpointsProtocol=https;AccountName=example...."
+  #           storage_container => "my_container"
+  #      }}
+  #    ]
+  #    consumer_group => "logstash" # shared across all Event Hubs
+  # }
+  config :event_hubs, :validate => :array, :required => true # only required for advanced mode
+
+  # basic MODE ONLY - The Event Hubs to read from. This is a list of Event Hub connection strings that includes the 'EntityPath'.
+  # All other configuration options will be shared between Event Hubs.
+  # Example:
+  # azure_event_hubs {
+  #    config_mode => "basic"
+  #    event_hub_connections => ["Endpoint=sb://example1...;EntityPath=event_hub_name1"  , "Endpoint=sb://example2...;EntityPath=event_hub_name2"  ]
+  # }
+  config :event_hub_connections, :validate => :array, :required => true # only required for basic mode
+
+  # Used to persists the offsets between restarts and ensure that multiple instances of Logstash process different partitions
+  # This is *stongly* encouraged to be set for production environments.
+  # When this value is set, restarts will pick up from where it left off. Without this value set the initial_position is *always* used.
+  # basic Example:
+  # azure_event_hubs {
+  #    config_mode => "basic"
+  #    event_hub_connections => ["Endpoint=sb://example1...;EntityPath=event_hub_name1"]
+  #    storage_connection => "DefaultEndpointsProtocol=https;AccountName=example...."
+  # }
+  # advanced example:
+  # azure_event_hubs {
+  #   config_mode => "advanced"
+  #   event_hubs => [
+  #       { "event_hub_name1" => {
+  #           event_hub_connection => "Endpoint=sb://example1..."
+  #           storage_connection => "DefaultEndpointsProtocol=https;AccountName=example...."
+  #       }}
+  #    ]
+  # }
+  config :storage_connection, :validate => :password, :required => false
+
+  # The storage container to persist the offsets.
+  # Note - don't allow multiple Event Hubs to write to the same container with the same consumer group, else the offsets will be persisted incorrectly.
+  # Note - this will default to the event hub name if not defined
+  # basic Example:
+  # azure_event_hubs {
+  #    config_mode => "basic"
+  #    event_hub_connections => ["Endpoint=sb://example1...;EntityPath=event_hub_name1"]
+  #    storage_connection => "DefaultEndpointsProtocol=https;AccountName=example...."
+  #    storage_container => "my_container"
+  # }
+  # advanced example:
+  # azure_event_hubs {
+  #   config_mode => "advanced"
+  #   event_hubs => [
+  #       { "event_hub_name1" => {
+  #           event_hub_connection => "Endpoint=sb://example1..."
+  #           storage_connection => "DefaultEndpointsProtocol=https;AccountName=example...."
+  #           storage_container => "my_container"
+  #       }}
+  #    ]
+  # }
+  config :storage_container, :validate => :string, :required => false
+
+  # Total threads used process events. Requires at minimum 2 threads. This option can not be set per Event Hub.
+  # azure_event_hubs {
+  #    threads => 4
+  # }
+  config :threads, :validate => :number, :default => 4
+
+  # Consumer group used to read the Event Hub(s). It is recommended to change from the $Default to a consumer group specifically for Logstash, and ensure that all instances of Logstash use that consumer group.
+  # basic Example:
+  # azure_event_hubs {
+  #    config_mode => "basic"
+  #    event_hub_connections => ["Endpoint=sb://example1...;EntityPath=event_hub_name1"]
+  #    consumer_group => "logstash"
+  # }
+  # advanced example:
+  # azure_event_hubs {
+  #   config_mode => "advanced"
+  #   event_hubs => [
+  #       { "event_hub_name1" => {
+  #           event_hub_connection => "Endpoint=sb://example1..."
+  #           consumer_group => "logstash"
+  #       }}
+  #    ]
+  # }
+  config :consumer_group, :validate => :string, :default => '$Default'
+
+  # The max size of events are processed together. A checkpoint is created after each batch. Increasing this value may help with performance, but requires more memory.
+  # Defaults to 50
+  # basic Example:
+  # azure_event_hubs {
+  #    config_mode => "basic"
+  #    event_hub_connections => ["Endpoint=sb://example1...;EntityPath=event_hub_name1"]
+  #    max_batch_size => 125
+  # }
+  # advanced example:
+  # azure_event_hubs {
+  #   config_mode => "advanced"
+  #   event_hubs => [
+  #       { "event_hub_name1" => {
+  #           event_hub_connection => "Endpoint=sb://example1..."
+  #           max_batch_size => 125
+  #       }}
+  #    ]
+  # }
+  config :max_batch_size, :validate => :number, :default => 125
+
+  # The max size of events that are retrieved prior to processing. Increasing this value may help with performance, but requires more memory.
+  # Defaults to 300
+  # basic Example:
+  # azure_event_hubs {
+  #    config_mode => "basic"
+  #    event_hub_connections => ["Endpoint=sb://example1...;EntityPath=event_hub_name1"]
+  #    prefetch_count => 300
+  # }
+  # advanced example:
+  # azure_event_hubs {
+  #   config_mode => "advanced"
+  #   event_hubs => [
+  #       { "event_hub_name1" => {
+  #           event_hub_connection => "Endpoint=sb://example1..."
+  #           prefetch_count => 300
+  #       }}
+  #    ]
+  # }
+  # NOTE - This option is intentionally not part of the public documentation. This is a very low level configuration that shouldn't need to be changed by anyone other then an Event Hub expert.
+  config :prefetch_count, :validate => :number, :default => 300
+
+  # The max time allowed receive events without a timeout.
+  # Value is expressed in seconds, default 60
+  # basic Example:
+  # azure_event_hubs {
+  #    config_mode => "basic"
+  #    event_hub_connections => ["Endpoint=sb://example1...;EntityPath=event_hub_name1"]
+  #    receive_timeout => 60
+  # }
+  # advanced example:
+  # azure_event_hubs {
+  #   config_mode => "advanced"
+  #   event_hubs => [
+  #       { "event_hub_name1" => {
+  #           event_hub_connection => "Endpoint=sb://example1..."
+  #           receive_timeout => 300
+  #       }}
+  #    ]
+  # }
+  # NOTE - This option is intentionally not part of the public documentation. This is a very low level configuration that shouldn't need to be changed by anyone other then an Event Hub expert.
+  config :receive_timeout, :validate => :number, :default => 60
+
+  # When first reading from an event hub, start from this position.
+  # beginning - reads ALL pre-existing events in the event hub
+  # end - reads NO pre-existing events in the event hub
+  # look_back - reads end minus N seconds worth of pre-existing events
+  # Note - If the storage_connection is set, this configuration is only applicable for the very first time Logstash reads from the event hub.
+  # basic Example:
+  # azure_event_hubs {
+  #    config_mode => "basic"
+  #    event_hub_connections => ["Endpoint=sb://example1...;EntityPath=event_hub_name1"]
+  #    initial_position => "beginning"
+  # }
+  # advanced example:
+  # azure_event_hubs {
+  #   config_mode => "advanced"
+  #   event_hubs => [
+  #       { "event_hub_name1" => {
+  #           event_hub_connection => "Endpoint=sb://example1..."
+  #           initial_position => "beginning"
+  #       }}
+  #    ]
+  # }
+  config :initial_position, :validate => ['beginning', 'end', 'look_back'], :default => 'beginning'
+
+  # The number of seconds to look back for pre-existing events to determine the initial position.
+  # Note - If the storage_connection is set, this configuration is only applicable for the very first time Logstash reads from the event hub.
+  # Note - this options is only used when initial_position => "look_back"
+  # Value is expressed in seconds, default is 1 day
+  # basic Example:
+  # azure_event_hubs {
+  #    config_mode => "basic"
+  #    event_hub_connections => ["Endpoint=sb://example1...;EntityPath=event_hub_name1"]
+  #    initial_position => "look_back"
+  #    initial_position_look_back => 86400
+  # }
+  # advanced example:
+  # azure_event_hubs {
+  #   config_mode => "advanced"
+  #   event_hubs => [
+  #       { "event_hub_name1" => {
+  #           event_hub_connection => "Endpoint=sb://example1..."
+  #           initial_position => "look_back"
+  #           initial_position_look_back => 86400
+  #       }}
+  #    ]
+  # }
+  config :initial_position_look_back, :validate => :number, :default => 86400
+
+  # The interval in seconds between writing checkpoint while processing a batch. Default 5 seconds. Checkpoints can slow down processing, but are needed to know where to start after a restart.
+  # Note - checkpoints happen after every batch, so this configuration is only applicable while processing a single batch.
+  # Value is expressed in seconds, set to zero to disable
+  # basic Example:
+  # azure_event_hubs {
+  #    config_mode => "basic"
+  #    event_hub_connections => ["Endpoint=sb://example1...;EntityPath=event_hub_name1"]
+  #    checkpoint_interval => 5
+  # }
+  # advanced example:
+  # azure_event_hubs {
+  #   config_mode => "advanced"
+  #   event_hubs => [
+  #       { "event_hub_name1" => {
+  #           event_hub_connection => "Endpoint=sb://example1..."
+  #           checkpoint_interval => 5
+  #       }}
+  #    ]
+  # }
+  config :checkpoint_interval, :validate => :number, :default => 5
+
+  # Adds meta data to the event.
+  # [@metadata][azure_event_hubs][name] - the name of hte event host
+  # [@metadata][azure_event_hubs][consumer_group] - the consumer group that consumed this event
+  # [@metadata][azure_event_hubs][processor_host] - the unique identifier that identifies which host processed this event. Note - there can be multiple processor hosts on a single instance of Logstash.
+  # [@metadata][azure_event_hubs][partition] - the partition from which event came from
+  # [@metadata][azure_event_hubs][offset] - the event hub offset for this event
+  # [@metadata][azure_event_hubs][sequence] - the event hub sequence for this event
+  # [@metadata][azure_event_hubs][timestamp] - the enqueued time of the event
+  # [@metadata][azure_event_hubs][event_size] - the size of the event
+  # basic Example:
+  # azure_event_hubs {
+  #    config_mode => "basic"
+  #    event_hub_connections => ["Endpoint=sb://example1...;EntityPath=event_hub_name1"]
+  #    decorate_events => true
+  # }
+  # advanced example:
+  # azure_event_hubs {
+  #   config_mode => "advanced"
+  #   event_hubs => [
+  #       { "event_hub_name1" => {
+  #           event_hub_connection => "Endpoint=sb://example1..."
+  #           decorate_events => true
+  #       }}
+  #    ]
+  # }
+  config :decorate_events, :validate => :boolean, :default => false
+
+  attr_reader :count, :pre_count
+
+  def initialize(params)
+
+    # explode the all of the parameters to be scoped per event_hub
+    @event_hubs_exploded = []
+    # global_config will be merged into the each of the exploded configs, prefer any configuration already scoped over the globally scoped config
+    global_config = {}
+    params.each do |k, v|
+      if !k.eql?('id') && !k.eql?('event_hubs') && !k.eql?('threads') && !k.eql?('event_hub_connections')  # don't copy these to the per-event-hub configs
+        global_config[k] = v
+      end
+    end
+
+    if params['config_mode'] && params['config_mode'].eql?('advanced')
+      params['event_hub_connections'] = ['dummy'] # trick the :required validation
+
+      params['event_hubs'].each do |event_hub|
+        raise "event_hubs must be a Hash" unless event_hub.is_a?(Hash)
+        event_hub.each do |event_hub_name, config|
+          config.each do |k, v|
+            if 'event_hub_connection'.eql?(k) || 'storage_connection'.eql?(k) # protect from leaking logs
+              config[k] = ::LogStash::Util::Password.new(v)
+            end
+          end
+          if config['event_hub_connection'] #add the 's' to pass validation
+            config['event_hub_connections'] = config['event_hub_connection']
+            config.delete('event_hub_connection')
+          end
+
+          config.merge!({'event_hubs' => [event_hub_name]})
+          config.merge!(global_config) {|k, v1, v2| v1}
+          @event_hubs_exploded << config
+        end
+      end
+    else # basic config
+      params['event_hubs'] = ['dummy'] # trick the :required validation
+      if params['event_hub_connections']
+        connections = *params['event_hub_connections'] # ensure array
+        connections.each.with_index do |_connection, i|
+          begin
+            connection = self.class.replace_placeholders(_connection) if self.class.respond_to? 'replace_placeholders' # 6.x
+            connection = self.class.replace_env_placeholders(_connection) if self.class.respond_to? 'replace_env_placeholders' # 5.x
+            event_hub_name = ConnectionStringBuilder.new(connection).getEventHubName
+            redacted_connection = connection.gsub(/(SharedAccessKey=)([0-9a-zA-Z=+]*)([;]*)(.*)/, '\\1<redacted>\\3\\4')
+            params['event_hub_connections'][i] = redacted_connection # protect from leaking logs
+            raise "invalid Event Hub name" unless event_hub_name
+          rescue
+            raise LogStash::ConfigurationError, "Error parsing event hub string name for connection: '#{redacted_connection}' please ensure that the connection string contains the EntityPath"
+          end
+          @event_hubs_exploded << {'event_hubs' => [event_hub_name]}.merge({'event_hub_connections' => [::LogStash::Util::Password.new(connection)]}).merge(global_config) {|k, v1, v2| v1}
+        end
+      end
+    end
+
+    super(params)
+
+    container_consumer_groups = []
+    # explicitly validate all the per event hub configs
+    @event_hubs_exploded.each do |event_hub|
+      if !self.class.validate(event_hub)
+        raise LogStash::ConfigurationError, I18n.t("logstash.runner.configuration.invalid_plugin_settings")
+      end
+      container_consumer_groups << {event_hub['storage_connection'].value.to_s + (event_hub['storage_container'] ? event_hub['storage_container'] : event_hub['event_hubs'][0]) => event_hub['consumer_group']} if event_hub['storage_connection']
+    end
+    raise "The configuration will result in overwriting offsets. Please ensure that the each Event Hub's consumer_group is using a unique storage container." if container_consumer_groups.size > container_consumer_groups.uniq.size
+  end
+
+  attr_reader :event_hubs_exploded
+
+  def register
+    # augment the exploded config with the defaults
+    @event_hubs_exploded.each do |event_hub|
+      @config.each do |key, value|
+        if !key.eql?('id') && !key.eql?('event_hubs')
+          event_hub[key] = value unless event_hub[key]
+        end
+      end
+    end
+    @logger.debug("Exploded Event Hub configuration.",  :event_hubs_exploded => @event_hubs_exploded.to_s)
+  end
+
+  def run(queue)
+    event_hub_threads = []
+    named_thread_factory = LogStash::Inputs::Azure::NamedThreadFactory.new("azure_event_hubs-worker", @id)
+    scheduled_executor_service = Executors.newScheduledThreadPool(@threads, named_thread_factory)
+    @event_hubs_exploded.each do |event_hub|
+      event_hub_threads << Thread.new do
+        event_hub_name = event_hub['event_hubs'].first # there will always only be 1 from @event_hubs_exploded
+        @logger.info("Event Hub #{event_hub_name} is initializing... ")
+        begin
+          if event_hub['storage_connection']
+            event_processor_host = EventProcessorHost.new(
+                EventProcessorHost.createHostName('logstash'),
+                event_hub_name,
+                event_hub['consumer_group'],
+                event_hub['event_hub_connections'].first.value, #there will only be one in this array by the time it gets here
+                event_hub['storage_connection'].value,
+                event_hub.fetch('storage_container', event_hub_name),
+                scheduled_executor_service)
+          else
+            @logger.warn("You have NOT specified a `storage_connection_string` for #{event_hub_name}. This configuration is only supported for a single Logstash instance.")
+            checkpoint_manager = InMemoryCheckpointManager.new
+            lease_manager = InMemoryLeaseManager.new
+            event_processor_host = EventProcessorHost.new(
+                EventProcessorHost.createHostName('logstash'),
+                event_hub_name,
+                event_hub['consumer_group'],
+                event_hub['event_hub_connections'].first.value, #there will only be one in this array by the time it gets here
+                checkpoint_manager,
+                lease_manager,
+                scheduled_executor_service,
+                nil)
+            #using java_send to avoid naming conflicts with 'initialize' method
+            lease_manager.java_send :initialize, [HostContext], event_processor_host.getHostContext
+            checkpoint_manager.java_send :initialize, [HostContext], event_processor_host.getHostContext
+          end
+          options = EventProcessorOptions.new
+          options.setExceptionNotification(LogStash::Inputs::Azure::ErrorNotificationHandler.new)
+          case @initial_position
+          when 'beginning'
+            msg = "Configuring Event Hub #{event_hub_name} to read events all events."
+            @logger.debug("If this is the initial read... " + msg) if event_hub['storage_connection']
+            @logger.info(msg) unless event_hub['storage_connection']
+            options.setInitialPositionProvider(EventProcessorOptions::StartOfStreamInitialPositionProvider.new(options))
+          when 'end'
+            msg = "Configuring Event Hub #{event_hub_name} to read only new events."
+            @logger.debug("If this is the initial read... " + msg) if event_hub['storage_connection']
+            @logger.info(msg) unless event_hub['storage_connection']
+            options.setInitialPositionProvider(EventProcessorOptions::EndOfStreamInitialPositionProvider.new(options))
+          when 'look_back'
+            msg = "Configuring Event Hub #{event_hub_name} to read events starting at 'now - #{@initial_position_look_back}' seconds."
+            @logger.debug("If this is the initial read... " + msg) if event_hub['storage_connection']
+            @logger.info(msg) unless event_hub['storage_connection']
+            options.setInitialPositionProvider(LogStash::Inputs::Azure::LookBackPositionProvider.new(@initial_position_look_back))
+          end
+          event_processor_host.registerEventProcessorFactory(LogStash::Inputs::Azure::ProcessorFactory.new(queue, event_hub['codec'], event_hub['checkpoint_interval'], self.method(:decorate), event_hub['decorate_events']), options)
+              .whenComplete {|x, e|
+                @logger.info("Event Hub registration complete. ", :event_hub_name => event_processor_host.getHostContext.getEventHubPath.to_s )
+                @logger.error("Event Hub failure while registering.", :event_hub_name => event_processor_host.getHostContext.getEventHubPath.to_s, :exception => e, :backtrace => e.backtrace) if e
+              }
+              .then_accept {|x|
+                @logger.info("Event Hub is processing events... ", :event_hub_name => event_processor_host.getHostContext.getEventHubPath.to_s )
+                # this blocks the completable future chain from progressing, actual work is done via the executor service
+                while !stop?
+                  Stud.stoppable_sleep(1) {stop?}
+                end
+              }
+              .thenCompose {|x|
+                @logger.info("Unregistering Event Hub this can take a while... ", :event_hub_name => event_processor_host.getHostContext.getEventHubPath.to_s )
+                event_processor_host.unregisterEventProcessor
+              }
+              .exceptionally {|e|
+                @logger.error("Event Hub encountered an error.", :event_hub_name => event_processor_host.getHostContext.getEventHubPath.to_s , :exception => e, :backtrace => e.backtrace) if e
+                nil
+              }
+              .get # this blocks till all of the futures are complete.
+          @logger.info("Event Hub #{event_processor_host.getHostContext.getEventHubPath.to_s} is closed.")
+        rescue => e
+          @logger.error("Event Hub failed during initialization.", :event_hub_name => event_hub_name, :exception => e, :backtrace => e.backtrace) if e
+          do_stop
+        end
+      end
+    end
+
+    # this blocks the input from existing. (all work is being done in threads)
+    while !stop?
+      Stud.stoppable_sleep(1) {stop?}
+    end
+
+    # This blocks the input till all the threads have run to completion.
+    event_hub_threads.each do |thread|
+      thread.join
+    end
+
+    # Ensure proper shutdown of executor service. # Note - this causes a harmless warning in the logs that scheduled tasks are being rejected.
+    scheduled_executor_service.shutdown
+    begin
+      scheduled_executor_service.awaitTermination(10, TimeUnit::MINUTES);
+    rescue => e
+      @logger.debug("interrupted while waiting to close executor service, this can generally be ignored", :exception => e, :backtrace => e.backtrace) if e
+    end
+  end
+end
+
+