logstash-output-riak 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88599a0c5d393211a0bb10bb29d82c4d4630ed1b
-  data.tar.gz: 0382ee33bc5061a5971444dc65d5056e525902cb
+  metadata.gz: b7577aa431989655df89822ae479b0040acce2cb
+  data.tar.gz: 7653445add8f53fef9b5004f1909315c6a9df354
 SHA512:
-  metadata.gz: 86b1da457e477c38b822e1121430aaa96ee4f95312edeca289ad8fa30d36d3158700bf9cfefe1ef36e1deea8705b874be184ccd59b60d076d56b6621cda130fc
-  data.tar.gz: a5974e87233dc0b340695345bbbeae083ad8df9d179aa0725a045aed5744895fe4e60354d6ebb7963b01674f34175e79cb5d6e60a7d656e3b12ecfa39fe598d5
+  metadata.gz: ece3d61209ae4798bce0fb8f1eb7f0c7f4f6d9d87ff2469099337d4429871f7a7b1c95c61aaeb283688f2b2039d3957b4d48f39baca9e075ed28c2b4bce73532
+  data.tar.gz: 485ca13a0a2c5af81099c74e8dfe8ffb1fa1caf50f7a736187da3ee6486fee33febf476804c39e0707439b6ed212b41b43d3b9aabdb2ad60c2d703922300b03e

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,177 @@
+:plugin: riak
+: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}"]
+
+=== Riak output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+Riak is a distributed k/v store from Basho.
+It's based on the Dynamo model.
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Riak 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}-bucket>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-bucket_props>> |<<hash,hash>>|No
+| <<plugins-{type}s-{plugin}-enable_search>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-enable_ssl>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-indices>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-key_name>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-nodes>> |<<hash,hash>>|No
+| <<plugins-{type}s-{plugin}-proto>> |<<string,string>>, one of `["http", "pb"]`|No
+| <<plugins-{type}s-{plugin}-ssl_opts>> |<<hash,hash>>|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}-bucket"]
+===== `bucket` 
+
+  * Value type is <<array,array>>
+  * Default value is `["logstash-%{+YYYY.MM.dd}"]`
+
+The bucket name to write events to
+Expansion is supported here as values are 
+passed through event.sprintf
+Multiple buckets can be specified here
+but any bucket-specific settings defined
+apply to ALL the buckets.
+
+[id="plugins-{type}s-{plugin}-bucket_props"]
+===== `bucket_props` 
+
+  * Value type is <<hash,hash>>
+  * There is no default value for this setting.
+
+Bucket properties (NYI)
+Logstash hash of properties for the bucket
+i.e.
+[source,ruby]
+    bucket_props => {
+        "r" => "one"
+        "w" => "one"
+        "dw", "one
+     }
+or
+[source,ruby]
+    bucket_props => { "n_val" => "3" }
+Properties will be passed as-is
+
+[id="plugins-{type}s-{plugin}-enable_search"]
+===== `enable_search` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Search
+Enable search on the bucket defined above
+
+[id="plugins-{type}s-{plugin}-enable_ssl"]
+===== `enable_ssl` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+SSL
+Enable SSL
+
+[id="plugins-{type}s-{plugin}-indices"]
+===== `indices` 
+
+  * Value type is <<array,array>>
+  * There is no default value for this setting.
+
+Indices
+Array of fields to add 2i on
+e.g.
+[source,ruby]
+    `indices => ["source_host", "type"]
+Off by default as not everyone runs eleveldb
+
+[id="plugins-{type}s-{plugin}-key_name"]
+===== `key_name` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The event key name
+variables are valid here.
+
+Choose this carefully. Best to let riak decide.
+
+[id="plugins-{type}s-{plugin}-nodes"]
+===== `nodes` 
+
+  * Value type is <<hash,hash>>
+  * Default value is `{"localhost"=>"8098"}`
+
+The nodes of your Riak cluster
+This can be a single host or
+a Logstash hash of node/port pairs
+e.g
+[source,ruby]
+    {
+        "node1" => "8098"
+        "node2" => "8098"
+    }
+
+[id="plugins-{type}s-{plugin}-proto"]
+===== `proto` 
+
+  * Value can be any of: `http`, `pb`
+  * Default value is `"http"`
+
+The protocol to use
+HTTP or ProtoBuf
+Applies to ALL backends listed above
+No mix and match
+
+[id="plugins-{type}s-{plugin}-ssl_opts"]
+===== `ssl_opts` 
+
+  * Value type is <<hash,hash>>
+  * There is no default value for this setting.
+
+SSL Options
+Options for SSL connections
+Only applied if SSL is enabled
+Logstash hash that maps to the riak-client options
+here: https://github.com/basho/riak-ruby-client/wiki/Connecting-to-Riak
+You'll likely want something like this:
+
+[source, ruby]
+    ssl_opts => {
+       "pem" => "/etc/riak.pem"
+       "ca_path" => "/usr/share/certificates"
+    }
+
+Per the riak client docs, the above sample options
+will turn on SSL `VERIFY_PEER`
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-output-riak.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-riak'
-  s.version         = '3.0.0'
+  s.version         = '3.0.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Send events to Riak"
   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-riak
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-10 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -70,6 +70,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/outputs/riak.rb
 - logstash-output-riak.gemspec
 - spec/outputs/riak_spec.rb