logstash-output-riemann 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c518d3098303bac1ee689a2fe9d322272c96b3f3
-  data.tar.gz: c60899ddb3ea2407a79f0289545916da53756931
+  metadata.gz: 6154411956f838c893cd10992536b8d0fd433dd8
+  data.tar.gz: 47aa11dd7d2f27f83c11812d79c67a4c3fe20047
 SHA512:
-  metadata.gz: ae01921ce8ccbce004a20c2d3fc18604c339df30dea37c916e3f63fbc2af8438f242459f7ca820258e3dc5add7b5c4a93c06247590a68548b650410c805e9caf
-  data.tar.gz: 9980b44fccd350a3ad2e6db9d1fac7151e39fcf2cf48327ecec2eb26337774e881cec1ebf3ae5304c84ddfb0ca7b91cf73f0f03d101f794dfd68574eb67ec91c
+  metadata.gz: 9cd70e3fd6e3c70dcafd2ee726e8782b266e93fb9b6ba694e69ef279c4f83b8a49459e79756a2cf512082b2a27487b87c6041240d884d2e4d5808b78629a8eb6
+  data.tar.gz: b868d396f3d83aaa5fc7697aefce275ad3f7c2d6a30f66814df4f48b138422a609f96a7ada5fd80030e5151ac41a9dbf1d510e037369f25e3f7e5ceb1670ecca

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/docs/index.asciidoc

@@ -0,0 +1,178 @@
+:plugin: riemann
+:type: output
+
+///////////////////////////////////////////
+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}"]
+
+=== Riemann output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+Riemann is a network event stream processing system.
+
+While Riemann is very similar conceptually to Logstash, it has
+much more in terms of being a monitoring system replacement.
+
+Riemann is used in Logstash much like statsd or other metric-related
+outputs
+
+You can learn about Riemann here:
+
+* http://riemann.io/
+You can see the author talk about it here:
+* http://vimeo.com/38377415
+
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Riemann Output 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}-debug>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-map_fields>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-protocol>> |<<string,string>>, one of `["tcp", "udp"]`|No
+| <<plugins-{type}s-{plugin}-riemann_event>> |<<hash,hash>>|No
+| <<plugins-{type}s-{plugin}-sender>> |<<string,string>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+output plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-debug"]
+===== `debug` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+
+Enable debugging output?
+
+[id="plugins-{type}s-{plugin}-host"]
+===== `host` 
+
+  * Value type is <<string,string>>
+  * Default value is `"localhost"`
+
+The address of the Riemann server.
+
+[id="plugins-{type}s-{plugin}-map_fields"]
+===== `map_fields` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+If set to true automatically map all logstash defined fields to riemann event fields.
+All nested logstash fields will be mapped to riemann fields containing all parent keys
+separated by dots and the deepest value.
+
+As an example, the logstash event:
+[source,ruby]
+   {
+     "@timestamp":"2013-12-10T14:36:26.151+0000",
+     "@version": 1,
+     "message":"log message",
+     "host": "host.domain.com",
+     "nested_field": {
+                       "key": "value"
+                     }
+   }
+Is mapped to this riemann event:
+[source,ruby]
+  {
+    :time 1386686186,
+    :host host.domain.com,
+    :message log message,
+    :nested_field.key value
+  }
+
+It can be used in conjunction with or independent of the riemann_event option.
+When used with the riemann_event any duplicate keys receive their value from
+riemann_event instead of the logstash event itself.
+
+[id="plugins-{type}s-{plugin}-port"]
+===== `port` 
+
+  * Value type is <<number,number>>
+  * Default value is `5555`
+
+The port to connect to on your Riemann server.
+
+[id="plugins-{type}s-{plugin}-protocol"]
+===== `protocol` 
+
+  * Value can be any of: `tcp`, `udp`
+  * Default value is `"tcp"`
+
+The protocol to use
+UDP is non-blocking
+TCP is blocking
+
+Logstash's default output behaviour
+is to never lose events
+As such, we use tcp as default here
+
+[id="plugins-{type}s-{plugin}-riemann_event"]
+===== `riemann_event` 
+
+  * Value type is <<hash,hash>>
+  * There is no default value for this setting.
+
+A Hash to set Riemann event fields
+(http://riemann.io/concepts.html).
+
+The following event fields are supported:
+`description`, `state`, `metric`, `ttl`, `service`
+
+Tags found on the Logstash event will automatically be added to the
+Riemann event.
+
+Any other field set here will be passed to Riemann as an event attribute.
+
+Example:
+[source,ruby]
+    riemann {
+        riemann_event => {
+            "metric"  => "%{metric}"
+            "service" => "%{service}"
+        }
+    }
+
+`metric` and `ttl` values will be coerced to a floating point value.
+Values which cannot be coerced will zero (0.0).
+
+`description`, by default, will be set to the event message
+but can be overridden here.
+
+[id="plugins-{type}s-{plugin}-sender"]
+===== `sender` 
+
+  * Value type is <<string,string>>
+  * Default value is `"%{host}"`
+
+The name of the sender.
+This sets the `host` value
+in the Riemann event
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-output-riemann.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-riemann'
-  s.version         = '3.0.0'
+  s.version         = '3.0.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Riemann is a network event stream processing system."
   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"
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   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-output-riemann
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-11-11 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -84,6 +84,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/outputs/riemann.rb
 - logstash-output-riemann.gemspec
 - spec/outputs/riemann_spec.rb