logstash-mixin-rabbitmq_connection 1.0.0.beta1-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be261e8112ff1e011b6191a7440ae5cb8850220b
+  data.tar.gz: cd9acfffc0d2ead393dc9c952373bba3d663e52b
+SHA512:
+  metadata.gz: ca50bdcf451390ee94103af05253eecb613b96ae5872e0f893e68cb7dce684c8d3fd9e62ba207d6ce5456be18e532a4bbb58e740d143377a976241309f92e1ae
+  data.tar.gz: b552fae802db33fbf7ff6a4b79d22149c27dda4942acb71b4eaeb5111d6ebd2f7eb0d29732b24d1275196bc54b6377e9ccb0acb36526a31f7591de8e44fb147b

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,4 @@
+# About This Mixin
+
+This is a mixin supporting  the logstash rabbitmq inputs and outputs. If you plan on writing a logstash plugin using
+rabbitmq this may be useful.

data/lib/logstash/plugin_mixins/rabbitmq_connection.rb

@@ -0,0 +1,147 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "march_hare"
+require "java"
+
+# Common functionality for the rabbitmq input/output
+module LogStash
+  module PluginMixins
+    module RabbitMQConnection
+      EXCHANGE_TYPES = ["fanout", "direct", "topic"]
+
+      HareInfo = Struct.new(:connection, :channel, :exchange, :queue)
+
+      def self.included(base)
+        base.extend(self)
+        base.setup_rabbitmq_connection_config
+      end
+
+      def setup_rabbitmq_connection_config
+        # RabbitMQ server address
+        config :host, :validate => :string, :required => true
+
+        # RabbitMQ port to connect on
+        config :port, :validate => :number, :default => 5672
+
+        # RabbitMQ username
+        config :user, :validate => :string, :default => "guest"
+
+        # RabbitMQ password
+        config :password, :validate => :password, :default => "guest"
+
+        # The vhost to use. If you don't know what this is, leave the default.
+        config :vhost, :validate => :string, :default => "/"
+
+        # Enable or disable SSL
+        config :ssl, :validate => :boolean, :default => false
+
+        # Validate SSL certificate
+        config :verify_ssl, :validate => :boolean, :default => false
+
+        # Enable or disable logging
+        config :debug, :validate => :boolean, :default => false, :deprecated => "Use the logstash --debug flag for this instead."
+
+        # Set this to automatically recover from a broken connection. You almost certainly don't want to override this!!!
+        config :automatic_recovery, :validate => :boolean, :default => true
+
+        # Time in seconds to wait before retrying a connection
+        config :connect_retry_interval, :validate => :number, :default => 1
+
+        # Passive queue creation? Useful for checking queue existance without modifying server state
+        config :passive, :validate => :boolean, :default => false
+
+        # Extra queue arguments as an array.
+        # To make a RabbitMQ queue mirrored, use: `{"x-ha-policy" => "all"}`
+        config :arguments, :validate => :array, :default => {}
+
+      end
+
+      def conn_str
+        "amqp://#{@user}@#{@host}:#{@port}#{@vhost}"
+      end
+
+      def teardown
+        @hare_info.channel.close if channel_open?
+        @hare_info.connection.close if connection_open?
+
+        finished
+      end
+
+      def rabbitmq_settings
+        return @rabbitmq_settings if @rabbitmq_settings
+
+        s = {
+          :vhost => @vhost,
+          :host  => @host,
+          :port  => @port,
+          :user  => @user,
+          :automatic_recovery => @automatic_recovery,
+          :pass => @password ? @password.value : "guest",
+        }
+        s[:tls] = @ssl if @ssl
+        @rabbitmq_settings = s
+      end
+
+      def connect!
+        @hare_info = connect() unless @hare_info # Don't duplicate the conn!
+      rescue MarchHare::Exception => e
+        return if terminating?
+
+        @logger.error("RabbitMQ connection error, will retry.",
+                      :message => e.message,
+                      :exception => e.class.name,
+                      :backtrace => e.backtrace)
+
+        sleep_for_retry
+        retry
+      end
+
+      def channel_open?
+        @hare_info && @hare_info.channel && @hare_info.channel.open?
+      end
+
+      def connection_open?
+        @hare_info && @hare_info.connection && @hare_info.connection.open?
+      end
+
+      def connected?
+        return nil unless @hare_info && @hare_info.connection
+        @hare_info.connection.connected?
+      end
+
+      private
+
+      def declare_exchange!(channel, exchange, exchange_type, durable)
+        @logger.debug("Declaring an exchange", :name => exchange,
+                      :type => exchange_type, :durable => durable)
+        exchange = channel.exchange(exchange, :type => exchange_type.to_sym, :durable => durable)
+        @logger.debug("Exchange declared")
+        exchange
+      rescue StandardError => e
+        @logger.error("Could not declare exchange!",
+                      :exchange => exchange, :type => exchange_type,
+                      :durable => durable, :error_class => e.class.name,
+                      :error_message => e.message, :backtrace => e.backtrace)
+        raise e
+      end
+
+      def connect
+        @logger.debug? && @logger.debug("Connecting to RabbitMQ. Settings: #{rabbitmq_settings.inspect}")
+
+        connection = MarchHare.connect(rabbitmq_settings)
+        connection.on_blocked { @logger.warn("RabbitMQ output blocked! Check your RabbitMQ instance!") }
+        connection.on_unblocked { @logger.warn("RabbitMQ output unblocked!") }
+
+        channel = connection.create_channel
+        @logger.info("Connected to RabbitMQ at #{rabbitmq_settings[:host]}")
+
+        HareInfo.new(connection, channel)
+      end
+
+      def sleep_for_retry
+        sleep @connect_retry_interval
+      end
+    end
+  end
+end

