logstash-input-zenoss 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf474bfd20462add5113dce898f9a919c61fc79d
-  data.tar.gz: f2a5aeed8f8d543607ef8305f518dc043e300575
+  metadata.gz: b65c0933671c4815a411ac46bc9f4a239602e7f4
+  data.tar.gz: 0337f690679f518eb42583062b34e2d5d3510839
 SHA512:
-  metadata.gz: 2db7412d04706086fd8b708bec51bebaeb057987cfc2bd72fe9ffa6ae5f8dfb40f6078c55ae60ca0c1bf0a92da93ff966306416a228b712882ddb64bc789aae3
-  data.tar.gz: 83075d3fe525cb3bde869c63a60a762dfbc174c70517bedb4754b9e657fdff9be815b2c6b54b566d3873ad32c71a75304cb6f8bdb5bfb03605658d4950fce80c
+  metadata.gz: e3fc10509beedfc0bd7dfb8284e28b32eff3c230a83f9891bc46e9fc9f36eca1c0a2b4543805c283b0a1df0ae71237d1f860cddeaf1503a5b905aad57c67c585
+  data.tar.gz: 789ed28a378178197c66457688e040d58ee6d06c0f7b0398eb774d0ff06c6998eb7ea3783d0f32926aca1a4c5596d91f65a6022f833c37845328fd93d25be26d

data/Gemfile

@@ -1,2 +1,11 @@
 source 'https://rubygems.org'
-gemspec
+
+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

@@ -1,4 +1,4 @@
-Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+Copyright (c) 2012–2016 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.

data/README.md

@@ -1,7 +1,6 @@
 # Logstash Plugin
 
-[![Build
-Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Inputs/job/logstash-plugin-input-zenoss-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Inputs/job/logstash-plugin-input-zenoss-unit/)
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-input-zenoss.svg)](https://travis-ci.org/logstash-plugins/logstash-input-zenoss)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
@@ -56,7 +55,12 @@ 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
@@ -74,7 +78,12 @@ gem build logstash-filter-awesome.gemspec
 ```
 - Install the plugin from the Logstash home
 ```sh
-bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+# 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
 

data/docs/index.asciidoc

@@ -0,0 +1,398 @@
+:plugin: zenoss
+: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}-{plugin}"]
+
+=== Zenoss input plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+Read Zenoss events from the zenoss.zenevents fanout exchange.
+
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Zenoss 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>>|No
+| <<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>>
+  * Default value is `"zenoss.zenevents"`
+
+The name of the exchange to bind the queue. This is analogous to the 'rabbitmq
+output' [config 'name'](../outputs/rabbitmq)
+
+[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` 
+
+  * Value type is <<string,string>>
+  * Default value is `"localhost"`
+
+Your rabbitmq server address
+
+[id="plugins-{type}s-{plugin}-key"]
+===== `key` 
+
+  * Value type is <<string,string>>
+  * Default value is `"zenoss.zenevent.#"`
+
+The routing key to use. This is only valid for direct or fanout exchanges
+
+* Routing keys are ignored on topic 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`
+
+Passive queue creation? Useful for checking queue existance without modifying server state
+
+[id="plugins-{type}s-{plugin}-password"]
+===== `password` 
+
+  * Value type is <<password,password>>
+  * Default value is `"zenoss"`
+
+Your 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 `""`
+
+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.
+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}-tls_certificate_password"]
+===== `tls_certificate_password`  (DEPRECATED)
+
+  * DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+TLS certificate password
+
+[id="plugins-{type}s-{plugin}-tls_certificate_path"]
+===== `tls_certificate_path`  (DEPRECATED)
+
+  * DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
+  * Value type is <<path,path>>
+  * There is no default value for this setting.
+
+TLS certifcate path
+
+[id="plugins-{type}s-{plugin}-user"]
+===== `user` 
+
+  * Value type is <<string,string>>
+  * Default value is `"zenoss"`
+
+Your rabbitmq username
+
+[id="plugins-{type}s-{plugin}-vhost"]
+===== `vhost` 
+
+  * Value type is <<string,string>>
+  * Default value is `"/zenoss"`
+
+The vhost to use. If you don't know what this is, leave the default.
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-input-zenoss.gemspec

@@ -1,17 +1,17 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-zenoss'
-  s.version         = '2.0.4'
+  s.version         = '2.0.5'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Read Zenoss events from the zenoss.zenevents fanout exchange."
-  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.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
   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 = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-zenoss
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +94,7 @@ dependencies:
     - - ">="
       - !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 required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program
 email: info@elastic.co
 executables: []
 extensions: []
@@ -106,6 +106,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/inputs/zenoss.rb
 - lib/logstash/util/zenoss.rb
 - logstash-input-zenoss.gemspec