logstash-integration-rabbitmq 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 52cf5ceb8cb2600a30486903f8cf0786e5939ed34c4e57a0ce4c66e751f0e859
+  data.tar.gz: 9f45d58f3a060cae5c05532e6d151e16195cdcff60590956f277e01435b6fc1d
+SHA512:
+  metadata.gz: f419b19e4e8fb6991496c169562968d07679db54152734c621941c749a2efd58e3b513caf2a88f3408bdd96369e9d03e634fe064797699c589646a4fcb8c855c
+  data.tar.gz: 6299ae1d3197d557fa4880c146d89b03ac7c1fb18e932bc6bb80479314ba4fb3565112e669a4f8a4f99ba6cebd4b2f22a973bc94edf41ea10ffc823631206188

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 1.0.0
+  - Initial import of rabbitmq input, output and mixin

data/CONTRIBUTORS

@@ -0,0 +1,26 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Avishai Ish-Shalom (avishai-ish-shalom)
+* Colin Surprenant (colinsurprenant)
+* Jonathan Van Eenwyk (jdve)
+* Jordan Sissel (jordansissel)
+* João Duarte (jsvd)
+* Kurt Hurtado (kurtado)
+* Marc Fournier (mfournier)
+* Mathieu MILLET (htam-net)
+* Michael Klishin (michaelklishin)
+* Michael Zaccari (mzaccari)
+* Nick Ethier (nickethier)
+* Pier-Hugues Pellerin (ph)
+* Richard Pijnenburg (electrical)
+* Suyog Rao (suyograo)
+* Tim Potter (tpot)
+* avleen
+* ssc-
+
+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,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012-2018 Elasticsearch <http://www.elastic.co>
+
+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/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,98 @@
+# Logstash Plugin
+
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-input-rabbitmq.svg)](https://travis-ci.org/logstash-plugins/logstash-input-rabbitmq)
+
+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 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
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+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
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
+```
+- 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/docs/index-input.asciidoc

@@ -0,0 +1,395 @@
+:plugin: rabbitmq
+:type: input
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}s-{plugin}"]
+
+=== Rabbitmq input plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+Pull events from a http://www.rabbitmq.com/[RabbitMQ] queue.
+
+The default settings will create an entirely transient queue and listen for all messages by default.
+If you need durability or any other advanced settings, please set the appropriate options
+
+This plugin uses the http://rubymarchhare.info/[March Hare] library
+for interacting with the RabbitMQ server. Most configuration options
+map directly to standard RabbitMQ and AMQP concepts. The
+https://www.rabbitmq.com/amqp-0-9-1-reference.html[AMQP 0-9-1 reference guide]
+and other parts of the RabbitMQ documentation are useful for deeper
+understanding.
+
+The properties of messages received will be stored in the
+`[@metadata][rabbitmq_properties]` field if the `@metadata_enabled` setting is checked.
+Note that storing metadata may degrade performance.
+The following properties may be available (in most cases dependent on whether
+they were set by the sender):
+
+* app-id
+* cluster-id
+* consumer-tag
+* content-encoding
+* content-type
+* correlation-id
+* delivery-mode
+* exchange
+* expiration
+* message-id
+* priority
+* redeliver
+* reply-to
+* routing-key
+* timestamp
+* type
+* user-id
+
+For example, to get the RabbitMQ message's timestamp property
+into the Logstash event's `@timestamp` field, use the date
+filter to parse the `[@metadata][rabbitmq_properties][timestamp]`
+field:
+[source,ruby]
+    filter {
+      if [@metadata][rabbitmq_properties][timestamp] {
+        date {
+          match => ["[@metadata][rabbitmq_properties][timestamp]", "UNIX"]
+        }
+      }
+    }
+
+Additionally, any message headers will be saved in the
+`[@metadata][rabbitmq_headers]` field.
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Rabbitmq Input Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-ack>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-arguments>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-auto_delete>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-automatic_recovery>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-connect_retry_interval>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-connection_timeout>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-durable>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-exchange>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-exchange_type>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-exclusive>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-heartbeat>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-key>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-metadata_enabled>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-passive>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-password>> |<<password,password>>|No
+| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-prefetch_count>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-queue>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-ssl>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-ssl_certificate_password>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-ssl_certificate_path>> |a valid filesystem path|No
+| <<plugins-{type}s-{plugin}-ssl_version>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-subscription_retry_interval_seconds>> |<<number,number>>|Yes
+| <<plugins-{type}s-{plugin}-threads>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-user>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-vhost>> |<<string,string>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+input plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-ack"]
+===== `ack` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Enable message acknowledgements. With acknowledgements
+messages fetched by Logstash but not yet sent into the
+Logstash pipeline will be requeued by the server if Logstash
+shuts down. Acknowledgements will however hurt the message
+throughput.
+
+This will only send an ack back every `prefetch_count` messages.
+Working in batches provides a performance boost here.
+
+[id="plugins-{type}s-{plugin}-arguments"]
+===== `arguments` 
+
+  * Value type is <<array,array>>
+  * Default value is `{}`
+
+Extra queue arguments as an array.
+To make a RabbitMQ queue mirrored, use: `{"x-ha-policy" => "all"}`
+
+[id="plugins-{type}s-{plugin}-auto_delete"]
+===== `auto_delete` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Should the queue be deleted on the broker when the last consumer
+disconnects? Set this option to `false` if you want the queue to remain
+on the broker, queueing up messages until a consumer comes along to
+consume them.
+
+[id="plugins-{type}s-{plugin}-automatic_recovery"]
+===== `automatic_recovery` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Set this to automatically recover from a broken connection. You almost certainly don't want to override this!!!
+
+[id="plugins-{type}s-{plugin}-connect_retry_interval"]
+===== `connect_retry_interval` 
+
+  * Value type is <<number,number>>
+  * Default value is `1`
+
+Time in seconds to wait before retrying a connection
+
+[id="plugins-{type}s-{plugin}-connection_timeout"]
+===== `connection_timeout` 
+
+  * Value type is <<number,number>>
+  * There is no default value for this setting.
+
+The default connection timeout in milliseconds. If not specified the timeout is infinite.
+
+[id="plugins-{type}s-{plugin}-durable"]
+===== `durable` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Is this queue durable? (aka; Should it survive a broker restart?)
+
+[id="plugins-{type}s-{plugin}-exchange"]
+===== `exchange` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The name of the exchange to bind the queue to. Specify `exchange_type`
+as well to declare the exchange if it does not exist
+
+[id="plugins-{type}s-{plugin}-exchange_type"]
+===== `exchange_type` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The type of the exchange to bind to. Specifying this will cause this plugin
+to declare the exchange if it does not exist.
+
+[id="plugins-{type}s-{plugin}-exclusive"]
+===== `exclusive` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Is the queue exclusive? Exclusive queues can only be used by the connection
+that declared them and will be deleted when it is closed (e.g. due to a Logstash
+restart).
+
+[id="plugins-{type}s-{plugin}-heartbeat"]
+===== `heartbeat` 
+
+  * Value type is <<number,number>>
+  * There is no default value for this setting.
+
+Heartbeat delay in seconds. If unspecified no heartbeats will be sent
+
+[id="plugins-{type}s-{plugin}-host"]
+===== `host` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Common functionality for the rabbitmq input/output
+RabbitMQ server address(es)
+host can either be a single host, or a list of hosts
+i.e.
+  host => "localhost"
+or
+  host => ["host01", "host02]
+
+if multiple hosts are provided on the initial connection and any subsequent
+recovery attempts of the hosts is chosen at random and connected to.
+Note that only one host connection is active at a time.
+
+[id="plugins-{type}s-{plugin}-key"]
+===== `key` 
+
+  * Value type is <<string,string>>
+  * Default value is `"logstash"`
+
+The routing key to use when binding a queue to the exchange.
+This is only relevant for direct or topic exchanges.
+
+* Routing keys are ignored on fanout exchanges.
+* Wildcards are not valid on direct exchanges.
+
+[id="plugins-{type}s-{plugin}-metadata_enabled"]
+===== `metadata_enabled` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Enable the storage of message headers and properties in `@metadata`. This may impact performance
+
+[id="plugins-{type}s-{plugin}-passive"]
+===== `passive` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+If true the queue will be passively declared, meaning it must
+already exist on the server. To have Logstash create the queue
+if necessary leave this option as false. If actively declaring
+a queue that already exists, the queue options for this plugin
+(durable etc) must match those of the existing queue.
+
+[id="plugins-{type}s-{plugin}-password"]
+===== `password` 
+
+  * Value type is <<password,password>>
+  * Default value is `"guest"`
+
+RabbitMQ password
+
+[id="plugins-{type}s-{plugin}-port"]
+===== `port` 
+
+  * Value type is <<number,number>>
+  * Default value is `5672`
+
+RabbitMQ port to connect on
+
+[id="plugins-{type}s-{plugin}-prefetch_count"]
+===== `prefetch_count` 
+
+  * Value type is <<number,number>>
+  * Default value is `256`
+
+Prefetch count. If acknowledgements are enabled with the `ack`
+option, specifies the number of outstanding unacknowledged
+messages allowed.
+
+[id="plugins-{type}s-{plugin}-queue"]
+===== `queue` 
+
+  * Value type is <<string,string>>
+  * Default value is `""`
+
+The properties to extract from each message and store in a
+@metadata field.
+
+Technically the exchange, redeliver, and routing-key
+properties belong to the envelope and not the message but we
+ignore that distinction here. However, we extract the
+headers separately via get_headers even though the header
+table technically is a message property.
+
+Freezing all strings so that code modifying the event's
+@metadata field can't touch them.
+
+If updating this list, remember to update the documentation
+above too.
+The default codec for this plugin is JSON. You can override this to suit your particular needs however.
+The name of the queue Logstash will consume events from. If
+left empty, a transient queue with an randomly chosen name
+will be created.
+
+[id="plugins-{type}s-{plugin}-ssl"]
+===== `ssl` 
+
+  * Value type is <<boolean,boolean>>
+  * There is no default value for this setting.
+
+Enable or disable SSL.
+Note that by default remote certificate verification is off.
+Specify ssl_certificate_path and ssl_certificate_password if you need
+certificate verification
+
+[id="plugins-{type}s-{plugin}-ssl_certificate_password"]
+===== `ssl_certificate_password` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Password for the encrypted PKCS12 (.p12) certificate file specified in ssl_certificate_path
+
+[id="plugins-{type}s-{plugin}-ssl_certificate_path"]
+===== `ssl_certificate_path` 
+
+  * Value type is <<path,path>>
+  * There is no default value for this setting.
+
+Path to an SSL certificate in PKCS12 (.p12) format used for verifying the remote host
+
+[id="plugins-{type}s-{plugin}-ssl_version"]
+===== `ssl_version` 
+
+  * Value type is <<string,string>>
+  * Default value is `"TLSv1.2"`
+
+Version of the SSL protocol to use.
+
+[id="plugins-{type}s-{plugin}-subscription_retry_interval_seconds"]
+===== `subscription_retry_interval_seconds` 
+
+  * This is a required setting.
+  * Value type is <<number,number>>
+  * Default value is `5`
+
+Amount of time in seconds to wait after a failed subscription request
+before retrying. Subscribes can fail if the server goes away and then comes back.
+
+[id="plugins-{type}s-{plugin}-threads"]
+===== `threads` 
+
+  * Value type is <<number,number>>
+  * Default value is `1`
+
+[id="plugins-{type}s-{plugin}-user"]
+===== `user` 
+
+  * Value type is <<string,string>>
+  * Default value is `"guest"`
+
+RabbitMQ username
+
+[id="plugins-{type}s-{plugin}-vhost"]
+===== `vhost` 
+
+  * Value type is <<string,string>>
+  * Default value is `"/"`
+
+The vhost (virtual host) to use. If you don't know what this
+is, leave the default. With the exception of the default
+vhost ("/"), names of vhosts should not begin with a forward
+slash.
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]