data/logstash-mixin-rabbitmq_connection.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-mixin-rabbitmq_connection'
+  s.version         = '1.0.0.beta1'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "Common functionality for RabbitMQ plugins"
+  s.description     = "This is used to provide configuration options and connection settings for logstash plugins working with RabbitMQ"
+  s.authors         = ["Elastic"]
+  s.email           = 'info@elastic.co'
+  s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)+::Dir.glob('vendor/*')
+
+  # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
+
+  s.platform = RUBY_PLATFORM
+  s.add_runtime_dependency 'march_hare', ['~> 2.11.0'] #(MIT license)
+
+  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'logstash-input-generator'
+  s.add_development_dependency 'logstash-codec-json'
+end
+

data/spec/plugin_mixins/rabbitmq_connection_spec.rb

@@ -0,0 +1,102 @@
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/pipeline"
+require "logstash/plugin_mixins/rabbitmq_connection"
+
+class TestPlugin < LogStash::Outputs::Base
+  include LogStash::PluginMixins::RabbitMQConnection
+
+  def register
+    connect!
+  end
+end
+
+describe LogStash::PluginMixins::RabbitMQConnection do
+  let(:klass) { TestPlugin }
+  let(:host) { "localhost" }
+  let(:port) { 5672 }
+  let(:rabbitmq_settings) {
+    {
+      "host" => host,
+      "port" => port,
+    }
+  }
+  let(:instance) {
+    klass.new(rabbitmq_settings)
+  }
+  let(:hare_info) { instance.instance_variable_get(:@hare_info) }
+
+  context "when connected" do
+    let(:connection) { double("MarchHare Connection") }
+    let(:channel) { double("Channel") }
+
+    before do
+      allow(instance).to receive(:connect!).and_call_original
+      allow(::MarchHare).to receive(:connect).and_return(connection)
+      allow(connection).to receive(:create_channel).and_return(channel)
+      allow(connection).to receive(:on_blocked)
+      allow(connection).to receive(:on_unblocked)
+
+      instance.register
+    end
+
+    describe "#register" do
+      subject { instance }
+
+      it "should create cleanly" do
+        expect(subject).to be_a(klass)
+      end
+
+      it "should connect" do
+        expect(subject).to have_received(:connect!).once
+      end
+    end
+
+    describe "#connect!" do
+      subject { hare_info }
+
+      it "should set @hare_info correctly" do
+        expect(subject).to be_a(LogStash::PluginMixins::RabbitMQConnection::HareInfo)
+      end
+
+      it "should set @connection correctly" do
+        expect(subject.connection).to eql(connection)
+      end
+
+      it "should set the channel correctly" do
+        expect(subject.channel).to eql(channel)
+      end
+    end
+  end
+
+  # If the connection encounters an exception during its initial
+  # connection attempt we must handle that. Subsequent errors should be
+  # handled by the automatic retry mechanism built-in to MarchHare
+  describe "initial connection exceptions" do
+    subject { instance }
+
+    before do
+      allow(subject).to receive(:sleep_for_retry)
+
+
+      i = 0
+      allow(subject).to receive(:connect) do
+        i += 1
+        if i == 1
+          raise(MarchHare::ConnectionRefused, "Error!")
+        else
+          double("connection")
+        end
+      end
+
+      subject.send(:connect!)
+    end
+
+    it "should retry its connection when conn fails" do
+      expect(subject).to have_received(:connect).twice
+    end
+
+    it "should sleep between retries" do
+      expect(subject).to have_received(:sleep_for_retry).once
+    end
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: logstash-mixin-rabbitmq_connection
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta1
+platform: java
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  name: march_hare
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-input-generator
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-json
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is used to provide configuration options and connection settings for logstash plugins working with RabbitMQ
+email: info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- lib/logstash/plugin_mixins/rabbitmq_connection.rb
+- logstash-mixin-rabbitmq_connection.gemspec
+- spec/plugin_mixins/rabbitmq_connection_spec.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+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.4.8
+signing_key:
+specification_version: 4
+summary: Common functionality for RabbitMQ plugins
+test_files:
+- spec/plugin_mixins/rabbitmq_connection_spec.rb
+has_rdoc: